Configuração do ClienteDispositivos e EndpointsDispositivosIntegração de DispositivosHTTPAPI HTTPArmazenamento de Dados de Sensores
Air Quality Index (AQI) Sensors
Reporting Endpoint Status
The HTTP integration of air quality (AQI) sensors uses the following structure:
POST /services/gear/DeviceIntegrationService.svc/UpdateAirQualitySensorStatus HTTP/1.1
Host: gear.cloud.studio
Content-Type: application/json
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"index": 15,
"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. | numeric |
| index | The air quality index, between 0 and 500. 0-50: good; 51-100: moderate; 101-150: unhealthy for sensitive groups; 151-200: unhealthy; 201-300: very unhealthy; 301-500: hazardous. | 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 endpoint 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/UpdateAirQualitySensorStatusRaw HTTP/1.1
Host: gear.cloud.studio
Content-Type: application/json
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"rawData": "15",
"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 with the air quality (between 0 and 500) as an AQI value. 0-50: good; 51-100: moderate; 101-150: unhealthy for sensitive groups; 151-200: unhealthy; 201-300: very unhealthy; 301-500: hazardous. | 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
Mass/Volume Concentration Sensors
How to send readings from a mass/volume concentration sensor to Gear Studio through the HTTP API: request structure, parameters and an example.
People Flow Sensors
How to send entry and exit counts from a people flow sensor to Gear Studio through the HTTP API: request structure, parameters and an example.