Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LWT and modbus status publishing. #63

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add LWT and modbus status publishing. #63

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a308fe3
Added modbus status publishing.
r-xyz Sep 25, 2024
bd4f66b
Added MQTT Last Will message.
r-xyz Sep 25, 2024
9ea37fb
Changing LWT and connection messages to JSON.
r-xyz Sep 25, 2024
00f191b
Modbus Status: Added conditional check for startup scenario.
r-xyz Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion modbus4mqtt/modbus4mqtt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#!/usr/bin/python3

from time import sleep
from datetime import datetime
import json
import logging
from ruamel.yaml import YAML
Expand Down Expand Up @@ -63,13 +64,27 @@ def connect_modbus(self):
failed_attempts = 1
while self._mb.connect():
logging.warning("Modbus connection attempt {} failed. Retrying...".format(failed_attempts))
if failed_attempts == 1 and self._mqtt_client.is_connected():
self._mqtt_client.publish(self.prefix + 'modbus4mqtt/modbus_status',
json.dumps({
"status": "offline",
"timestamp": datetime.now().astimezone().strftime('%Y-%m-%dT%H:%M:%S%z')
})
)
failed_attempts += 1
if self.modbus_connect_retries != -1 and failed_attempts > self.modbus_connect_retries:
logging.error("Failed to connect to modbus. Giving up.")
self.modbus_connection_failed()
# This weird break is here because we mock out modbus_connection_failed in the tests
break
sleep(self.modbus_reconnect_sleep_interval)
if self._mqtt_client.is_connected():
self._mqtt_client.publish(self.prefix + 'modbus4mqtt/modbus_status',
json.dumps({
"status": "online",
"timestamp": datetime.now().astimezone().strftime('%Y-%m-%dT%H:%M:%S%z')
})
)
# Tells the modbus interface about the registers we consider interesting.
for register in self.registers:
self._mb.add_monitor_register(register.get('table', 'holding'), register['address'], register.get('type', 'uint16'))
Expand All @@ -88,6 +103,12 @@ def connect_mqtt(self):
if self.use_tls:
self._mqtt_client.tls_set(ca_certs=self.cafile, certfile=self.cert, keyfile=self.key)
self._mqtt_client.tls_insecure_set(self.insecure)
lwt_message = json.dumps({
"status": "offline",
"version": f"v{version.version}",
"timestamp": datetime.now().isoformat()
})
self._mqtt_client.will_set(self.prefix + 'modbus4mqtt', lwt_message)
self._mqtt_client.connect(self.hostname, self._port, 60)
self._mqtt_client.loop_start()

Expand All @@ -100,6 +121,12 @@ def poll(self):
self._mb.poll()
except Exception as e:
logging.exception("Failed to poll modbus device, attempting to reconnect: {}".format(e))
self._mqtt_client.publish(self.prefix + 'modbus4mqtt/modbus_status',
json.dumps({
"status": "reconnecting",
"timestamp": datetime.now().astimezone().strftime('%Y-%m-%dT%H:%M:%S%z')
})
)
self.connect_modbus()
return

Expand Down Expand Up @@ -163,7 +190,13 @@ def _on_connect(self, client, userdata, flags, rc):
for register in self._get_registers_with('set_topic'):
self._mqtt_client.subscribe(self.prefix+register['set_topic'])
print("Subscribed to {}".format(self.prefix+register['set_topic']))
self._mqtt_client.publish(self.prefix+'modbus4mqtt', 'modbus4mqtt v{} connected.'.format(version.version))
self._mqtt_client.publish(self.prefix+'modbus4mqtt',
json.dumps({
"status": "online",
"version": f"{version.version}",
"timestamp": datetime.now().astimezone().strftime('%Y-%m-%dT%H:%M:%S%z')
})
)

def _on_disconnect(self, client, userdata, rc):
logging.warning("Disconnected from MQTT. Attempting to reconnect.")
Expand Down