Configuração do ClienteDispositivos e EndpointsDispositivosIntegração de DispositivosHTTPAPI HTTPArmazenamento de Dados de Sensores
IAS Sensors (Motion, Occupancy, and Binary Sensors)
Reporting Sensor Status
The HTTP integration of IAS sensors uses the following structure:
POST /services/gear/DeviceIntegrationService.svc/UpdateIASSensorStatus HTTP/1.1
Host: gear.cloud.studio
Content-Type: application/json
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"state": 2,
"timestamp": "2021-02-23T14:55:03"
}Parameters
| Name | Description | Data Type |
|---|---|---|
| accessToken | Access token with permissions to update endpoint information. See this page for more information. | text |
| endpointID | Unique endpoint identifier or combination of device address and endpoint address in format [deviceAddress]:endpointAddress (e.g.: [device-1234]:1). These values can be found on the endpoint management page. | text |
| state | Indicates the sensor status. The possible states are as follows:0: Unknown. The sensor status is not known1: Inactive. The sensor detects no activity.2: Active. The sensor detects activity.3: Cleaning. The space associated with the sensor is being cleaned.4: Needs cleaning. The space associated with the sensor needs cleaning.5: Test mode. The sensor is currently in test mode.6: Tampered. The sensor has been tampered with and may not be working correctly.7: In maintenance. The sensor requires maintenance and may not be working correctly.8: The sensor detects a vehicle entering the parking space.9: The sensor detects a vehicle leaving the parking space.10: The sensor reports the parking space is in violation state. | numeric |
| timestamp | Optional value indicating the UTC date and time corresponding to the measurement. The date format must match one of those specified in the date formats section. If the field is omitted, the platform will assume the measurement corresponds to the current date and time. | text |
Reporting Status in "raw" Format
The sensor state can be reported as a raw value using the expression converter. This option is convenient when the device is unable to perform conversions and emits values that need to be transformed before being injected into the platform.
Below is an example of a raw format request:
POST /services/gear/DeviceIntegrationService.svc/UpdateIASSensorStatusRaw HTTP/1.1
Host: gear.cloud.studio
Content-Type: application/json
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"rawData": "2",
"timestamp": "2021-02-23T14:55:03"
}Parameters
| Name | Description | Data Type |
|---|---|---|
| accessToken | Access token with permissions to update endpoint information. See this page for more information. | text |
| endpointID | Unique endpoint identifier, which can be found on the endpoint management page. | numeric |
| rawData | Value reported by the sensor, as text. An expression must be specified in the expression converter. The expression must return a numeric value corresponding to the states in the table shown above. | text |
| timestamp | Optional value indicating the UTC date and time corresponding to the measurement. The date format must match one of those specified in the date formats section. If the field is omitted, the platform will assume the measurement corresponds to the current date and time. | text |
Última atualização em
Pressure Sensors
How to send readings in pascals from a pressure sensor to Gear Studio through the HTTP API: request structure, parameters and an example.
Voltage Sensors
How to send readings in volts from a voltage sensor to Gear Studio through the HTTP API: request structure, parameters and an example.