Merge pull request #64 from bhelm/main

Restored missing SensorInfo parameters, fixed mqtt global variable shadowing and some linting

Author: AnotherDaniel

plugins/sinks/ha_mqtt/ha_mqtt.py

@@ -1,7 +1,6 @@
 import os
 import time
 import logging
-from collections import defaultdict
 import ha_mqtt_discoverable
 from ha_mqtt_discoverable import Settings
 from ha_mqtt_discoverable.sensors import SensorInfo, Sensor, DeviceInfo
@@ -136,7 +135,10 @@ def get_sensor(name: str, device_info: DeviceInfo) -> Optional[Sensor]:
                                      'unit_of_measurement'),
                                  device_class=result.get('device_class'),
                                  state_class=result.get('state_class'),
-                                 entity_category=result.get('entity_category'))
+                                 entity_category=result.get('entity_category'),
+                                 suggested_display_precision=result.get('suggested_display_precision'),
+                                 icon=result.get('icon'),
+                                 device=device_info)
         # mqtt_settings is guarded above, so cast is safe for the type checker
         sensor = Sensor(Settings(mqtt=mqtt_settings, entity=sensor_info))
         sensors[name] = sensor

plugins/sinks/mqtt/mqtt.py

@@ -3,13 +3,11 @@
 import logging
 import ssl
 import paho.mqtt.client as mqtt
-from typing import Dict, Optional
 
 # Get client ID with optional postfix for multiple instances
 client_id_postfix = os.environ.get('IDENT_POSTFIX', '')
 client = mqtt.Client(
     client_id=f"smahub{client_id_postfix}", transport='tcp', protocol=mqtt.MQTTv311, clean_session=False)
-pubunits = False
 
 
 def env_vars(config):
@@ -50,6 +48,19 @@ def execute(config, get_items, register_callback, do_stop):
 
     logging.info("Starting MQTT sink")
 
+    # Define publish and callback functions here to capture pubunits in closure
+    def publish(topic, value):
+        # only publish units if they are there and we really want to
+        publish_value = value
+        if isinstance(value, tuple):
+            if not pubunits:
+                publish_value = value[0]
+        client.publish(topic, str(publish_value))
+
+    def my_callback(key, value):
+        topic = str(key).replace(".", "/")
+        publish(topic, value)
+
     # No need for global - we're only using the module-level client, not rebinding it
     if config['server']['username']:
         client.username_pw_set(
@@ -103,7 +114,7 @@ def execute(config, get_items, register_callback, do_stop):
         logging.fatal(
             f"MQTT broker configuration error: {str(exc)}, rethrowing exception")
         raise
-    except ConnectionError as exc:
+    except ConnectionError:
         logging.fatal(
             f"MQTT broker not reachable at address: {config.get('server', 'address')}: {str(config.get('server', 'port'))}")
         raise
@@ -112,7 +123,7 @@ def execute(config, get_items, register_callback, do_stop):
             f"MQTT broker unknown error: {str(exc)}, rethrowing exception")
         raise
 
-    # We only publish data on change
+    # We only publish data on change (use closure-captured my_callback)
     register_callback(my_callback)
 
     i = 0
@@ -132,21 +143,6 @@ def execute(config, get_items, register_callback, do_stop):
     logging.info("Stopping MQTT sink")
 
 
-def publish(topic, value):
-    # read module-level client and pubunits (no rebinding), no global statement required
-    # only publish units if they are there and we really want to
-    publish_value = value
-    if isinstance(value, tuple):
-        if not pubunits:
-            publish_value = value[0]
-    client.publish(topic, str(publish_value))
-
-
-def my_callback(key, value):
-    topic = str(key).replace(".", "/")
-    publish(topic, value)
-
-
 def on_connect(client, userdata, flags, rc):
     if rc == 0:
         logging.info("Connected to MQTT Broker")

plugins/sources/TripowerX/tripowerx.py

@@ -136,7 +136,10 @@ def execute(config, add_data, dostop):
                         try:
                             v = round(float(v), 2)
                         except Exception as e:
-                            logging.error(f"Error rounding value for parameter '{name}': value='{v}', type={type(v).__name__}, error: {e}")
+                            logging.error(
+                                f"Error rounding value for parameter "
+                                f"'{name}': value='{v}', "
+                                f"type={type(v).__name__}, error: {e}")
                             raise
 
                     unit = get_parameter_unit('SENSORS_TRIPOWERX', name)
@@ -152,9 +155,12 @@ def execute(config, add_data, dostop):
                             try:
                                 v = round(float(v), 2)
                             except Exception as e:
-                                logging.error(f"Error rounding value for parameter '{name}[{idx}]': value='{v}', type={type(v).__name__}, error: {e}")
+                                logging.error(
+                                    f"Error rounding value for parameter "
+                                    f"'{name}[{idx}]': value='{v}', "
+                                    f"type={type(v).__name__}, error: {e}")
                                 raise
-                        
+
                         idxname = dname + "." + str(idx + 1)
                         unit = get_parameter_unit('SENSORS_TRIPOWERX', name)
                         if unit:

pyproject.toml

@@ -4,7 +4,7 @@ requires = ["flit_core >=3.8.0,<4"]
 
 [project]
 name = "smahub"
-version = "1.6.3"
+version = "1.7.1"
 authors = [{ name = "Daniel Krippner", email = "dk.mailbox@gmx.net" }]
 description = "Little daemon that runs plugins for collecting data from SMA PV products, and publishes to eg MQTT via other plugins."
 readme = "README.md"