MQTT

Naming Conventions

While not mandatory, it is recommended to adopt the following naming conventions for clarity and usability:

• Read Operations: Prefix register names with measure. to indicate that the register is used for measurement purposes.

Required Parameters

name · string · required

A unique name for the register.

Example: measure.voltage

key · string · required

The key of the MQTT message.

Example: DCV_V

pathToReadings · string · required

The path to the readings in the MQTT message.

Example: readings

pathToKey · string · required

The path to the key in the MQTT message.

Example: param

pathToValue · string · required

The path to the value in the MQTT message.

Example: value

valueIncludesUnit · bool · required

Indicates whether the value includes the unit.

Example

mqtt_address_map.json

[
  {
    "name": "measure.voltage",
    "key": "DCV_V",
    "pathToReadings": "readings",
    "pathToKey": "param",
    "pathToValue": "value",
    "valueIncludesUnit": false
  }
]