Volume Sensors
Reporting Volume in Liters
The MQTT integration of volume sensors uses the following structure:
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"volumeLiters": 45,
"timestamp": "2021-02-23T14:55:03",
"mqttMethod": "UpdateVolumeSensorStatus",
"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 |
| volumeLiters | Volume expressed in liters. | 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 UpdateVolumeSensorStatus. | string |
| mqttRID | Optional request identifier, used to get a confirmation response. | string |
Reporting Volume in "raw" Format
The volume 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": "25",
"timestamp": "2021-02-23T14:55:03",
"mqttMethod": "UpdateVolumeSensorStatusRaw",
"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 measured volume, in liters. | 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 UpdateVolumeSensorStatusRaw. | string |
| mqttRID | Optional request identifier, used to get a confirmation response. | string |
Last updated on