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 the 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. | |
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 will only send temperature on heartbeats, and not when touched. | |
touch | When touched. | |
networkStatus | Every periodic heartbeat. | |
batteryStatus | Approximately once per day. |
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 | Every periodic heartbeat. | |
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 | Every periodic heartbeat. | |
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 | Every periodic heartbeat or when touched. | |
touch | When touched. | |
networkStatus | Every periodic heartbeat. | |
batteryStatus | Approximately once per day. |
Reports total count of proximity events.
- Device Type:
proximityCounter
- Variations:
The following event types are available for this device type.
Event Name | Event Type | Trigger |
objectPresentCount | Every periodic heartbeat. | |
touch | When touched. | |
networkStatus | Every periodic heartbeat. | |
batteryStatus | Approximately once per day. |
Reports total count of touch events.
- Device Type:
touchCounter
The following event types are available for this device type.
Event Name | Event Type | Trigger |
touchCount | Every periodic heartbeat. | |
touch | When touched. | |
networkStatus | Every periodic heartbeat. | |
batteryStatus | Approximately once per day. |
Reports the appearance or disappearance of water.
- Device Type:
waterDetector
- Variations:
The following event types are available for this device type.
Event Name | Event Type | Trigger |
waterPresent | When water appears or disappears. | |
touch | When touched. | |
networkStatus | Every periodic heartbeat. | |
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 PIR sensor 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 | Whether or not a desk is occupied. | |
touch | When touched. | |
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 8mo ago