DT Developer Docs
REST API ReferenceDT StudioStatus Page
Search…
⌃K
Links

Devices

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

Device Types

The following table provides an overview of all the device types that can be found throughout our API.
Device Name
Device Type
Description
temperature
Sensor that reports temperature in Celsius.
​Proximity​
proximity
Sensor that reports objects in close proximity.
​Touch​
touch
Sensor that reports when the sensor is touched.
​Humidity​
humidity
Sensor that reports temperature in Celsius and relative humidity as a percentage.
proximityCounter
Sensor that reports total count of proximity events.
touchCounter
Sensor that reports total count of touch events.
waterDetector
Sensor that reports the whether or not water is present.
​CO2​
co2
Sensor that reports CO2, Barometric Pressure, Temperature, and Relative Humidity.
​Motion​
motion
Sensor that reports when motion is detected and when it's no longer detected.
deskOccupancy
Sensor that reports when a desk is occupied and when it's no longer occupied.
ccon
Connects sensors securely to the cloud.

Structure

A device is either a sensor or a 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 device(s) with the structure 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 Details

The following provides details of all the types of wireless sensors found throughout our APIs. Each type may contain one- or several different product numbers.

Temperature Sensor

Reports temperature in Celsius.
The following event types are available for this device type.
Event Name
Event Type
Trigger
temperature
Every periodic heartbeat or when touched. Note: 2nd Gen Temperature Sensors will only send temperature on heartbeats, and not when touched.
​Touch​
touch
When touched.
networkStatus
Every periodic heartbeat.
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
objectPresent
When an object appears or disappears in close proximity.
​Touch​
touch
When touched.
networkStatus
Every periodic heartbeat.
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.
networkStatus
Every periodic heartbeat.
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.
networkStatus
Every periodic heartbeat.
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
objectPresentCount
Every periodic heartbeat.
​Touch​
touch
When touched.
networkStatus
Every periodic heartbeat.
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
touchCount
Every periodic heartbeat.
​Touch​
touch
When touched.
networkStatus
Every periodic heartbeat.
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
waterPresent
When water appears or disappears.
​Touch​
touch
When touched.
networkStatus
Every periodic heartbeat.
batteryStatus
Approximately once per day.

CO2 Sensor

Reports CO2, Barometric Pressure, Relative Humidity, and Temperature.
The following event types are available for this device type.
Event Name
Event Type
Trigger
​CO2​
co2
​Pressure​
pressure
​Humidity​
humidity
networkStatus
batteryStatus
Approximately once per day.

Motion Sensor

Reports motion in the sensor's field of view.
The following event types are available for this device type.
Event Name
Event Type
Trigger
​Motion​
motion
The presence of people in the PIR sensor field of view.
networkStatus
batteryStatus
Approximately once per day.

Desk Occupancy Sensor

Reports when a desk is occupied and when it's no longer occupied.
The following event types are available for this device type.
Event Name
Event Type
Trigger
deskOccupancy
Whether or not a desk is occupied.
​Touch​
touch
When touched.
networkStatus
batteryStatus
Approximately once per day.
​

Cloud Connector Details

Securely relays device events to our DT Cloud.
The following event types are available for this device type.
Event Name
Event Type
Trigger
connectionStatus
When the connection changes.
ethernetStatus
When the ethernet connection changes.
cellularStatus
When the cellular connection changes.
​Touch​
touch
When touched.
Previous
Overview
Next - Concepts
Events
Last modified 4mo ago