Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Delete a device. When this device sends a new message to ingestion or connects to remote management the device will be recreated.
Project ID
Device ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Start an inference debug stream for this device with inference results (and images if a camera is attached). Updates are streamed through the websocket API. A keep-alive token is returned, you'll need to ping the API (with keepDeviceDebugStreamAlive) every 10 seconds (so we know when the client is disconnected).
Project ID
Device ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Retrieve impulse records from the device.
Project ID
Device ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
If you have opened a debug stream, ping this interface every 10 seconds to let us know to keep the debug stream open.
Project ID
Device ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Start a snapshot debug stream for this device with a current camera view. Updates are streamed through the websocket API. A keep-alive token is returned, you'll need to ping the API (with keepDeviceDebugStreamAlive) every 10 seconds (so we know when the client is disconnected).
Project ID
Device ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Start sampling on a device. This function returns immediately. Updates are streamed through the websocket API.
Project ID
Device ID
Label to be used during sampling.
Requested length of the sample (in ms).
Which acquisition category to sample data into.
Interval between samples (can be calculated like 1/hz * 1000
)
The sensor to sample from.
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Trigger a model update request, this only works for devices connected to remote management server in inference mode.
Project ID
Device ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Set the current name for a device.
Project ID
Device ID
New name for this device
"Jan's development board"
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
If you have opened a debug stream, close it.
Project ID
Device ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Create a new device. If you set ifNotExists
to false
and the device already exists, the deviceType
will be overwritten.
Project ID
Globally unique device identifier (e.g. MAC address)
"ac:87:a3:0a:2d:1b"
Device type, for example the exact model of the device. Should be the same for all similar devices
"DISCO_L475VG_IOT01A"
Whether to throw an error when this device already exists.
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
List all devices for this project. Devices get included here if they connect to the remote management API or if they have sent data to the ingestion API and had the device_id
field set.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
1
Unique identifier (such as MAC address) for a device
"38:f9:d3:d7:62:03"
"2019-07-21T17:32:28Z"
Last message that was received from the device (ignoring keep-alive)
"2019-08-31T17:32:28Z"
"m6d.1 desk sensor"
"DISCO-L475VG"
"Built-in accelerometer"
Maximum supported sample length in seconds
Supported frequencies for this sensor in Hz.
Whether the device is connected to the remote management interface. This property is deprecated, use remoteMgmtMode
instead.
The remote management host that the device is connected to
Replaces remote_mgmt_connected
. Shows whether the device is connected to the remote management interface, and in which mode.
If remoteMgmtMode
is set to inference
this object shows information about the model that's ran on device.
Retrieves a single device
Project ID
Device ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
1
Unique identifier (such as MAC address) for a device
"38:f9:d3:d7:62:03"
"2019-07-21T17:32:28Z"
Last message that was received from the device (ignoring keep-alive)
"2019-08-31T17:32:28Z"
"m6d.1 desk sensor"
"DISCO-L475VG"
"Built-in accelerometer"
Maximum supported sample length in seconds
Supported frequencies for this sensor in Hz.
Whether the device is connected to the remote management interface. This property is deprecated, use remoteMgmtMode
instead.
The remote management host that the device is connected to
Replaces remote_mgmt_connected
. Shows whether the device is connected to the remote management interface, and in which mode.
If remoteMgmtMode
is set to inference
this object shows information about the model that's ran on device.