Standardize / document

[Amir-Rasteg]

Connection Details

For the godot games integration plugin, we need the following information from NRS

• The full URL (including port and SSL status) for FEAGI API
• The full URL (including port and SSL status) for the connector websocket

We can grab this right now for NRS from the magic link

However, if we wish to pass this information in the URL bar, we need this information passed in full guaranteed all together as either 2 full domain links or in separate pieces (but all pieces of SSL, domain, port but all guaranteed, since optional parsing for each quickly becomes confusing).

Note I am looking at what we have and am electing instead to not use URL parameters at all for finding the connection details, since the magic link is much more convenient and portable

FEAGI Index overrides

The capabilities json may need to have the feagi index overwritten for some devices. This information is passed via URL parameter in NRS using the parameter name "capabilities", using the following string format

(input/output).(device_type).(ID).(feagi_index)=(new_value) example (URL encoded) for camera device input%2Ecamera%2E0%2Efeagi_index%3D0

multiple values may be sent by having multiple strings added together separated by "|"

[Amir-Rasteg]

Further documentation:

We also need to write down what is the form of the data to / from each motor / sensor in transit