Energy Consumption Sensors
Reporting Accumulated Energy in Wh and VARh
The MQTT integration of energy sensors uses the following structure:
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"activeEnergySummationWh": 112685.9,
"reactiveEnergySummationVARh": 18973.4,
"timestamp": "2021-02-23T14:55:03",
"mqttMethod": "UpdateEnergySensorValueSummation",
"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 |
| activeEnergySummationWh | Accumulated active energy reported by the sensor, in watt-hours (Wh). | numeric |
| reactiveEnergySummationVARh | Accumulated reactive energy reported by the sensor, in volt-ampere reactive hours (VARh). | 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 UpdateEnergySensorValueSummation. | string |
| mqttRID | Optional request identifier, used to get a confirmation response. | string |
Reporting Accumulated Energy in "raw" Format
The accumulated energy 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": "112685.9/18973.4",
"timestamp": "2021-02-23T14:55:03",
"mqttMethod": "UpdateEnergySensorValueSummationRaw",
"mqttRID": "tkrs34"
}As this example shows, the RawData field combines the accumulated active energy and the accumulated reactive energy in a single string, with both values separated by a comma.
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. Two expressions must be specified in the expression converter. The first gets the accumulated active energy from the rawData variable and must return a numeric value in watt-hours (Wh); for the example above: ToNumber(StringPart(rawData, 1, ',')). The second gets the accumulated reactive energy and must return a numeric value in volt-ampere reactive hours (VARh); for the example above: ToNumber(StringPart(rawData, 2, ',')). | 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 UpdateEnergySensorValueSummationRaw. | string |
| mqttRID | Optional request identifier, used to get a confirmation response. | string |
Last updated on