Changing DeviceInfo general behavior, should fix #3

Author: alexbarcelo

examples/multiple_devices.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+"""Example of an application managing multiple devices.
+
+This is a typical use case for bridges, in which a single hass-mqtt-things
+application acts on behalf of more than one device.
+
+This makes use of the optional DeviceInfo parameter on add_thing.
+"""
+
+from ham import MqttManager, DeviceInfo
+from ham.switch import OptimisticSwitch
+from time import sleep
+import os
+
+MQTT_USERNAME = os.environ["MQTT_USERNAME"]
+MQTT_PASSWORD = os.environ["MQTT_PASSWORD"]
+MQTT_HOST = os.environ["MQTT_HOST"]
+
+
+class BaseSwitch(OptimisticSwitch):
+    def __init__(self, index):
+        self.index = index
+        self.name = "switch %d" % index
+        self.short_id = "s%d" % index
+
+    def callback(self, state):
+        print("The switch #%d has been set to %s" % (self.index, state))
+
+
+if __name__ == "__main__":
+    manager = MqttManager(MQTT_HOST, username=MQTT_USERNAME, password=MQTT_PASSWORD)
+    all_switches = [BaseSwitch(200 + i) for i in range(3)]
+    manager.add_things(all_switches)
+
+    for device_id in range(3):
+        switches = [BaseSwitch(100 + 10 * device_id + i) for i in range(3)]
+        di = DeviceInfo(
+            name="Device#%d" % device_id,
+            hw_version="1.0.0alpha",
+            sw_version="0.0.%dbeta" % device_id,
+            identifiers=["device_testing_%02d" % device_id],
+            connections=[("mac", "eb:%02d:de:c3:e5:f0" % device_id)],
+        )
+        manager.add_things(switches, origin=di)
+        all_switches.extend(switches)
+
+    manager.start()
+
+    print("Entering an infinite loop, Ctrl+C multiple times to exit.")
+    state = False
+    while True:
+        for s in all_switches:
+            sleep(1)
+            s.state = state
+        state = not state

src/ham/__init__.py

@@ -1,5 +1,5 @@
 __version__ = "0.5.6"
 
-from .manager import MqttManager
+from .manager import MqttManager, DeviceInfo
 
-__all__ = ["MqttManager"]
+__all__ = ["MqttManager", "DeviceInfo"]

src/ham/manager.py

@@ -30,7 +30,7 @@ class DeviceInfo(TypedDict, total=False):
 
 
 class MqttManager(Thread):
-    things: dict[Optional[DeviceInfo], list[Thing]]
+    things: list[tuple[Optional[DeviceInfo], Thing]]
     client: mqtt.Client
     node_id: str
     base_topic: str
@@ -100,20 +100,20 @@ def __init__(self, host='localhost', port=1883, username=None,
         else:
             self.name = self.node_id
 
-        self.things = defaultdict(list)
+        self.things = list()
         self.unique_identifier = unique_identifier or self.get_mac()
         self.device_info = self._gen_device_info()
 
         logger.debug("Initialization parameters: node_id=%s, base_topic=%s, discovery_prefix=%s, name=%s",
                      self.node_id, self.base_topic, self.discovery_prefix, self.name)
 
     def add_thing(self, thing: Thing, origin: Optional[DeviceInfo] = None):
-        self.things[origin].append(thing)
+        self.things.append((origin, thing))
         thing.set_manager(self)
 
     def add_things(self, things: list[Thing], origin: Optional[DeviceInfo] = None):
-        self.things[origin].extend(things)
         for thing in things:
+            self.things.append((origin, thing))
             thing.set_manager(self)
 
     def run(self):
@@ -182,7 +182,7 @@ def on_connect(self, _, userdata, flags, rc):
 
         logger.debug("Device information for this manager: %s", self.device_info)
 
-        for origin, things in self.things.items():
+        for origin, thing in self.things:
             if origin is None:
                 common_config = {
                     "~": self.base_topic,
@@ -197,28 +197,27 @@ def on_connect(self, _, userdata, flags, rc):
                     "via": self.device_info["identifiers"][0]
                 }
 
-            for thing in things:
-                logger.info("Publishing discovery message for: %r", thing)
-                
-                # New dictionary with sensible defaults
-                config = common_config.copy()
-                config["unique_id"] = f"{ self.unique_identifier }_{ thing.short_id }"
+            logger.info("Publishing discovery message for: %r", thing)
+            
+            # New dictionary with sensible defaults
+            config = common_config.copy()
+            config["unique_id"] = f"{ self.unique_identifier }_{ thing.short_id }"
 
-                # Then call get_config, and allow the implementation to override
-                # the previously set defaults (at their own risk)
-                config.update(thing.get_config())
+            # Then call get_config, and allow the implementation to override
+            # the previously set defaults (at their own risk)
+            config.update(thing.get_config())
 
-                config_topic = "%s/%s/%s/%s/config" % (
-                        self.discovery_prefix,
-                        thing.component,
-                        self.node_id,
-                        thing.short_id
-                    )
+            config_topic = "%s/%s/%s/%s/config" % (
+                    self.discovery_prefix,
+                    thing.component,
+                    self.node_id,
+                    thing.short_id
+                )
 
-                logger.debug("Sending the following config dict to %s:\n%s", config_topic, config)
+            logger.debug("Sending the following config dict to %s:\n%s", config_topic, config)
 
-                self.client.publish(config_topic, json.dumps(config), retain=True)
-                thing.set_callbacks()
+            self.client.publish(config_topic, json.dumps(config), retain=True)
+            thing.set_callbacks()
 
         # Set up availability topic
         ###########################