mx-remote 9.1.0__tar.gz → 9.3.0__tar.gz

{mx_remote-9.1.0 → mx_remote-9.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mx_remote
-Version: 9.1.0
+Version: 9.3.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.1.0 → mx_remote-9.3.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.1.0 → mx_remote-9.3.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.1.0 → mx_remote-9.3.0}/docs/oneip.md

@@ -225,27 +225,36 @@ goes out at 176 bytes: a receiver with the schedule ignores the settings of a
 shorter frame, and one whose settings end at the idle minutes takes it all the
 same.
 
-How far a device powers down is its power save level: reduced, low or off, each
-powering more down than the one before. Its unit status says which levels it
-supports and what wakes it at each.
+Power save is switched on or off. Switched on, a device powers down by itself
+to its power save level: reduced, low or off, each powering more down than the
+one before. The device picks the level itself, the one that saves the most
+while its input and display can still wake it, and reports it. Its unit status
+says which levels it supports and what wakes it at each.
 
 ```python
 from mx_remote import OneIPPowerSaveLevel, UnitPowerSave
 
-print(settings.power_save_level)
+print(settings.get(OneIPDeviceSetting.POWER_SAVE_DISABLED))         # False: switched on
+print(settings.power_save_level)                                    # the level it picked
 print(device.unit_status.power_save_level(OneIPPowerSaveLevel.LOW))  # e.g. SUPPORTED|INPUT_WAKE
 
-await device.set_oneip_power_save_level(OneIPPowerSaveLevel.LOW)
+await device.set_oneip_power_save(True)
+await mx.set_all_oneip_power_save(False)   # every OneIP device of the mesh
 ```
 
-A level this library does not name is refused before it is sent, and not cached
-from another controller's write.
-
-`OneIPDeviceSetting.POWER_SAVE_DISABLED` is a switch that keeps a device from
-powering down by itself; a power save request still powers it down. A device
-that takes a power save level switches it off, so a level write, this client's
-or another sender's, clears it unless the same frame states it. Firmware
-without the bit never reports it, and the switch is refused there.
+Switched off, `OneIPDeviceSetting.POWER_SAVE_DISABLED` is on: the device does
+not power down by itself, and a power save request still powers it down.
+Switching on is written as a mesh controller writes it, with that switch clear
+and the power save level at 0, so a device whose firmware still takes the level
+as its setting returns to its own default.
+
+`set_oneip_power_save_level()` writes a level, which switches power save on. A
+current device ignores the level; one whose firmware predates picking it takes
+it. A written level is never cached, from this client or another controller:
+`power_save_level` is what the device reports. A level write without the switch
+only clears `POWER_SAVE_DISABLED` on a device that reports it. A level this
+library does not name is refused before it is sent. Firmware without the switch
+never reports it, and switching is refused there.
 
 `OneIPDeviceSetting.CLOUD` is a switch for whether a device connects to the
 cloud service. A device that does not report it connects regardless, and the

{mx_remote-9.1.0 → mx_remote-9.3.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."""
@@ -2712,6 +2774,16 @@ class OneIPDeviceSettings:
         self._power_save_level = int(power_save_level)
         self._ptp_messages = ptp_messages if (ptp_messages is not None) else OneIPPtpMessages()
 
+    @classmethod
+    def power_save_switch(cls, enabled:bool) -> 'OneIPDeviceSettings':
+        """The settings that switch a device's power save on or off. On is both
+        POWER_SAVE_DISABLED, clear, and POWER_SAVE_LEVEL, at 0."""
+        disabled = OneIPDeviceSetting.POWER_SAVE_DISABLED
+        if enabled:
+            return cls(valid=(disabled | OneIPDeviceSetting.POWER_SAVE_LEVEL),
+                       power_save_level=OneIPPowerSaveLevel.NONE)
+        return cls(valid=disabled, flags=disabled)
+
     @property
     def valid(self) -> OneIPDeviceSetting:
         """The settings reported so far."""
@@ -2791,8 +2863,9 @@ class OneIPDeviceSettings:
 
     @property
     def power_save_level(self) -> OneIPPowerSaveLevel|int|None:
-        """The level the device powers down to in power save, a raw int for one
-        this library does not name, None while it is not reported."""
+        """The level the device powers down to in power save, which it picks
+        itself, a raw int for one this library does not name, None while it is
+        not reported."""
         if (OneIPDeviceSetting.POWER_SAVE_LEVEL not in self._valid):
             return None
         return _wire_enum(OneIPPowerSaveLevel, self._power_save_level)
@@ -2812,18 +2885,14 @@ class OneIPDeviceSettings:
 
         Each bit in this block's ``valid`` replaces its own setting and leaves
         the others alone, so a write about one setting does not clear what was
-        known about the rest. The exception is POWER_SAVE_DISABLED: a device
-        takes a power save level as switching it off.
+        known about the rest.
         """
         if (previous is None):
             previous = OneIPDeviceSettings()
         valid = self._valid
-        flags = (previous._flags & ~valid) | (self._flags & valid)
-        if (OneIPDeviceSetting.POWER_SAVE_LEVEL in valid) and (OneIPDeviceSetting.POWER_SAVE_DISABLED not in valid):
-            flags &= ~OneIPDeviceSetting.POWER_SAVE_DISABLED
         return OneIPDeviceSettings(
             valid=(previous._valid | valid),
-            flags=flags,
+            flags=((previous._flags & ~valid) | (self._flags & valid)),
             ir_profiles=(self._ir_profiles if (OneIPDeviceSetting.IR_PROFILES in valid)
                          else previous._ir_profiles),
             ir_profile=(self._ir_profile if (OneIPDeviceSetting.IR_PROFILE in valid)
@@ -2850,9 +2919,11 @@ class OneIPDeviceSettings:
         write about it.
 
         A device applies a setting only if it has it, a profile, PTP mode, PTP
-        domain, power save level or PTP DSCP only within its range, a stream
-        TTL only when it is not 0, a rotation only by its own step, and never
-        what only it can report about itself. The step stays the device's.
+        domain or PTP DSCP only within its range, a stream TTL only when it is
+        not 0, a rotation only by its own step, and never what only it can
+        report about itself. The step stays the device's. It picks its power
+        save level itself, and takes a level it is written, without
+        POWER_SAVE_DISABLED, as switching power save on.
 
         reported may be only the bits the device reported, which says nothing
         of its step, so a rotation other than 0 is then left out.
@@ -2871,15 +2942,20 @@ class OneIPDeviceSettings:
             valid &= ~OneIPDeviceSetting.PTP_MODE
         if (self._ptp_domain > ONEIP_PTP_DOMAIN_MAX):
             valid &= ~OneIPDeviceSetting.PTP_DOMAIN
-        if (self._power_save_level > OneIPPowerSaveLevel.OFF):
-            valid &= ~OneIPDeviceSetting.POWER_SAVE_LEVEL
         if (self._ptp_messages.dscp > ONEIP_DSCP_MAX):
             valid &= ~OneIPDeviceSetting.PTP_DSCP
         if (self._ptp_messages.stream_ttl == 0):
             valid &= ~OneIPDeviceSetting.STREAM_TTL
         if not own.takes_sink_rotation(self._ptp_messages.sink_rotation):
             valid &= ~OneIPDeviceSetting.SINK_ROTATION
-        return OneIPDeviceSettings(valid=valid, flags=self._flags, ir_profiles=self._ir_profiles,
+        flags = self._flags
+        if (OneIPDeviceSetting.POWER_SAVE_LEVEL in valid):
+            valid &= ~OneIPDeviceSetting.POWER_SAVE_LEVEL
+            if (OneIPDeviceSetting.POWER_SAVE_DISABLED not in valid) \
+                    and (OneIPDeviceSetting.POWER_SAVE_DISABLED in reported._valid):
+                valid |= OneIPDeviceSetting.POWER_SAVE_DISABLED
+                flags &= ~OneIPDeviceSetting.POWER_SAVE_DISABLED
+        return OneIPDeviceSettings(valid=valid, flags=flags, ir_profiles=self._ir_profiles,
                                   ir_profile=self._ir_profile, ir_profile_sink=self._ir_profile_sink,
                                   auto_power_save=self._auto_power_save, power_save=self._power_save,
                                   ptp_mode=self._ptp_mode, ptp_domain=self._ptp_domain,
@@ -3572,9 +3648,13 @@ class DeviceBase(ABC):
     async def set_oneip_ptp_priority1(self, priority1:int) -> bool:
         '''set the priority1 the device announces as a PTP grandmaster'''
 
+    @abstractmethod
+    async def set_oneip_power_save(self, enabled:bool) -> bool:
+        '''switch power save on, so the device powers down by itself to the level it picks, or off'''
+
     @abstractmethod
     async def set_oneip_power_save_level(self, level:OneIPPowerSaveLevel) -> bool:
-        '''set the level the device powers down to in power save'''
+        '''write the level the device powers down to in power save, which switches power save on'''
 
     @abstractmethod
     async def set_oneip_ptp_messages(self, which:OneIPDeviceSetting, messages:OneIPPtpMessages) -> bool:
@@ -4352,6 +4432,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.1.0 → mx_remote-9.3.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 = ...
@@ -962,6 +979,8 @@ class OneIPTestcard:
 
 class OneIPDeviceSettings:
     def __init__(self, valid: OneIPDeviceSetting = ..., flags: OneIPDeviceSetting = ..., ir_profiles: int = 0, ir_profile: int = 0, ir_profile_sink: int = 0, auto_power_save: int = 0, power_save: OneIPPowerSaveSchedule | None = None, ptp_mode: OneIPPtpMode | int = ..., ptp_domain: int = 0, ptp_priority1: int = 0, power_save_level: OneIPPowerSaveLevel | int = ..., ptp_messages: OneIPPtpMessages | None = None) -> None: ...
+    @classmethod
+    def power_save_switch(cls, enabled: bool) -> OneIPDeviceSettings: ...
     @property
     def valid(self) -> OneIPDeviceSetting: ...
     @property
@@ -1330,6 +1349,8 @@ class DeviceBase(ABC):
     @abstractmethod
     async def set_oneip_ptp_priority1(self, priority1: int) -> bool: ...
     @abstractmethod
+    async def set_oneip_power_save(self, enabled: bool) -> bool: ...
+    @abstractmethod
     async def set_oneip_power_save_level(self, level: OneIPPowerSaveLevel) -> bool: ...
     @abstractmethod
     async def set_oneip_ptp_messages(self, which: OneIPDeviceSetting, messages: OneIPPtpMessages) -> bool: ...
@@ -1616,3 +1637,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.1.0 → mx_remote-9.3.0}/mx_remote/const.py

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

{mx_remote-9.1.0 → mx_remote-9.3.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
@@ -349,7 +352,11 @@ class OneIPDeviceSetting(IntFlag):
 	AES67              = (1 << 17)
 	'''Sends the source's audio as an AES67 flow, where the source allows.'''
 	POWER_SAVE_LEVEL   = (1 << 18)
-	'''The power save level the device powers down to.'''
+	'''The level the device powers down to in power save. A device picks it
+	itself: the level that saves the most while its input and display can
+	still wake it. Written without POWER_SAVE_DISABLED, it switches power save
+	on, and the level written is ignored, except by a device whose firmware
+	predates picking it, which takes the level as its setting.'''
 	PTP_ANNOUNCE       = (1 << 19)
 	'''The interval between the device's PTP announce messages.'''
 	PTP_SYNC           = (1 << 20)
@@ -818,6 +825,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.1.0 → mx_remote-9.3.0}/mx_remote/proto/Constants.pyi

@@ -340,6 +340,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.1.0 → mx_remote-9.3.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.3.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.3.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.1.0 → mx_remote-9.3.0}/mx_remote/remote/Device.py

@@ -76,7 +76,6 @@ from typing import Any, Callable
 from ..compat import override
 from datetime import datetime
 from enum import Enum
-import dataclasses
 import logging
 import time
 
@@ -1572,12 +1571,28 @@ class Device(DeviceBase):
 		return self._send_v2ip_settings(OneIPDeviceSettings(
 			valid=OneIPDeviceSetting.PTP_PRIORITY1, ptp_priority1=priority1))
 
-	async def set_oneip_power_save_level(self, level:OneIPPowerSaveLevel) -> bool:
-		'''Set the level this OneIP device powers down to in power save.
+	async def set_oneip_power_save(self, enabled:bool) -> bool:
+		'''Switch this OneIP device's power save on, so it powers down by itself
+		to the level it picks, or off, so it powers down only when asked.
 
-		A level this library does not name is refused, since a device ignores it.
-		One the unit does not offer is one its unit_status reports without
-		UnitPowerSave.SUPPORTED. The terms of set_oneip_setting() apply.
+		On is written as a mesh controller writes it: both POWER_SAVE_DISABLED,
+		clear, and POWER_SAVE_LEVEL, at 0, so a device whose firmware takes the
+		level as its setting returns to its own default. The terms of
+		set_oneip_setting() apply.
+		'''
+		return self._send_v2ip_settings(OneIPDeviceSettings.power_save_switch(enabled))
+
+	async def set_oneip_power_save_level(self, level:OneIPPowerSaveLevel) -> bool:
+		'''Write the level this OneIP device powers down to in power save, which
+		switches power save on.
+
+		A device picks its level itself and ignores the one written, except one
+		whose firmware predates picking it, which takes the level as its
+		setting. A level that unit does not offer is one its unit_status
+		reports without UnitPowerSave.SUPPORTED. A level this library does not
+		name is refused. The level is not cached: oneip_settings reads what the
+		device reports. set_oneip_power_save() switches power save on or off
+		without naming a level. The terms of set_oneip_setting() apply.
 		'''
 		if not (OneIPPowerSaveLevel.NONE <= level <= OneIPPowerSaveLevel.OFF):
 			_LOGGER.warning(f"not setting power save level {level} on {self}: no such level")
@@ -1612,7 +1627,6 @@ class Device(DeviceBase):
 				_LOGGER.warning(f"not turning the output of {self} by {messages.sink_rotation} degrees: "
 				                f"it turns by steps of {own.sink_rotation_step}")
 				return False
-			messages = dataclasses.replace(messages, sink_rotation_step=own.sink_rotation_step)
 		return self._send_v2ip_settings(OneIPDeviceSettings(valid=which, ptp_messages=messages))
 
 	def _on_oneip_downmix(self, downmix:OneIPDownmix|None, reported:bool) -> None:
@@ -1932,7 +1946,7 @@ class Device(DeviceBase):
 			return False
 		if self.registry.transmit(frame.frame) != len(frame.frame):
 			return False
-		self._merge_v2ip_settings(settings)
+		self._merge_v2ip_settings(settings.as_applied_to(reported))
 		return True
 
 	@property

{mx_remote-9.1.0 → mx_remote-9.3.0}/mx_remote/remote/Device.pyi

@@ -270,6 +270,7 @@ class Device(DeviceBase):
     async def set_oneip_ptp_mode(self, mode: OneIPPtpMode) -> bool: ...
     async def set_oneip_ptp_domain(self, domain: int) -> bool: ...
     async def set_oneip_ptp_priority1(self, priority1: int) -> bool: ...
+    async def set_oneip_power_save(self, enabled: bool) -> bool: ...
     async def set_oneip_power_save_level(self, level: OneIPPowerSaveLevel) -> bool: ...
     async def set_oneip_ptp_messages(self, which: OneIPDeviceSetting, messages: OneIPPtpMessages) -> bool: ...
     async def set_oneip_downmix(self, downmix: OneIPDownmix) -> bool: ...

{mx_remote-9.1.0 → mx_remote-9.3.0}/mx_remote/remote/Remote.py

@@ -22,12 +22,13 @@ from datetime import datetime, timezone
 from .ConnectionAsync import ConnectionAsync
 from ..const import MXR_HELLO_INTERVAL_MIN, MXR_HELLO_INTERVAL_RAND, __version__
 from .Device import Device
-from ..Interface import ConnectionCallbacks, DeviceRegistry, MxrDeviceUid, BayLinks, BayBase, DeviceBase, MxrCallbacks, AudioEndpoint, mxr_broadcast_address, OneIPDeviceSettings, OneIPPowerSaveSchedule, OneIPPtpMessages, OsdSyncContent, OsdSyncRequest
-from ..proto.Constants import MXR_PROTOCOL_VERSION, DeviceFeature, OsdSyncWhat
+from ..Interface import ConnectionCallbacks, DeviceRegistry, MxrDeviceUid, BayLinks, BayBase, DeviceBase, MxrCallbacks, AudioEndpoint, mxr_broadcast_address, OneIPDeviceSettings, OneIPPowerSaveSchedule, OneIPPtpMessages, OsdSyncContent, OsdSyncRequest, ThirdPartyVendor
+from ..proto.Constants import MXR_PROTOCOL_VERSION, THIRD_PARTY_PAYLOAD_MAX, DeviceFeature, OsdSyncWhat
 from ..proto.FrameDiscover import FrameDiscover, constructFrameDiscover
 from ..proto.Factory import process_mxr_frame
 from ..proto.FrameHello import FrameHello, constructFrameHello
 from ..proto.FramePing import FramePing
+from ..proto.FrameThirdParty import FrameThirdParty
 from ..proto.FrameBase import FrameBase
 from ..proto.FrameTime import FrameTime
 from ..proto.FrameTimeZone import FrameTimeZone
@@ -561,12 +562,35 @@ class Remote(DeviceRegistry, ConnectionCallbacks):
             return False
         return self._send_to_all(FrameV2IPSettingsAll.construct(mxr=self, settings=settings))
 
+    async def set_all_oneip_power_save(self, enabled:bool) -> bool:
+        '''Switch power save on or off on every OneIP device of the mesh with
+        one frame, written as Device.set_oneip_power_save() writes it.
+        Otherwise as set_all_oneip_device_settings().'''
+        return await self.set_all_oneip_device_settings(OneIPDeviceSettings.power_save_switch(enabled))
+
     async def request_all_oneip_privacy(self) -> bool:
         '''Ask every OneIP source unit of the mesh how its streams are
         encrypted, as Device.request_oneip_privacy() asks one. A unit below
         protocol 0x30 ignores it.'''
         return self._send_to_all(FrameV2IPPrivacy.construct_request(mxr=self, target=None, target_uid=None))
 
+    async def send_third_party(self, vendor:ThirdPartyVendor, payload:bytes) -> bool:
+        '''Send an application's own message to every device, under vendor.
+        True when all of it was written.
+
+        Every other client of this library that has heard this one announce
+        itself receives it at MxrCallbacks.on_third_party_message(); this client
+        does not, and neither does one sharing its uid. No unit is meant to read
+        it. Nothing acknowledges it, so an application that needs to know it
+        arrived has to have its peers answer.
+
+        A payload over THIRD_PARTY_PAYLOAD_MAX bytes is refused.'''
+        if (len(payload) > THIRD_PARTY_PAYLOAD_MAX):
+            _LOGGER.warning(f"not sending a third-party message: {len(payload)} bytes, "
+                            f"the most is {THIRD_PARTY_PAYLOAD_MAX}")
+            return False
+        return self._send_to_all(FrameThirdParty.construct(mxr=self, vendor=vendor, payload=payload))
+
     async def set_mesh_time_zone(self, zone:str, rule:str) -> bool:
         '''Set the time zone of every device that hears it.