Lists devices

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.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/devices

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

devices*array of Device (object)

id*integer

Example: 1

deviceId*string

Unique identifier (such as MAC address) for a device

Example: "38:f9:d3:d7:62:03"

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

lastSeen*string (date-time)

Last message that was received from the device (ignoring keep-alive)

Example: "2019-08-31T17:32:28Z"

name*string

Example: "m6d.1 desk sensor"

deviceType*string

Example: "DISCO-L475VG"

sensors*array of object

name*string

Example: "Built-in accelerometer"

maxSampleLengthS*integer

Maximum supported sample length in seconds

frequencies*array of number

Supported frequencies for this sensor in Hz.

itemsnumber

remote_mgmt_connected*boolean

Whether the device is connected to the remote management interface. This property is deprecated, use remoteMgmtMode instead.

remote_mgmt_hoststring

The remote management host that the device is connected to

supportsSnapshotStreaming*boolean

remoteMgmtMode*enum

Replaces remote_mgmt_connected. Shows whether the device is connected to the remote management interface, and in which mode.

disconnectedingestioninference

inferenceInfoobject

If remoteMgmtMode is set to inference this object shows information about the model that's ran on device.

projectId*integer

projectOwner*string

projectName*string

deployedVersion*integer

modelTypeenum

classificationobjectDetectionconstrainedObjectDetection

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/devices', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "devices": [
    {
      "id": 1,
      "deviceId": "38:f9:d3:d7:62:03",
      "created": "2019-07-21T17:32:28Z",
      "lastSeen": "2019-08-31T17:32:28Z",
      "name": "m6d.1 desk sensor",
      "deviceType": "DISCO-L475VG",
      "sensors": [
        {
          "name": "Built-in accelerometer",
          "frequencies": [
            62.5,
            100
          ]
        }
      ],
      "remote_mgmt_connected": false,
      "remote_mgmt_host": "text",
      "supportsSnapshotStreaming": false,
      "remoteMgmtMode": "disconnected",
      "inferenceInfo": {
        "projectOwner": "text",
        "projectName": "text",
        "modelType": "classification"
      }
    }
  ]
}

Lists devices

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.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/devices

Path parameters

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

devices*array of Device (object)

id*integer

Example: 1

deviceId*string

Unique identifier (such as MAC address) for a device

Example: "38:f9:d3:d7:62:03"

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

lastSeen*string (date-time)

Last message that was received from the device (ignoring keep-alive)

Example: "2019-08-31T17:32:28Z"

name*string

Example: "m6d.1 desk sensor"

deviceType*string

Example: "DISCO-L475VG"

sensors*array of object

name*string

Example: "Built-in accelerometer"

maxSampleLengthS*integer

Maximum supported sample length in seconds

frequencies*array of number

Supported frequencies for this sensor in Hz.

itemsnumber

remote_mgmt_connected*boolean

Whether the device is connected to the remote management interface. This property is deprecated, use remoteMgmtMode instead.

remote_mgmt_hoststring

The remote management host that the device is connected to

supportsSnapshotStreaming*boolean

remoteMgmtMode*enum

Replaces remote_mgmt_connected. Shows whether the device is connected to the remote management interface, and in which mode.

disconnectedingestioninference

inferenceInfoobject

If remoteMgmtMode is set to inference this object shows information about the model that's ran on device.

projectId*integer

projectOwner*string

projectName*string

deployedVersion*integer

modelTypeenum

classificationobjectDetectionconstrainedObjectDetection

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/devices', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "devices": [
    {
      "id": 1,
      "deviceId": "38:f9:d3:d7:62:03",
      "created": "2019-07-21T17:32:28Z",
      "lastSeen": "2019-08-31T17:32:28Z",
      "name": "m6d.1 desk sensor",
      "deviceType": "DISCO-L475VG",
      "sensors": [
        {
          "name": "Built-in accelerometer",
          "frequencies": [
            62.5,
            100
          ]
        }
      ],
      "remote_mgmt_connected": false,
      "remote_mgmt_host": "text",
      "supportsSnapshotStreaming": false,
      "remoteMgmtMode": "disconnected",
      "inferenceInfo": {
        "projectOwner": "text",
        "projectName": "text",
        "modelType": "classification"
      }
    }
  ]
}