PPM Concentration Sensors
Reporting Endpoint Status
The MQTT integration of PPM concentration sensors uses the following structure:
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"concentration": 15.3,
"timestamp": "2021-02-23T14:55:03",
"mqttMethod": "UpdateConcentrationSensorStatus",
"mqttRID": "tkrs34"
}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 |
| concentration | The concentration in parts per million (ppm). Use a period as the decimal separator. | 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 |
| mqttMethod | Service method to call, in this case UpdateConcentrationSensorStatus. | string |
| mqttRID | Optional request identifier, used to get a confirmation response. | string |
Reporting Status in "raw" Format
The concentration 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.
Here is an example of a request in raw format:
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"rawData": "15.3",
"timestamp": "2021-02-23T14:55:03",
"mqttMethod": "UpdateConcentrationSensorStatusRaw",
"mqttRID": "RXmp123"
}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 concentration, in parts per million (ppm). | 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 |
| mqttMethod | Service method to call, in this case UpdateConcentrationSensorStatusRaw. | string |
| mqttRID | Optional request identifier, used to get a confirmation response. | string |
Last updated on