mx-remote 9.2.0__tar.gz → 9.4.0__tar.gz

{mx_remote-9.2.0 → mx_remote-9.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mx_remote
-Version: 9.2.0
+Version: 9.4.0
 Summary: Python 3 library for interfacing with MX Remote compatible devices
 Project-URL: Homepage, https://github.com/opdenkamp/mx-remote/
 Project-URL: Documentation, https://opdenkamp.github.io/mx-remote/

{mx_remote-9.2.0 → mx_remote-9.4.0}/docs/api.md

@@ -288,6 +288,23 @@ How a source unit encrypts its streams, as it reports it.
    :members:
 ```
 
+## Application messages
+
+Messages applications exchange over the mesh under their own vendor id.
+
+```{eval-rst}
+.. autoclass:: mx_remote.ThirdPartyMessage
+   :members:
+
+.. autoclass:: mx_remote.ThirdPartyVendor
+   :members:
+
+.. autoclass:: mx_remote.proto.Constants.ThirdPartyVendorFlag
+   :members:
+
+.. autodata:: mx_remote.proto.Constants.THIRD_PARTY_PAYLOAD_MAX
+```
+
 ## OneIP test card
 
 A sink's test pattern, tone and lip-sync flash, and the ranges it accepts.

{mx_remote-9.2.0 → mx_remote-9.4.0}/docs/callbacks.md

@@ -67,6 +67,7 @@ Available callback methods:
 | `on_rc_type_changed` | remote control type changed |
 | `on_amp_zone_settings_changed` | amplifier zone settings changed |
 | `on_amp_dolby_settings_changed` | amplifier Dolby settings changed |
+| `on_third_party_message` | another application sent a message under its vendor id |
 
 You can also register per-device and per-bay callbacks:
 
@@ -85,6 +86,30 @@ device.unregister_callback(on_device_changed)
 bay.unregister_callback(on_bay_changed)
 ```
 
+## Application messages
+
+Applications built on this library can message each other over the mesh. A
+message carries a vendor id, then up to `THIRD_PARTY_PAYLOAD_MAX` (1444) bytes
+that only the application reads. The vendor id is the vendor's IEEE OUI, or an
+identifier it chose, such as three letters:
+
+```python
+from mx_remote import ThirdPartyVendor
+
+ODK = ThirdPartyVendor.private(b'ODK')
+
+await mx.send_third_party(ODK, b'hello')    # False when over 1444 bytes
+
+class MyCallbacks(mx_remote.MxrCallbacks):
+    def on_third_party_message(self, dev, message):
+        if message.vendor.same_vendor(ODK):
+            print(f"{dev} says {message.payload!r}")
+```
+
+Every other client that has heard this one announce itself receives the
+message; this client does not. No unit reads it, and nothing acknowledges it,
+so an application that needs to know a message arrived has its peers answer.
+
 ---
 
 [Documentation index](README.md) | [Project README](https://github.com/opdenkamp/mx-remote#readme)

{mx_remote-9.2.0 → mx_remote-9.4.0}/docs/oneip.md

@@ -432,6 +432,14 @@ application, which this client announces itself as, and only from protocol
 after its last page, so one is refused before it is sent. Nothing acknowledges
 the pages; `oneip_sink_sdp` reads what the output reports next.
 
+From protocol 0x31 an output also reports the description it plays, when it
+starts a stream other than by its mesh controller's command and when asked:
+
+```python
+await sink.request_oneip_sink_description()   # False below protocol 0x31
+print(sink.oneip_sink_description)   # None until reported, and once it plays none
+```
+
 ### Overlay sync
 
 A management unit can have the other units copy its overlay captions, logo
@@ -553,8 +561,14 @@ await device.set_unit_network(UnitNetConfig(
     ip='10.1.2.3', netmask='255.255.255.0', gateway='10.1.2.254', dns1='10.1.2.254'))
 await device.confirm_unit_network()    # keep it, once the unit reports it
 await device.set_unit_dhcp()
+await device.locate_unit(timed=True)   # flash its LED for 30 s; timed=False until stopped
+await device.stop_locating_unit()
 ```
 
+A unit is located only once its status carries `UnitFlag.LOCATE_SUPPORTED`. Its
+board-ID LED flashes and an output shows "Locate Device"; `UnitFlag.LOCATE` in
+the cached status says so from the moment the command is sent.
+
 A changed IP configuration applies at once and reverts unless the mesh
 controller confirms it in time; `status.network_pending` says whether it still
 waits. Each command returns False without sending for a device that is not a

{mx_remote-9.2.0 → mx_remote-9.4.0}/mx_remote/Interface.py

@@ -2601,6 +2601,68 @@ class OneIPPrivacy:
     def __str__(self) -> str:
         return f"video {self.video}, audio {self.audio}, anc {self.anc}"
 
+@dataclass(frozen=True)
+class ThirdPartyVendor:
+    """
+    Whose message a third-party message is: a flag byte, then three bytes
+    naming the vendor.
+
+    The three bytes are the vendor's IEEE OUI, in the order it is written, or
+    with ThirdPartyVendorFlag.NOT_OUI set an identifier of the vendor's own
+    choosing, such as three ASCII letters. The flag keeps the two spaces apart,
+    so a chosen identifier never collides with a registered OUI.
+    """
+    flags: ThirdPartyVendorFlag
+    """The flag byte, at offset 0."""
+    id: bytes
+    """The vendor's three identifying bytes, at offsets 1 to 3."""
+
+    def __post_init__(self) -> None:
+        if (len(self.id) != 3):
+            raise ValueError(f"a vendor id is 3 bytes, not {len(self.id)}")
+
+    @classmethod
+    def oui(cls, oui:bytes) -> 'ThirdPartyVendor':
+        """A vendor named by its IEEE OUI."""
+        return cls(flags=ThirdPartyVendorFlag(0), id=bytes(oui))
+
+    @classmethod
+    def private(cls, id:bytes) -> 'ThirdPartyVendor':
+        """A vendor named by an identifier it chose, rather than an OUI."""
+        return cls(flags=ThirdPartyVendorFlag.NOT_OUI, id=bytes(id))
+
+    def same_vendor(self, other:'ThirdPartyVendor') -> bool:
+        """Whether other names the same vendor.
+
+        Only ThirdPartyVendorFlag.NOT_OUI and the three identifying bytes say
+        who the vendor is, so the other flag bits are left out."""
+        return ((ThirdPartyVendorFlag.NOT_OUI in self.flags) == (ThirdPartyVendorFlag.NOT_OUI in other.flags)) \
+            and (self.id == other.id)
+
+    def __str__(self) -> str:
+        if (ThirdPartyVendorFlag.NOT_OUI in self.flags):
+            return f"vendor {self.id!r}"
+        return f"vendor OUI {self.id.hex(':')}"
+
+@dataclass(frozen=True)
+class ThirdPartyMessage:
+    """
+    A message an application sent to every device, under its own vendor id.
+
+    The library reads only the vendor id. What follows is the application's,
+    and arrives exactly as it was sent.
+    """
+    vendor: ThirdPartyVendor
+    """Which application's message this is. The library checks none: each
+    application ignores every message whose vendor is not its own."""
+    payload: bytes
+    """The application's bytes, at most THIRD_PARTY_PAYLOAD_MAX."""
+    address: str|None
+    """Where the datagram came from."""
+
+    def __str__(self) -> str:
+        return f"{self.vendor}: {len(self.payload)} bytes"
+
 @dataclass(frozen=True)
 class OneIPTestTone:
     """A OneIP sink's test tone."""
@@ -3293,6 +3355,15 @@ class DeviceBase(ABC):
     async def confirm_unit_network(self) -> bool:
         '''keep the unit's pending IP configuration'''
 
+    @abstractmethod
+    async def locate_unit(self, timed:bool=False) -> bool:
+        '''flash the unit's board-ID LED and show "Locate Device" on its output,
+        for 30 s when timed is set, until stop_locating_unit() otherwise'''
+
+    @abstractmethod
+    async def stop_locating_unit(self) -> bool:
+        '''stop locating the unit'''
+
     @property
     @abstractmethod
     def oneip_downmix(self) -> OneIPDownmix|None:
@@ -3678,6 +3749,18 @@ class DeviceBase(ABC):
     async def request_oneip_sink_sdp(self) -> bool:
         '''ask this OneIP output what it plays from a session description now'''
 
+    @property
+    @abstractmethod
+    def oneip_sink_description(self) -> str|None:
+        '''The session description this OneIP output last reported playing, None
+        until it has and once it reports playing none. An output reports one
+        when it starts a stream other than by its mesh controller's command,
+        and when asked with request_oneip_sink_description().'''
+
+    @abstractmethod
+    async def request_oneip_sink_description(self) -> bool:
+        '''ask this OneIP output for the session description it plays'''
+
     @abstractmethod
     async def set_oneip_test_pattern(self, pattern:OneIPTestPattern, colour:int=0) -> bool:
         '''show a test pattern on this sink's output'''
@@ -4370,6 +4453,13 @@ class MxrCallbacks:
         _LOGGER.debug(f"{device} dolby settings changed")
         self.on_device_update(device)
 
+    def on_third_party_message(self, dev:DeviceBase, message:ThirdPartyMessage) -> None:
+        ''' called when the application on 'dev' sent a message under its own
+        vendor id. A message from a sender this client has not yet heard
+        announce itself is dropped, as every frame is, and this client never
+        receives its own. '''
+        pass
+
 # The V2IP spelling of a name here, from before the rename to OneIP.
 from .deprecated import alias_members as _alias_members, module_getattr as _module_getattr
 # Installed through globals() so the generated stubs carry no __getattr__, which

{mx_remote-9.2.0 → mx_remote-9.4.0}/mx_remote/Interface.pyi

@@ -930,6 +930,23 @@ class OneIPPrivacy:
     audio: OneIPPrivacyStream
     anc: OneIPPrivacyStream
 
+@dataclass(frozen=True)
+class ThirdPartyVendor:
+    flags: ThirdPartyVendorFlag
+    id: bytes
+    def __post_init__(self) -> None: ...
+    @classmethod
+    def oui(cls, oui: bytes) -> ThirdPartyVendor: ...
+    @classmethod
+    def private(cls, id: bytes) -> ThirdPartyVendor: ...
+    def same_vendor(self, other: ThirdPartyVendor) -> bool: ...
+
+@dataclass(frozen=True)
+class ThirdPartyMessage:
+    vendor: ThirdPartyVendor
+    payload: bytes
+    address: str | None
+
 @dataclass(frozen=True)
 class OneIPTestTone:
     mode: OneIPToneMode | int = ...
@@ -1193,6 +1210,10 @@ class DeviceBase(ABC):
     async def set_unit_network(self, network: UnitNetConfig) -> bool: ...
     @abstractmethod
     async def confirm_unit_network(self) -> bool: ...
+    @abstractmethod
+    async def locate_unit(self, timed: bool = False) -> bool: ...
+    @abstractmethod
+    async def stop_locating_unit(self) -> bool: ...
     @property
     @abstractmethod
     def oneip_downmix(self) -> OneIPDownmix | None: ...
@@ -1376,6 +1397,11 @@ class DeviceBase(ABC):
     async def set_oneip_sdp_screen(self, screen: int) -> bool: ...
     @abstractmethod
     async def request_oneip_sink_sdp(self) -> bool: ...
+    @property
+    @abstractmethod
+    def oneip_sink_description(self) -> str | None: ...
+    @abstractmethod
+    async def request_oneip_sink_description(self) -> bool: ...
     @abstractmethod
     async def set_oneip_test_pattern(self, pattern: OneIPTestPattern, colour: int = 0) -> bool: ...
     @abstractmethod
@@ -1620,3 +1646,4 @@ class MxrCallbacks:
     def on_rc_type_changed(self, bay: BayBase, rc_type: RCType | None) -> None: ...
     def on_amp_zone_settings_changed(self, bay: BayBase, settings: AmpZoneSettings) -> None: ...
     def on_amp_dolby_settings_changed(self, device: DeviceBase, settings: AmpDolbySettings) -> None: ...
+    def on_third_party_message(self, dev: DeviceBase, message: ThirdPartyMessage) -> None: ...

{mx_remote-9.2.0 → mx_remote-9.4.0}/mx_remote/const.py

@@ -14,7 +14,7 @@ Default communication modes:
 """
 import os
 
-VERSION = '9.2.0'
+VERSION = '9.4.0'
 __version__ = VERSION
 
 MX_BCAST_UDP_PORT = 8811

{mx_remote-9.2.0 → mx_remote-9.4.0}/mx_remote/proto/Constants.py

@@ -123,6 +123,9 @@ MXR_OPCODE_VERSIONS: dict[int, int] = {
     0x52: 0x2E,  # V2IP_SINK_SDP
     0x53: 0x2F,  # V2IP_OSD_SYNC
     0x54: 0x30,  # V2IP_PRIVACY
+    # The lowest stamp, so that every receiver's ceiling passes it. No device
+    # decodes the payload, so there is no layout for a stamp to announce.
+    0x55: 0x01,  # THIRD_PARTY
 }
 """Per-opcode minimum compatible protocol version, mirroring the firmware's
 own opcode table. Transmitters stamp the
@@ -681,6 +684,11 @@ class UnitFlag(IntFlag):
 	'''The boot count is reported.'''
 	FAN_SPEED                  = (1 << 15)
 	'''The fan speed is reported.'''
+	LOCATE_SUPPORTED           = (1 << 16)
+	'''The unit takes UnitCommandKind.LOCATE.'''
+	LOCATE                     = (1 << 17)
+	'''The unit is being located: its board-ID LED flashes, and an output shows
+	"Locate Device".'''
 
 class UnitCommandKind(IntEnum):
 	'''What a unit command asks of its unit.'''
@@ -692,6 +700,8 @@ class UnitCommandKind(IntEnum):
 	'''Change the IP configuration.'''
 	NET_CONFIRM             = 3
 	'''Keep a pending IP configuration.'''
+	LOCATE                  = 4
+	'''Start or stop locating the unit.'''
 
 class UnitCommandFlag(IntFlag):
 	'''The flags of a unit command.'''
@@ -700,6 +710,11 @@ class UnitCommandFlag(IntFlag):
 	already.'''
 	DHCP  = (1 << 1)
 	'''With NET_CONFIG: use DHCP, ignoring the addresses.'''
+	LOCATE_ON    = (1 << 2)
+	'''With LOCATE: locate it until stopped. Neither this nor LOCATE_TIMED
+	stops it.'''
+	LOCATE_TIMED = (1 << 3)
+	'''With LOCATE: locate it for 30 s.'''
 
 UNIT_MAX_TEMPERATURES = 6
 """The most temperature sensors a unit reports."""
@@ -822,6 +837,21 @@ ONEIP_VLAN_PORT_SFP = 0
 ONEIP_VLAN_ID_MAX = 4094
 """The highest VLAN id: 0 means untagged, and 4095 is reserved by IEEE 802.1Q."""
 
+class ThirdPartyVendorFlag(IntFlag):
+	'''The first byte of a third-party vendor id, ahead of its three
+	identifying bytes. Bits without a name are kept as they arrived.'''
+	NOT_OUI = (1 << 0)
+	'''The three bytes are an identifier the vendor chose, rather than its
+	IEEE OUI.'''
+
+THIRD_PARTY_PAYLOAD_MAX = 1444
+"""The largest payload a third-party message carries.
+
+A frame this size fills one 1500-byte Ethernet frame exactly: 20 bytes of IPv4
+header, 8 of UDP, the 24-byte frame header and the 4-byte vendor id leave 1444.
+A larger send is refused rather than fragmented, because a lost fragment loses
+the whole datagram and nothing on these paths retries."""
+
 BAY_FEATURE_DOLBY_IN_POS = 24
 
 class BayFeaturesMask(IntFlag):

{mx_remote-9.2.0 → mx_remote-9.4.0}/mx_remote/proto/Constants.pyi

@@ -271,16 +271,21 @@ class UnitFlag(IntFlag):
     POWER_CHECK: Incomplete
     BOOT_COUNT: Incomplete
     FAN_SPEED: Incomplete
+    LOCATE_SUPPORTED: Incomplete
+    LOCATE: Incomplete
 
 class UnitCommandKind(IntEnum):
     CLEAR_STATUS: int
     VIDEO_PROCESSOR_UPGRADE: int
     NET_CONFIG: int
     NET_CONFIRM: int
+    LOCATE: int
 
 class UnitCommandFlag(IntFlag):
     FORCE: Incomplete
     DHCP: Incomplete
+    LOCATE_ON: Incomplete
+    LOCATE_TIMED: Incomplete
 
 UNIT_MAX_TEMPERATURES: int
 
@@ -340,6 +345,11 @@ class OneIPVlanFlag(IntFlag):
 ONEIP_VLAN_PORTS: int
 ONEIP_VLAN_PORT_SFP: int
 ONEIP_VLAN_ID_MAX: int
+
+class ThirdPartyVendorFlag(IntFlag):
+    NOT_OUI: Incomplete
+
+THIRD_PARTY_PAYLOAD_MAX: int
 BAY_FEATURE_DOLBY_IN_POS: int
 
 class BayFeaturesMask(IntFlag):

{mx_remote-9.2.0 → mx_remote-9.4.0}/mx_remote/proto/Factory.py

@@ -249,6 +249,9 @@ def _mxr_frame_factory(hdr:FrameHeader, timestamp:float) -> FrameBase|None:
 	if hdr.opcode == 0x54:
 		from .FrameV2IPPrivacy import FrameV2IPPrivacy
 		return FrameV2IPPrivacy(header=hdr, timestamp=timestamp)
+	if hdr.opcode == 0x55:
+		from .FrameThirdParty import FrameThirdParty
+		return FrameThirdParty(header=hdr, timestamp=timestamp)
 	if hdr.opcode == 0x50:
 		from .FrameUnitCommand import FrameUnitCommand
 		return FrameUnitCommand(header=hdr, timestamp=timestamp)

mx_remote-9.4.0/mx_remote/proto/FrameThirdParty.py

@@ -0,0 +1,50 @@
+######################################################
+##            MX Remote Python Interface            ##
+##                                                  ##
+## author: Lars Op den Kamp (lars@opdenkamp-it.nl)  ##
+## copyright (c) 2021-2026 Op den Kamp IT Solutions ##
+######################################################
+'''Protocol frame for THIRD_PARTY (opcode 0x55): messages applications
+exchange over the mesh.'''
+
+from functools import cached_property
+from ..compat import override
+from .Constants import ThirdPartyVendorFlag
+from .FrameBase import FrameBase
+from ..Interface import DeviceRegistry, ThirdPartyMessage, ThirdPartyVendor
+
+# The flag byte at 0 and the three identifying bytes at 1, then the
+# application's bytes to the end of the frame.
+VENDOR_SIZE = 4
+
+class FrameThirdParty(FrameBase):
+	'''An application's own message, under its vendor id.'''
+	@staticmethod
+	def construct(mxr:DeviceRegistry, vendor:ThirdPartyVendor, payload:bytes) -> FrameBase|None:
+		'''A message to every device: the vendor's flag byte and three
+		identifying bytes, then payload as it was given.'''
+		data = bytes([int(vendor.flags)]) + vendor.id + bytes(payload)
+		return FrameBase.construct_base(mxr=mxr, opcode=0x55, payload=data)
+
+	@cached_property
+	def message(self) -> ThirdPartyMessage|None:
+		'''The message, whatever its vendor: telling them apart is the
+		application's. None for a payload too short for the vendor id.
+		Everything after the id is the application's, so the length is a
+		minimum and nothing past it is read.'''
+		p = self.payload or b''
+		if (len(p) < VENDOR_SIZE):
+			return None
+		vendor = ThirdPartyVendor(flags=ThirdPartyVendorFlag(p[0]), id=bytes(p[1:VENDOR_SIZE]))
+		return ThirdPartyMessage(vendor=vendor, payload=bytes(p[VENDOR_SIZE:]), address=self.address)
+
+	@override
+	def process(self) -> None:
+		'''Hand the message to the callbacks, as sent by the device it came from.'''
+		if ((message := self.message) is not None) and ((dev := self.remote_device) is not None):
+			dev.callbacks.on_third_party_message(dev, message)
+
+	def __str__(self) -> str:
+		if (self.message is None):
+			return "third-party message <dropped>"
+		return f"third-party message from {self.message}"

mx_remote-9.4.0/mx_remote/proto/FrameThirdParty.pyi

@@ -0,0 +1,15 @@
+from ..Interface import DeviceRegistry as DeviceRegistry, ThirdPartyMessage as ThirdPartyMessage, ThirdPartyVendor as ThirdPartyVendor
+from ..compat import override as override
+from .Constants import ThirdPartyVendorFlag as ThirdPartyVendorFlag
+from .FrameBase import FrameBase as FrameBase
+from functools import cached_property
+
+VENDOR_SIZE: int
+
+class FrameThirdParty(FrameBase):
+    @staticmethod
+    def construct(mxr: DeviceRegistry, vendor: ThirdPartyVendor, payload: bytes) -> FrameBase | None: ...
+    @cached_property
+    def message(self) -> ThirdPartyMessage | None: ...
+    @override
+    def process(self) -> None: ...

{mx_remote-9.2.0 → mx_remote-9.4.0}/mx_remote/proto/FrameV2IPSinkSdp.py

@@ -7,6 +7,7 @@
 '''Protocol frame for V2IP_SINK_SDP (opcode 0x52): what a OneIP output plays
 from a session description, and the commands that hand it one.'''
 
+from dataclasses import dataclass
 from functools import cached_property
 import ipaddress
 import struct
@@ -30,9 +31,11 @@ from ..Uid import MxrDeviceUid
 #
 # A page follows the header with the description's length, the page's offset
 # into it and the page's length, all u16, two reserved bytes, and at most
-# SDP_PAGE_LEN bytes of the description.
+# SDP_PAGE_LEN bytes of the description. An output reports the description it
+# plays in pages of the same shape.
 SDP_HEADER_SIZE = 20
 _STATUS_SIZE = 80
+_PAGE_HEADER_SIZE = 8
 
 SDP_STATUS = 0
 '''The output's report.'''
@@ -44,10 +47,35 @@ SDP_SCREEN = 3
 '''What the output shows while it plays audio alone, in the value byte.'''
 SDP_REQUEST = 4
 '''Report now.'''
+SDP_DESCRIPTION = 5
+'''A page of the description an output reports playing.'''
+
+SDP_REQUEST_DESCRIPTION = (1 << 0)
+'''The bit of a request's value that asks for the description too.'''
+
+SDP_DESCRIPTION_PROTOCOL = 0x31
+'''The first protocol version whose outputs report the description they play.
+Not the stamp: that is the opcode's, and an output between the two answers a
+request for the description with its status alone.'''
+
+SDP_PAGE_TIMEOUT = 5
+'''How long an output may take between two pages of one description, in
+seconds, before the pages it sent are dropped.'''
 
 SDP_PAGE_LEN = 1024
 '''The most bytes of a session description one page carries.'''
 
+@dataclass(frozen=True)
+class SdpDescriptionPage:
+    '''A page of the description an output reports playing.'''
+    total: int
+    '''The length of the whole description.'''
+    offset: int
+    '''Where this page's text starts in it.'''
+    text: bytes
+    timestamp: float
+    '''When the page arrived.'''
+
 def _cstr(data:bytes) -> str:
     return data.split(b'\0', 1)[0].decode('ascii', errors='replace')
 
@@ -109,14 +137,38 @@ class FrameV2IPSinkSdp(FrameBase):
             # that fills its field stops one byte short of it.
             name=_cstr(s[24:71]), layout=_cstr(s[72:79]))
 
+    @cached_property
+    def description_page(self) -> SdpDescriptionPage|None:
+        '''A page of the description the output reports playing, None for
+        another type, for a page whose header names a device other than its
+        sender, which only the output itself reports, and for a frame too short
+        for the text its page header declares.'''
+        p = self.payload or b''
+        if (self.kind != SDP_DESCRIPTION) or (self.target_uid != self.remote_id) \
+                or (len(p) < SDP_HEADER_SIZE + _PAGE_HEADER_SIZE):
+            return None
+        total, offset, length = struct.unpack_from('<HHH', p, SDP_HEADER_SIZE)
+        start = SDP_HEADER_SIZE + _PAGE_HEADER_SIZE
+        if (len(p) < start + length):
+            return None
+        return SdpDescriptionPage(total=total, offset=offset, text=bytes(p[start:start + length]),
+                                  timestamp=self.timestamp)
+
     @override
     def process(self) -> None:
-        '''Record an output's report against the output that sent it. The other
-        types are commands for an output, which only that output acts on.'''
-        if ((status := self.status) is not None) and ((dev := self.remote_device) is not None):
+        '''Record an output's report and the pages of its description against
+        the output that sent them. The other types are commands for an output,
+        which only that output acts on.'''
+        if ((dev := self.remote_device) is None):
+            return
+        if ((status := self.status) is not None):
             dev.on_mxr_update(status)
+        elif ((page := self.description_page) is not None):
+            dev.on_mxr_update(page)
 
     def __str__(self) -> str:
         if (self.status is not None):
             return f"OneIP sink SDP: {self.status}"
+        if ((page := self.description_page) is not None):
+            return f"OneIP sink SDP description: bytes {page.offset} to {page.offset + len(page.text)} of {page.total}"
         return f"OneIP sink SDP command {self.kind} for {self.uid_to_user_string(self.target_uid)}"

{mx_remote-9.2.0 → mx_remote-9.4.0}/mx_remote/proto/FrameV2IPSinkSdp.pyi

@@ -3,6 +3,8 @@ from ..Uid import MxrDeviceUid as MxrDeviceUid
 from ..compat import override as override
 from .Constants import OneIPSdpClockMode as OneIPSdpClockMode, OneIPSdpClockState as OneIPSdpClockState, OneIPSdpEncoding as OneIPSdpEncoding, OneIPSdpFlag as OneIPSdpFlag, OneIPSdpMediaClock as OneIPSdpMediaClock, OneIPSdpRefClock as OneIPSdpRefClock
 from .FrameBase import FrameBase as FrameBase
+from _typeshed import Incomplete
+from dataclasses import dataclass
 from functools import cached_property
 from typing import Any
 
@@ -12,8 +14,19 @@ SDP_PAGE: int
 SDP_STOP: int
 SDP_SCREEN: int
 SDP_REQUEST: int
+SDP_DESCRIPTION: int
+SDP_REQUEST_DESCRIPTION: Incomplete
+SDP_DESCRIPTION_PROTOCOL: int
+SDP_PAGE_TIMEOUT: int
 SDP_PAGE_LEN: int
 
+@dataclass(frozen=True)
+class SdpDescriptionPage:
+    total: int
+    offset: int
+    text: bytes
+    timestamp: float
+
 class FrameV2IPSinkSdp(FrameBase):
     @staticmethod
     def construct_command(mxr: DeviceRegistry, target: Any, target_uid: MxrDeviceUid, kind: int, value: int = 0) -> FrameBase | None: ...
@@ -25,5 +38,7 @@ class FrameV2IPSinkSdp(FrameBase):
     def kind(self) -> int | None: ...
     @cached_property
     def status(self) -> OneIPSinkSdp | None: ...
+    @cached_property
+    def description_page(self) -> SdpDescriptionPage | None: ...
     @override
     def process(self) -> None: ...