MQTT client field definitions

Description

The MQTT client is a LoggerV function that sends LoggerV data to an MQTT broker. Fields of the MQTT client page and the logger MQTT setting. Procedure: Set up the MQTT client. Topics: MQTT topics and payloads field definitions.

Logger Setting

On the Settings tab of the logger.

MQTT Enabled: Disable or Enable. The default is Disable.

Device Info

Broker connection: Connected or Disconnected.
LoggerV Pub count: messages sent to the broker since the LoggerV started.
Connection Uptime: time since the connection started, or Not connected.

Broker Status

Values that the broker sends on its $SYS/broker topics. A broker that does not send them leaves the fields empty.

Broker uptime: time since the broker started.
Totals card: bytes, messages and publish messages that the broker received and sent since it started.
Load [Last 1 Minute] card: bytes, messages and publish messages per minute, received and sent.

Settings Tab

Organisation Id: the LoggerV does not use this value.
Connect: opens Connection Settings.
Publish Settings: opens Message Settings.
Topics: opens Topic Settings.

Connection Settings

Basic tab:

Broker URI: the address of the broker, for example tcp://127.0.0.1:1883.
Username: the broker user name. Only for a broker with authentication.
Password: the broker password. Only for a broker with authentication. The page does not show the saved password. Leave the field empty to keep it.

Advanced tab:

Connection Timeout: seconds to wait for the broker. Default 5.
Max Reconnect Delay: the longest wait between two reconnect attempts, in milliseconds. The first wait is 1 second, and each failed attempt doubles it until it reaches this value. With the default 5, the LoggerV tries again every second.
Keep Alive Interval: seconds between two pings to the broker. Default 60.
MQTT Version: the MQTT protocol version, MQTT 3.1, MQTT 3.1.1 or DEFAULT.
Save: sends the settings and connects to the broker again.

Fixed Connection Values

Client ID: MQTT_ followed by the digits of the LoggerV serial number.
Clean session: on.
Automatic reconnect: on.
Retained messages: off. The LoggerV sends no retained data.

Message Settings

QOS: At most once (0), At least once (1) or Exactly once (2). Default At most once.
Publish Interval: seconds between two sends of all enabled topics. Default 3.
Save: sends the settings.

Topic Settings

Tabs: one tab for each topic group.
Switch: on sends the topic. The title is the topic description.
Text under the switch: the full topic.
[Deprecated]: an old topic name. The row shows dimmed.
Save: keeps the switch positions.
No available topics: no device has a topic yet.

Topic Groups

System Variables: all system variables.
Plant Control: the plant control data. Each plant has a raw topic and a by-type topic.
Storage Unit: one Solar MD BMS-Ex or BMU-H8 battery.
Storage Cluster: one battery cluster.
Device model name: the live data of a Deye SUN-SGLP1 inverter.
BMS EM, ES Control Service: the live data of a Solar MD BMS EM.

Alerts

Warning alerts of the MQTT client device.

Broker connection lost: followed by the reason. The broker or the network stopped.
Failed connection: the error text of the connection attempt.
Broker URI not valid: the error text of the Broker URI check.

Tips

Both Plant Control switches show the plant serial. The by-type topic ends with /by-type.
The topic list grows as devices come online. Open Topics again to see new topics.