hello- message type.
version- API version, always
apiKey- API key (required).
deviceId- unique identifier for this device. Set this when the device has a globally unique identifier (e.g. MAC address). Only a single device with this ID can connect at any given point (required).
deviceType- device type, for example the exact model of the device. Should be the same for all similar devices (required).
connection- how the device is connected, either
ip(direct connection) or
daemon(via the serial daemon) (required).
sensors- list of sensors that the device supports. The object has three properties: 1)
name, human readable name, 2)
maxSampleLengthS, which defines the maximum time a device can sample from this sensor (as flash may run out), 3) list of frequencies the sensor supports. Users can only select a single sensor to sample from, so for sensor fusion create synthesized sensors that combine multiple physical sensors (e.g. 'Accelerometer + gyro' in this list). For cameras, set the name of the sensor to
Camera (WIDTHxHEIGHT), and the frequencies to an empty array (multiple allowed for multiple resolutions). (required).
supportsSnapshotStreaming- set to
trueif the device supports snapshot streaming (required).
hellofield is set to
false, and the
errmessage is set to a string.
sample- message type.
label- Label for this data. Use this to populate the
x-file-nameheader when posting data to the ingestion service.
length- Sampling length in milliseconds.
path- Path of the URL where to post the data.
hmacKey- Key to sign the data with, the device does not have to adhere to this request.
interval- Interval between samples. This can also be a float. Devices do not have to adhere to this field, e.g. if the sensor does not support this frequency, or if the value is non-sensical.
sensor- Name of the sensor to sample from. This field is only populated if the
sensorsfield in the hello request was populated.
sampleReadingand commands for snapshot streaming. For v2 devices the progress percentage is ignored, and
supportsSnapshotStreamingis set to