replace Avahi with ZeroConf for cross platform;add fake LED for testing

README.md

@@ -21,12 +21,7 @@ CircuitMatter is currently developed in CPython 3.12, the de facto implementatio
 
 ### Running on a Raspberry Pi SBC
 
-CircuitMatter uses [avahi tools](https://avahi.org) to manage MDNS on Linux. It must therefore be installed for it to work properly.
-```shell
-sudo apt-get install avahi-utils
-```
-
-Now, install CircuitMatter:
+Install CircuitMatter:
 
 ```shell
 pip install circuitmatter
@@ -203,7 +198,7 @@ To run CircuitMatter against a live Matter commissioner run:
 python examples/replay.py
 ```
 
-This will start up MDNS via avahi for discovery by the commissioner and then reply to received UDP packets. CircuitMatter currently doesn't fully commission so it can't act as any specific type of device yet. When it can, there will be examples.
+This will start up MDNS for discovery by the commissioner and then reply to received UDP packets. CircuitMatter currently doesn't fully commission so it can't act as any specific type of device yet. When it can, there will be examples.
 
 ## Running a Matter commissioner
 

circuitmatter/__init__.py

@@ -37,9 +37,9 @@ def __init__(
         self.socketpool = socketpool
 
         if mdns_server is None:
-            from circuitmatter.utility.mdns.avahi import Avahi
+            from circuitmatter.utility.mdns.zeroconf import ZeroConf
 
-            mdns_server = Avahi()
+            mdns_server = ZeroConf()
         self.mdns_server = mdns_server
 
         if random_source is None:

circuitmatter/utility/mdns/zeroconf.py

@@ -0,0 +1,49 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024 Scott Shawcroft for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+import socket
+
+from zeroconf import IPVersion, ServiceInfo, Zeroconf
+
+
+class ZeroConf:
+    def __init__(self):
+        self.zeroconf = Zeroconf(ip_version=IPVersion.All)
+        self.service_infos = {}
+
+    def advertise_service(
+        self,
+        service_type,
+        protocol,
+        port,
+        txt_records={},
+        subtypes=[],
+        instance_name="",
+    ):
+        txt_records = {key: value for key, value in txt_records.items()}
+        main_info = ServiceInfo(
+            f"{service_type}.{protocol}.local.",
+            f"{service_type}.{protocol}.local.",
+            addresses=[socket.inet_aton("0.0.0.0")],
+            port=port,
+            properties=txt_records,
+        )
+        self.zeroconf.register_service(main_info)
+        self.service_infos[service_type + instance_name] = main_info
+
+        for subtype in subtypes:
+            sub_info = ServiceInfo(
+                f"{subtype}.local.",
+                f"{subtype}.local.",
+                addresses=[socket.inet_aton("0.0.0.0")],
+                port=port,
+                properties=txt_records,
+            )
+            self.service_infos[subtype] = sub_info
+            self.zeroconf.register_service(sub_info)
+
+    def __del__(self):
+        for service_info in self.service_infos.values():
+            self.zeroconf.unregister_service(service_info)
+        self.zeroconf.close()

examples/replay.py

@@ -13,7 +13,7 @@
 from circuitmatter.device_types.lighting import on_off
 from circuitmatter.utility import random
 from circuitmatter.utility.mdns import DummyMDNS
-from circuitmatter.utility.mdns.avahi import Avahi
+from circuitmatter.utility.mdns.zeroconf import ZeroConf
 from circuitmatter.utility.recording import RecordingRandom, RecordingSocketPool
 from circuitmatter.utility.replay import ReplayRandom, ReplaySocketPool
 
@@ -51,7 +51,7 @@ def run(replay_file=None):
             # No starting state.
             record_file.write("none\n")
         socketpool = RecordingSocketPool(record_file, socket)
-        mdns_server = Avahi()
+        mdns_server = ZeroConf()
         random_source = RecordingRandom(record_file, random)
 
     matter = cm.CircuitMatter(socketpool, mdns_server, random_source, device_state)

examples/replay_rgb_light.py

@@ -13,7 +13,7 @@
 from circuitmatter.device_types.lighting import extended_color
 from circuitmatter.utility import random
 from circuitmatter.utility.mdns import DummyMDNS
-from circuitmatter.utility.mdns.avahi import Avahi
+from circuitmatter.utility.mdns.zeroconf import ZeroConf
 from circuitmatter.utility.recording import RecordingRandom, RecordingSocketPool
 from circuitmatter.utility.replay import ReplayRandom, ReplaySocketPool
 
@@ -73,7 +73,7 @@ def run(replay_file=None):
             # No starting state.
             record_file.write("none\n")
         socketpool = RecordingSocketPool(record_file, socket)
-        mdns_server = Avahi()
+        mdns_server = ZeroConf()
         random_source = RecordingRandom(record_file, random)
 
     matter = cm.CircuitMatter(socketpool, mdns_server, random_source, device_state)

fake_onoff_led.py

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024 Scott Shawcroft for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""Simple fake LED on and off as a light."""
+
+import circuitmatter as cm
+from circuitmatter.device_types.lighting import on_off
+
+
+class LED(on_off.OnOffLight):
+    def __init__(self, name):
+        super().__init__(name)
+        self._name = name
+        self.state = False
+
+    def on(self):
+        self.state = True
+        print("Led %s is On", self._name)
+
+    def off(self):
+        self.state = False
+        print("Led %s is Off", self._name)
+
+
+matter = cm.CircuitMatter()
+led1 = LED("led1")
+matter.add_device(led1)
+led2 = LED("led2")
+matter.add_device(led2)
+while True:
+    matter.process_packets()

pyproject.toml

@@ -7,6 +7,7 @@ requires = [
     "setuptools",
     "wheel",
     "setuptools-scm",
+    "zeroconf",
 ]
 
 [project]