wip: more RDM

Author: shuckc

README.md

@@ -98,7 +98,7 @@ Features
 | 15-bit port addresses                  | :heavy_check_mark:  | :heavy_check_mark: |
 | >4 ports (bindIndex) on same IP        | :heavy_check_mark:  | :heavy_check_mark: |
 | merge-mode (LTP/HTP) in reciever       | -                   | -                  |
-| RDM commands to enumerate fixtures     | -                   | -                  |
+| RDM commands to enumerate fixtures     | :heavy_check_mark:  | :heavy_check_mark: |
 | Timecode                               | -                   | -                  |
 | Multi-universe sync message            | -                   | -                  |
 | local node reconfigure by API          | :heavy_check_mark:  | :heavy_check_mark: |
@@ -119,9 +119,11 @@ Implemented Messages
 | ArtDiagData                        | -                   | -                  |
 | ArtTimeCode                        | -                   | -                  |
 | ArtCommand                         | -                   | -                  |
+| ArtNzs                             | -                   | -                  |
 | ArtTrigger                         | -                   | -                  |
 | ArtSync                            | -                   | -                  |
-| RDM ArtTodRequest / ArtTodData / ArtTodControl / ArtRdm / ArtRdmSub | - | - |
+| RDM ArtTodRequest / ArtTodData / ArtTodControl | :heavy_check_mark: | :heavy_check_mark: |
+| RDM ArtRdm / ArtRdmSub             | -                   | -                  |
 
 
 Art-Net
@@ -136,9 +138,13 @@ This application aims to be fully compatible with Art-Net devices. We have teste
 
 ![Art-Net logo](./docs/art-net-master-logo.svg) Art-Net™ Designed by and Copyright Artistic Licence Engineering Ltd.
 
-RDM
+DMX Remote Device Management (RDM) Support
 ---
 
+The Art-Net protocol can carry RDM messages to allow for table-of-device enumeration, and then inspection of the devices by uid.
+
+https://www.rdmprotocol.org/rdm/wp-content/uploads/2011/09/logo2.jpg
+
 See https://www.rdmprotocol.org/rdm/
 
 RDM specs are https://tsp.esta.org/tsp/documents/published_docs.php

aioartnet/aio_artnet.py

@@ -6,9 +6,10 @@
 import struct
 import time
 from collections import defaultdict
-from typing import Any, Optional, Tuple, Union, cast
+from typing import Any, Optional, Sequence, Tuple, Union, cast
 
 from .network import AF_PACKET, getifaddrs
+from .rdm import RDMDevice
 
 # Art-Net implementation for Python asyncio
 # Any page references to 'spec' refer to
@@ -110,7 +111,7 @@ def __init__(self, portaddress: int):
         self._last_publish: float = 0.0
         self._last_tod_request: float = 0.0
         self.publisherseq: dict[Tuple[DGAddr, int], int] = {}
-        self.tod_uuids: set[bytes] = set()
+        self._tod: dict[bytes, RDMDevice] = {}
 
     def split(self) -> Tuple[int, int, int]:
         # name  net:sub_net:universe
@@ -124,13 +125,16 @@ def __repr__(self) -> str:
         net, sub_net, universe = self.split()
         return f"{net}:{sub_net}:{universe}"
 
-    def set_dmx(self, data: bytes):
+    def set_dmx(self, data: bytes) -> None:
         assert len(data) == DMX_UNIVERSE_SIZE
         self.last_data[:] = data[:]
 
     def get_dmx(self) -> bytes:
         return self.last_data
 
+    def get_rdm_uuids(self) -> Sequence[bytes]:
+        return list(self._tod.keys())
+
 
 class ArtNetPort:
     def __init__(
@@ -140,6 +144,7 @@ def __init__(
         media: int,
         portaddr: int,
         universe: ArtNetUniverse,
+        flags: int,
     ):
         self.node = node
         self.is_input = is_input
@@ -265,7 +270,9 @@ def on_art_poll_reply(self, addr: DGAddr, data: bytes) -> None:
 
         # iterate through the ports and create ports and universes
         portList = []
-        for _type, _in, _out, _swin, _swout in zip(ptype, ins, outs, swin, swout):
+        for _type, _in, _out, _swin, _swout, _goodout in zip(
+            ptype, ins, outs, swin, swout, goodout
+        ):
             in_port_addr = (
                 ((netsw & 0x7F) << 8) + ((subsw & 0x0F) << 4) + (_swin & 0x0F)
             )
@@ -275,11 +282,13 @@ def on_art_poll_reply(self, addr: DGAddr, data: bytes) -> None:
             if _type & 0b10000000:
                 outu = self.client._get_create_universe(out_port_addr)
                 portList.append(
-                    ArtNetPort(nn, False, _type & 0x1F, out_port_addr, outu)
+                    ArtNetPort(nn, False, _type & 0x1F, out_port_addr, outu, _goodout)
                 )
             if _type & 0b01000000:
                 inu = self.client._get_create_universe(in_port_addr)
-                portList.append(ArtNetPort(nn, True, _type & 0x1F, in_port_addr, inu))
+                portList.append(
+                    ArtNetPort(nn, True, _type & 0x1F, in_port_addr, inu, 0)
+                )
 
         # track which 'pages' of port bindings we have seen
         old_ports = nn._portBinds[bindindex]
@@ -375,7 +384,7 @@ def on_art_tod_data(self, addr: DGAddr, data: bytes) -> None:
         # I think tot_uid and block_count are *paging* related if more tod UIDs than can fit in a packet
         for i in range(uid_count):
             uid = data[18 + i * 6 : 18 + (i + 1) * 6]
-            u.tod_uuids.add(uid)
+            u._tod[uid] = RDMDevice(uid)
             logger.info(
                 f"Received Art-Net TOD entry: universe {portaddress} uid={uid.hex()} from {addr}"
             )
@@ -515,7 +524,7 @@ def _send_art_dmx_subscriber(
         if self.transport:
             self.transport.sendto(message, addr=(node.ip, node.udpport))
 
-    def _send_art_tod_request(self, universe: ArtNetUniverse):
+    def _send_art_tod_request(self, universe: ArtNetUniverse) -> None:
         logger.debug(f"sending art tod request for {universe}")
         universe._last_tod_request = time.time()
 
@@ -685,7 +694,12 @@ def set_port_config(
 
         if is_input or is_output:
             port = ArtNetPort(
-                node=self, is_input=is_input, media=0, portaddr=port_addr, universe=u
+                node=self,
+                is_input=is_input,
+                media=0,
+                portaddr=port_addr,
+                universe=u,
+                flags=0,
             )
             self.ports.append(port)
             logger.info(f"configured own port {port}")

aioartnet/rdm.py

@@ -0,0 +1,44 @@
+from dataclasses import dataclass
+from typing import Sequence
+
+# Can be subclassed to mock responses to more complex RDM queries. Built in has:
+#   RDM uuid
+#   DMX base address
+#   DMX profile name
+#   DMX channel count
+
+
+@dataclass
+class RDMDevice:
+    def __init__(self, uuid: bytes):
+        self.uuid = uuid
+        self.dmx_base_address = 0
+        self.dmx_profile_name = ""
+        self.dmx_profile_width = 1
+
+
+# the RDM interrogator is installed into the ArtNetClient, since it might need to be configurable
+# by default, we get the device uuids and ignore them. We also have a standard one that will fetch
+# the base address, profile name and channel count of any discovered fixtures, and dispatch events
+# for them.
+class RDMInterrogator:
+    def on_uuids(self, uuids: Sequence[bytes]) -> None:
+        self.uuids = uuids
+
+    def poll(self) -> None:
+        # do nothing
+        pass
+
+    def on_rdm_response(self, data: bytes) -> None:
+        pass
+
+
+class RDMResponder:
+    def __init__(self) -> None:
+        self.devices: list[RDMDevice] = []
+
+    def get_tod_uuids(self) -> Sequence[RDMDevice]:
+        return self.devices
+
+    def answer_rdm(self, data: bytes) -> bytes:
+        return bytes()