DT Developer Docs
REST API ReferenceDT StudioStatus Page
Search…
Getting Started
Overview
Concepts
Devices
Events
Topics
Data Connectors
Introduction to Data Connectors
Creating a Data Connector
Advanced Configurations
Receiving Events
Example Integrations
Development Guides
REST API
Introduction to REST API
Explore Our Endpoints
Authentication
Error Codes
Emulator API
Examples
Reference
Status Page
Service Accounts
Introduction to Service Accounts
Creating a Service Account
Managing Access Rights
Permissions
Organizational Structures
Other
Application Notes
Frequently Asked Question
Powered By GitBook
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​
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.
​Counting Proximity​
proximityCounter
Sensor that reports total count of proximity events.
​Counting Touch​
touchCounter
Sensor that reports total count of touch events.
​Water Detector​
waterDetector
Sensor that reports the whether or not water is present.
​Cloud Connector​
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.
1
{
2
"name": "projects/<PROJECT_ID>/device/<DEVICE_ID>",
3
"type": "<DEVICE_TYPE>",
4
"productNumber": "<PRODUCT_NUMBER>",
5
"labels": {
6
"<KEY>": "<VALUE>",
7
...
8
},
9
"reported": {
10
...
11
}
12
}
Copied!
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​
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 Details

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.
Previous
Overview
Next - Concepts
Events
Last modified 21d ago
Copy link
Contents
Device Types
Structure
Wireless Sensors Details
Temperature Sensor
Proximity Sensor
Touch Sensor
Humidity Sensor
Counting Proximity Sensor
Counting Touch Sensor
Water Detector Sensor
Cloud Connector Details