Skip to content

Improvements for Home Assistant discovery #87

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

Closed
ederjc wants to merge 6 commits into from
Closed

Improvements for Home Assistant discovery #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f4f6cf7
add display name for Home Assistant
ederjc May 25, 2025
88fe48e
parse device model from config
ederjc May 25, 2025
e8000c0
update serial number once available
ederjc May 25, 2025
1683c96
add availability_topic attribute
ederjc May 25, 2025
7ce4c43
remove redundant name cleaning
ederjc May 25, 2025
64bb897
replace _ by space in HA displayed device name
ederjc May 25, 2025
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
10 changes: 6 additions & 4 deletions classes/protocol_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ class registry_map_entry:
register_byte : int
''' byte offset for canbus ect... '''
variable_name : str
display_name : str
documented_name : str
unit : str
unit_mod : float
Expand Down Expand Up @@ -500,14 +501,14 @@ def process_row(row):
#endregion unit


variable_name = row["variable name"] if row["variable name"] else row["documented name"]
variable_name = variable_name.strip().lower().replace(" ", "_").replace("__", "_") #clean name
display_name = row["variable name"] if row["variable name"] else row["documented name"]
variable_name = display_name.strip().lower().replace(" ", "_").replace("__", "_") #clean name

if re.search(r"[^a-zA-Z0-9\_]", variable_name) :
self._log.warning("Invalid Name : " + str(variable_name) + " reg: " + str(row["register"]) + " doc name: " + str(row["documented name"]) + " path: " + str(path))


if not variable_name and not row["documented name"]: #skip empty entry / no name. todo add more invalidator checks.
if not variable_name: #skip empty entry / no name. todo add more invalidator checks.
self._log.warning(f"Skipping empty name for register: {row['register']}")
return

#region data type
Expand Down Expand Up @@ -653,6 +654,7 @@ def process_row(row):
register_bit=register_bit,
register_byte= register_byte,
variable_name= variable_name,
display_name = display_name,
documented_name = row["documented name"],
unit= str(unit_symbol),
unit_mod= unit_multiplier,
Expand Down
21 changes: 12 additions & 9 deletions classes/transports/mqtt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class mqtt(transport_base):
base_topic : str = "home/device"
error_topic : str = "/error"
discovery_topic : str = "homeassistant"
availability_topic : str
discovery_enabled : bool = False
json : bool = False
reconnect_delay : int = 7
Expand Down Expand Up @@ -108,7 +109,7 @@ def connect(self):
def exit_handler(self):
'''on exit handler'''
self._log.warning("MQTT Exiting...")
self.client.publish( self.base_topic + "/" + self.device_identifier + "/availability","offline")
self.client.publish(self.availability_topic,"offline",retain=True)
return

def mqtt_reconnect(self):
Expand Down Expand Up @@ -161,7 +162,7 @@ def write_data(self, data : dict[str, str], from_transport : transport_base):
self._log.info(f"write data from [{from_transport.transport_name}] to mqtt transport")
self._log.info(data)
#have to send this every loop, because mqtt doesnt disconnect when HA restarts. HA bug.
info = self.client.publish(self.base_topic + "/" + from_transport.device_identifier + "/availability","online", qos=0,retain=True)
info = self.client.publish(self.availability_topic,"online", qos=0,retain=True)
if info.rc == MQTT_ERR_NO_CONN:
self.connected = False

Expand Down Expand Up @@ -204,14 +205,16 @@ def init_bridge(self, from_transport : transport_base):
def mqtt_discovery(self, from_transport : transport_base):
self._log.info("Publishing HA Discovery Topics...")

self.availability_topic = self.base_topic + "/" + from_transport.device_identifier + "/availability"

disc_payload = {}
disc_payload["availability_topic"] = self.base_topic + "/" + from_transport.device_identifier + "/availability"
disc_payload["availability_topic"] = self.availability_topic

device = {}
device["manufacturer"] = from_transport.device_manufacturer
device["model"] = from_transport.device_model
device["identifiers"] = "hotnoob_" + from_transport.device_model + "_" + from_transport.device_serial_number
device["name"] = from_transport.device_name
device["name"] = from_transport.device_name.replace("_", " ").strip()

registry_map : list[registry_map_entry] = []
for entries in from_transport.protocolSettings.registry_map.values():
Expand All @@ -229,8 +232,9 @@ def mqtt_discovery(self, from_transport : transport_base):
continue


clean_name = item.variable_name.lower().replace(" ", "_").strip()
if not clean_name: #if name is empty, skip
clean_name = item.variable_name
if not clean_name: #if name is empty, skip^
self._log.warning(f"Skipping empty name for item: {item.register}")
continue

if False:
Expand All @@ -247,7 +251,7 @@ def mqtt_discovery(self, from_transport : transport_base):
disc_payload = {}
disc_payload["availability_topic"] = self.base_topic + "/" + from_transport.device_identifier + "/availability"
disc_payload["device"] = device
disc_payload["name"] = clean_name
disc_payload["name"] = item.display_name
disc_payload["unique_id"] = "hotnoob_" + from_transport.device_serial_number + "_"+clean_name

writePrefix = ""
Expand All @@ -259,8 +263,7 @@ def mqtt_discovery(self, from_transport : transport_base):
if item.unit:
disc_payload["unit_of_measurement"] = item.unit


discovery_topic = self.discovery_topic+"/sensor/HN-" + from_transport.device_serial_number + writePrefix + "/" + disc_payload["name"].replace(" ", "_") + "/config"
discovery_topic = self.discovery_topic+"/sensor/HN-" + from_transport.device_serial_number + writePrefix + "/" + clean_name + "/config"

self.client.publish(discovery_topic,
json.dumps(disc_payload),qos=1, retain=True)
Expand Down
3 changes: 3 additions & 0 deletions classes/transports/transport_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ def __init__(self, settings : "SectionProxy") -> None:

if settings:
self.device_serial_number = settings.get(["device_serial_number", "serial_number"], self.device_serial_number)
self.device_model = settings.get(["device_model", "model"], self.device_model)
self.device_manufacturer = settings.get(["device_manufacturer", "manufacturer"], self.device_manufacturer)
self.device_name = settings.get(["device_name", "name"], fallback=self.device_manufacturer+"_"+self.device_serial_number)
self.bridge = settings.get("bridge", self.bridge)
Expand Down Expand Up @@ -124,6 +125,8 @@ def __init__(self, settings : "SectionProxy") -> None:

def update_identifier(self):
self.device_identifier = self.device_serial_number.strip().lower()
if self.device_name[-1] == "_": # Device name is missing serial number
self.device_name = self.device_name + self.device_serial_number

def init_bridge(self, from_transport : "transport_base"):
pass
Expand Down