Dimmers
Reporting Endpoint Status
The MQTT integration of dimmers and similar devices (speed controllers, etc.) uses the following structure:
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"isOn": true,
"dimValue"; 75,
"timestamp": "2021-02-23T14:55:03",
"mqttMethod": "UpdateDimmerStatus",
"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 |
| isOn | Whether the appliance is on (true) or off (false). | bool |
| dimValue | The dim level, as a percentage between 1 and 100. | 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 | Corresponding method of the service, in this case UpdateDimmerStatus | string |
| mqttRID | Optional identifier for the request, in case you want to get a confirmation response. | string |
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.
Here is an example of a request in raw format:
{
"accessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"endpointID": 1,
"rawData": "true/75",
"timestamp": "2021-02-23T14:55:03",
"mqttMethod": "UpdateDimmerStatusRaw",
"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, 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 must return a boolean indicating whether the device is on (true) or off (false). The second must return a numeric value with its dim level, as a percentage between 1 and 100. | 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 | Corresponding method of the service, in this case UpdateDimmerStatusRaw | string |
| mqttRID | Optional identifier for the request, in case you want to get a confirmation response. | string |
Last updated on