Links
Comment on page

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 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.
Contact
contact
Sensor that reports whether a door/window is open or closed.
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 and 3rd Gen Temperature Sensor will only send temperature on heartbeats, and not when touched.
Touch
touch
When touched.
This event is not supported by the Temperature Probe Sensor.
networkStatus
batteryStatus
Approximately once per day.
probeWireStatus
When the wires are plugged in or unplugged from a Temperature Probe Sensor. This event is only supported by the Temperature Probe Sensor.

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
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
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
batteryStatus
Approximately once per day.

Counting Proximity Sensor

Reports the total number of proximity state changes on each heartbeat. The counter does not reset on heartbeats and will keep getting incremented. The presence of an object and the absence of an object are counted individually, and will both increment the counter with 1. A counting proximity sensor also reports normal touch events if touched and held for a few seconds. This allows the sensor to be identified through Touch to Identify.
The following event types are available for this device type.
Event Name
Event Type
Trigger
objectPresentCount
Touch
touch
When touched and held for a few seconds.
networkStatus
batteryStatus
Approximately once per day.

Counting Touch Sensor

Reports the total number of touches on each heartbeat. The counter does not reset on heartbeats and will keep getting incremented. A counting touch sensor also reports normal touch events if touched and held for a few seconds. This allows the sensor to be identified through Touch to Identify.
The following event types are available for this device type.
Event Name
Event Type
Trigger
touchCount
Touch
touch
When touched and held for a few seconds.
networkStatus
batteryStatus
Approximately once per day.

Water Detector Sensor

Reports when water is detected on the surface of the sensor, as well as when it's no longer detected.
The following event types are available for this device type.
Event Name
Event Type
Trigger
waterPresent
When water is detected and no longer detected on the surface of the sensor.
Touch
touch
When touched and held for a few seconds.
networkStatus
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 motion sensor's 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
When the occupancy status of the desk changes.
Touch
touch
When touched.
networkStatus
batteryStatus
Approximately once per day.

Contact Sensor

Reports whether a door/window is open or closed.
The following event types are available for this device type.
Event Name
Event Type
Trigger
Contact
contact
When a door or window is closed or opened.
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.
Last modified 16h ago