Skip to main content

​
Required Parameters

To add an MQTT device, the following parameters are required.
​
id
string
required
A unique identifier for the device.Example: aculink_meter
​
type
string
required
Indicates the type of device. For this type of device, it is always other.Example: other
​
protocol
string
required
The communication protocol between the controller and the device. For this type of device, it will always be MQTT.Example: MQTT
​
addressMap
string
required
The name of the device’s address map on the controller.Example: aculink_meter_address_map
​
disabled
bool
required
Indicates whether the device is enabled or disabled. A value of true means the device is disabled, while false means the device is enabled.
​
topic
string
required
The MQTT topic of the device to which the controller will subscribe.Example: DCMG_meter

​
Optional Parameters

The following parameters can be added to MQTT devices; however, they are optional and not required. These parameters provide additional functionality to the device.
​
forward
dict
This parameter lists the registers to forward to another device.Example:
{
  "forward": {
    "register1": "device2.register1",
    "register2": "device2.register2"
  }
}

​
Example

The snippet below demonstrates two different MQTT devices, highlighting both the required and optional parameters. 
{
  "id": "aculink_meter",
  "type": "other",
  "protocol": "MQTT",
  "addressMap": "aculink_meter_address_map",
  "disabled": false,
  "topic": "DCMG_meter",
  "forward": {
    "measure.voltage": "battery1_precharge.control.voltage"
  }
}
⌘I