Devices

An overview of devices, where they can be found, and the various types.

Structure

A device is either a sensor or Cloud Connector and has a defined structure in our APIs. They can be fetched either by listing the devices in a project or looking up a single device, both of which will return information formatted as shown in the snippet below.

{
"name": "projects/<PROJECT_ID>/device/<DEVICE_ID>",
"type": "<DEVICE_TYPE>",
"productNumber": "<PRODUCT_NUMBER>",
"labels": {
"<KEY>": "<VALUE>",
...
},
"reported": {
...
}
}

Field

Type

Description

name

string

The device resource name. Includes both the identifier of the project the device is currently in and the identifier of the device itself.

type

string

The device type. See the overview below for a full list.

productNumber

string

The device product number. This is the same product number that can be found on the Sensors and Cloud Connectors support pages.

labels

struct

Device labels are user-configurable metadata key-value pairs. DT Studio uses labels with the keys name and description for the display name and description of the device, respectively.

reported

struct

Contains the last Event of each event type received for this device. Which events are included here depends on the device type. See the overview below to learn which event type is included with which device type.

Wireless Sensors

The following table lists the core device categories that can be found throughout our APIs. Each category may contain one- or several different product IDs.

Device Name

Device Type

Description

Temperature

temperature

Reports temperature in Celsius.

Proximity

proximity

Reports objects in close proximity.

Touch

touch

Reports when the sensor is touched.

Humidity

humidity

Reports temperature in Celsius and percentage humidity.

Counting Proximity

proximityCounter

Reports total count of proximity events.

Counting Touch

touchCounter

Reports total count of touch events.

Water Detector

waterDetector

Reports the appearance or disappearance of water.

Temperature Sensor

Reports temperature in Celsius.

The following event types are available for this device type.

Event Name

Event Type

Trigger

Temperature

temperature

Every periodic heartbeat or when touched.

Touch

touch

When touched.

Network Status

networkStatus

Every periodic heartbeat.

Battery Status

batteryStatus

Approximately once per day.

Proximity Sensor

Reports objects in close proximity.

The following event types are available for this device type.

Event Name

Event Type

Trigger

Object Present

objectPresent

When an object appears or disappears in close proximity.

Touch

touch

When touched.

Network Status

networkStatus

Every periodic heartbeat.

Battery Status

batteryStatus

Approximately once per day.

Touch Sensor

Reports when the sensor is touched.

The following event types are available for this device type.

Event Name

Event Type

Trigger

Touch

touch

When touched.

Network Status

networkStatus

Every periodic heartbeat.

Battery Status

batteryStatus

Approximately once per day.

Humidity Sensor

Reports temperature in Celsius and percentage humidity.

The following event types are available for this device type.

Event Name

Event Type

Trigger

Humidity

humidity

Every periodic heartbeat or when touched.

Touch

touch

When touched.

Network Status

networkStatus

Every periodic heartbeat.

Battery Status

batteryStatus

Approximately once per day.

Counting Proximity Sensor

Reports total count of proximity events.

The following event types are available for this device type.

Event Name

Event Type

Trigger

Object Present Count

objectPresentCount

Every periodic heartbeat.

Touch

touch

When touched.

Network Status

networkStatus

Every periodic heartbeat.

Battery Status

batteryStatus

Approximately once per day.

Counting Touch Sensor

Reports total count of touch events.

The following event types are available for this device type.

Event Name

Event Type

Trigger

Touch Count

touchCount

Every periodic heartbeat.

Touch

touch

When touched.

Network Status

networkStatus

Every periodic heartbeat.

Battery Status

batteryStatus

Approximately once per day.

Water Detector Sensor

Reports the appearance or disappearance of water.

The following event types are available for this device type.

Event Name

Event Type

Trigger

Water Present

waterPresent

When water appears or disappears.

Touch

touch

When touched.

Network Status

networkStatus

Every periodic heartbeat.

Battery Status

batteryStatus

Approximately once per day.

Cloud Connector

Securely relays device events to our DT Cloud.

The following event types are available for this device type.

Event Name

Event Type

Trigger

Connection Status

connectionStatus

When the connection changes.

Ethernet Status

ethernetStatus

When the ethernet connection changes.

Cellular Status

cellularStatus

When the cellular connection changes.

Touch

touch

When touched.