Comment on page
Devices
An overview of devices, where they can be found, and the various 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 | Sensor that reports objects in close proximity. | |
touch | Sensor that reports when the sensor is touched. | |
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 | Sensor that reports CO2, Barometric Pressure, Temperature, and Relative Humidity. | |
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 | Sensor that reports whether a door/window is open or closed. | |
ccon | Connects sensors securely to the cloud. |
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 | |
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 |
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.
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 | ||
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. |
Reports objects in close proximity.
- Device Type:
proximity
- Variations:
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 | When touched. | |
networkStatus | ||
batteryStatus | Approximately once per day. |
Reports when the sensor is touched.
- Device Type:
touch
- Variations:
The following event types are available for this device type.
Event Name | Event Type | Trigger |
touch | When touched. | |
networkStatus | ||
batteryStatus | Approximately once per day. |
Reports temperature in Celsius and percentage humidity.
- Device Type:
humidity
- Variations:
The following event types are available for this device type.
Event Name | Event Type | Trigger |
humidity | ||
touch | When touched. | |
networkStatus | ||
batteryStatus | Approximately once per day. |
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.
- Device Type:
proximityCounter
- Variations:
The following event types are available for this device type.
Event Name | Event Type | Trigger |
objectPresentCount | ||
touch | When touched and held for a few seconds. | |
networkStatus | ||
batteryStatus | Approximately once per day. |
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.
- Device Type:
touchCounter
- Variations:
The following event types are available for this device type.
Event Name | Event Type | Trigger |
touchCount | ||
touch | When touched and held for a few seconds. | |
networkStatus | ||
batteryStatus | Approximately once per day. |
Reports when water is detected on the surface of the sensor, as well as when it's no longer detected.
- Device Type:
waterDetector
- Variations:
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 | When touched and held for a few seconds. | |
networkStatus | ||
batteryStatus | Approximately once per day. |
Reports CO2, Barometric Pressure, Relative Humidity, and Temperature.
- Device Type:
co2
- Variations:
The following event types are available for this device type.
Event Name | Event Type | Trigger |
---|---|---|
co2 | ||
pressure | ||
humidity | ||
networkStatus | ||
batteryStatus | Approximately once per day. |
Reports motion in the sensor's field of view.
- Device Type:
motion
- Variations:
The following event types are available for this device type.
Event Name | Event Type | Trigger |
---|---|---|
motion | The presence of people in the motion sensor's field of view. | |
networkStatus | ||
batteryStatus | Approximately once per day. |
Reports when a desk is occupied and when it's no longer occupied.
- Device Type:
deskOccupancy
- Variations:
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 | When touched. | |
networkStatus | ||
batteryStatus | Approximately once per day. |
Reports whether a door/window is open or closed.
- Device Type:
contact
- Variations:
The following event types are available for this device type.
Event Name | Event Type | Trigger |
---|---|---|
contact | When a door or window is closed or opened. | |
networkStatus | ||
batteryStatus | Approximately once per day. |
Securely relays device events to our DT Cloud.
- Device Type:
ccon
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 | When touched. |
Last modified 16h ago