mx-remote 6.0.0__tar.gz → 6.2.0__tar.gz

{mx_remote-6.0.0 → mx_remote-6.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mx_remote
-Version: 6.0.0
+Version: 6.2.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-6.0.0 → mx_remote-6.2.0}/docs/oneip.md

@@ -308,6 +308,7 @@ itself, a profile out of range, or a schedule time that is not a time of day.
 # mesh operations
 await device.mesh_promote()   # promote to mesh master
 await device.mesh_remove()    # remove from mesh
+await source.auto_assign_oneip_source_addresses()  # drop addresses set by hand
 
 # firmware versions
 if device.oneip_firmware_versions:
@@ -315,6 +316,12 @@ if device.oneip_firmware_versions:
         print(f"{fw_type}: {fw.version}")
 ```
 
+A OneIP source acts on `auto_assign_oneip_source_addresses()` only from
+management, which this client announces itself as, and nothing acknowledges it:
+the source's next configuration report carries the addresses it ends up with, in
+`oneip_details`. A device that is not a source, or announces less than protocol
+0x2B, would ignore the operation, so it is refused before anything is sent.
+
 ### Time zone and time
 
 The mesh controller announces its time zone and clock with every periodic

{mx_remote-6.0.0 → mx_remote-6.2.0}/mx_remote/Interface.py

@@ -2804,6 +2804,10 @@ class DeviceBase(ABC):
     async def mesh_promote(self) -> bool:
         '''promote to mesh master'''
 
+    @abstractmethod
+    async def auto_assign_oneip_source_addresses(self) -> bool:
+        '''hand this OneIP source's stream addresses back to automatic assignment'''
+
     @abstractmethod
     async def mesh_remove(self) -> bool:
         '''remove from mesh'''

{mx_remote-6.0.0 → mx_remote-6.2.0}/mx_remote/Interface.pyi

@@ -1059,6 +1059,8 @@ class DeviceBase(ABC):
     @abstractmethod
     async def mesh_promote(self) -> bool: ...
     @abstractmethod
+    async def auto_assign_oneip_source_addresses(self) -> bool: ...
+    @abstractmethod
     async def mesh_remove(self) -> bool: ...
     @abstractmethod
     async def read_stats(self, enable: bool) -> bool: ...

{mx_remote-6.0.0 → mx_remote-6.2.0}/mx_remote/const.py

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

{mx_remote-6.0.0 → mx_remote-6.2.0}/mx_remote/proto/FrameMeshOperation.py

@@ -22,6 +22,8 @@ class MeshOperation(IntEnum):
     REGENERATE_ADDRESSES = 3
     REPORT_CONTROLLER = 4
     PROMOTE_CONTROLLER = 5
+    AUTO_ADDRESSES = 6
+    '''Hand the target's source addresses back to automatic assignment.'''
     REPORT_MEMBERSHIP = 0xFF
 
     def __str__(self) -> str:
@@ -37,6 +39,8 @@ class MeshOperation(IntEnum):
             return "report controller"
         if self.value == MeshOperation.PROMOTE_CONTROLLER.value:
             return "promote controller"
+        if self.value == MeshOperation.AUTO_ADDRESSES.value:
+            return "automatic addresses"
         if self.value == MeshOperation.REPORT_MEMBERSHIP.value:
             return "report membership"
         return "unknown"
@@ -66,6 +70,13 @@ _WIRE_SIZE = 40
 _ACCEPT_PROTOCOL = 0x1A
 _INSTALLER_PROTOCOL = 0x1D
 
+AUTO_ADDRESSES_PROTOCOL = 0x2B
+'''The first protocol version whose devices can act on AUTO_ADDRESSES.
+
+Not the stamp: that is this opcode's, and a device between the two takes the
+frame and ignores an operation it does not know. Not every device on this
+version has it either, but none below it does.'''
+
 class FrameMeshOperation(FrameBase):
     ''' Mesh operation '''
 

{mx_remote-6.0.0 → mx_remote-6.2.0}/mx_remote/proto/FrameMeshOperation.pyi

@@ -11,8 +11,11 @@ class MeshOperation(IntEnum):
     REGENERATE_ADDRESSES: int
     REPORT_CONTROLLER: int
     PROMOTE_CONTROLLER: int
+    AUTO_ADDRESSES: int
     REPORT_MEMBERSHIP: int
 
+AUTO_ADDRESSES_PROTOCOL: int
+
 class FrameMeshOperation(FrameBase):
     @staticmethod
     def construct(mxr: DeviceRegistry, operation: MeshOperation, target: DeviceBase, option: DeviceBase | None = None) -> FrameBase | None: ...

{mx_remote-6.0.0 → mx_remote-6.2.0}/mx_remote/remote/Device.py

@@ -35,7 +35,7 @@ from ..Interface import (
 )
 from ..proto.BayConfig import BayConfig
 from ..proto.FrameHello import FrameHello
-from ..proto.FrameMeshOperation import MeshOperation, FrameMeshOperation
+from ..proto.FrameMeshOperation import AUTO_ADDRESSES_PROTOCOL, MeshOperation, FrameMeshOperation
 from ..proto.FrameV2IPStats import FrameV2IPStats
 from ..proto.FrameNetworkStatus import NetworkPortStatus
 from ..proto.FrameReboot import FrameReboot
@@ -1057,6 +1057,30 @@ class Device(DeviceBase):
 			return True
 		return False
 
+	async def auto_assign_oneip_source_addresses(self) -> bool:
+		'''Hand this OneIP source's stream addresses back to automatic assignment,
+		undoing addresses that were set on it by hand.
+
+		The device takes this only from management, which this client announces
+		itself as. Nothing acknowledges it: the device's next configuration
+		report carries the addresses it ends up with, and oneip_details reads
+		them.
+
+		Refused for a device that is not a OneIP source, and for one below
+		protocol 0x2B, which predates the operation and ignores it.
+		'''
+		if (self.features is None) or (DeviceFeature.ONEIP_SOURCE not in self.features):
+			_LOGGER.warning(f"not handing the addresses of {self} back to automatic assignment: it is not a OneIP source")
+			return False
+		if (self.protocol != 0) and (self.protocol < AUTO_ADDRESSES_PROTOCOL):
+			_LOGGER.warning(f"not handing the addresses of {self} back to automatic assignment: it advertises "
+			                f"protocol {self.protocol:02X} and the operation needs {AUTO_ADDRESSES_PROTOCOL:02X}")
+			return False
+		frame = FrameMeshOperation.construct(mxr=self.registry, target=self, operation=MeshOperation.AUTO_ADDRESSES)
+		if (frame is None):
+			return False
+		return self.registry.transmit(frame.frame) == len(frame.frame)
+
 	async def mesh_remove(self) -> bool:
 		'''Remove this device from the mesh network.'''
 		frame = FrameMeshOperation.construct(mxr=self.registry, target=self, operation=MeshOperation.UNREGISTER)

{mx_remote-6.0.0 → mx_remote-6.2.0}/mx_remote/remote/Device.pyi

@@ -7,7 +7,7 @@ from ..proto.Constants import DeviceFeature as DeviceFeature, MXR_PROTOCOL_VERSI
 from ..proto.FrameBase import FrameBase as FrameBase
 from ..proto.FrameFirmwareVersion import FirmwareType as FirmwareType, FirmwareVersion as FirmwareVersion
 from ..proto.FrameHello import FrameHello as FrameHello
-from ..proto.FrameMeshOperation import FrameMeshOperation as FrameMeshOperation, MeshOperation as MeshOperation
+from ..proto.FrameMeshOperation import AUTO_ADDRESSES_PROTOCOL as AUTO_ADDRESSES_PROTOCOL, FrameMeshOperation as FrameMeshOperation, MeshOperation as MeshOperation
 from ..proto.FrameNetworkStatus import NetworkPortStatus as NetworkPortStatus
 from ..proto.FramePing import FramePing as FramePing
 from ..proto.FrameReboot import FrameReboot as FrameReboot
@@ -223,6 +223,7 @@ class Device(DeviceBase):
     async def reboot(self) -> bool: ...
     async def ping(self) -> bool: ...
     async def mesh_promote(self) -> bool: ...
+    async def auto_assign_oneip_source_addresses(self) -> bool: ...
     async def mesh_remove(self) -> bool: ...
     async def read_stats(self, enable: bool) -> bool: ...
     async def set_oneip_auto_scaling(self, enabled: bool) -> bool: ...

{mx_remote-6.0.0 → mx_remote-6.2.0}/tests/mesh.py

@@ -20,6 +20,7 @@ import mx_remote
 from mx_remote import MxrDeviceUid, OneIPDeviceSetting as S, OneIPDeviceSettings, OneIPPowerSaveSchedule
 from mx_remote.proto.Constants import (ONEIP_IR_PROFILE_MAX, ONEIP_IR_PROFILE_NOT_SET,
                                        ONEIP_MINUTES_PER_DAY)
+from mx_remote.proto.Constants import MXR_OPCODE_VERSIONS
 from mx_remote.proto.Factory import create_mxr_frame
 
 ADDR = ('192.0.2.9', 8812)
@@ -165,4 +166,41 @@ for ok in (OneIPDeviceSettings(valid=S.IR_PROFILE, ir_profile=ONEIP_IR_PROFILE_M
     assert call(mx.set_all_oneip_device_settings(ok)) is True, f'{ok} was refused'
 print('all refused : what every device would ignore is not sent')
 
+# -------------------------------------------- a source's automatic addresses
+
+# Mesh operation 6 names the source, with the parameter and padding zero, and
+# is stamped as every mesh operation is.
+def device(uid, protocol, features, serial):
+    rx_from(uid, 0x00, struct.pack('<H', protocol) + name('OneIP') + name(serial) + name('5.0.0')
+                       + struct.pack('<I', int(features)), protocol=protocol)
+    return mx.get_by_uid(MxrDeviceUid(uid))
+
+def rx_from(uid, opcode, payload, protocol):
+    frame = bytearray(create_mxr_frame(uid, opcode, payload))
+    frame[2] = protocol
+    mx.process_frame(time.time(), bytes(frame), ADDR)
+
+SOURCE = mx_remote.DeviceFeature.ONEIP_SOURCE
+src = device(bytes([0x50]) * 16, 0x2B, SOURCE, 'AA0001')
+old = device(bytes([0x51]) * 16, 0x2A, SOURCE, 'AA0002')
+sink_only = device(bytes([0x52]) * 16, 0x2B, mx_remote.DeviceFeature.ONEIP_SINK, 'AA0003')
+
+sent.clear()
+assert call(src.auto_assign_oneip_source_addresses()) is True
+frame = sent.pop()
+assert opcode(frame) == 0x3B and frame[2] == MXR_OPCODE_VERSIONS[0x3B], (opcode(frame), frame[2])
+p = frame[24:]
+assert len(p) == 40, 'a receiver drops a mesh operation shorter than 40 bytes'
+assert p[:4] == bytes([6, 0, 0, 0]), p[:4].hex()
+assert p[4:20] == bytes([0x50]) * 16, 'the frame names another device'
+assert p[20:] == bytes(20), 'the parameter and padding'
+
+refused(old.auto_assign_oneip_source_addresses(), 'a source below 0x2B, which ignores the operation')
+refused(sink_only.auto_assign_oneip_source_addresses(), 'a device that is not a source')
+
+mx.transmit = lambda data: 0
+assert call(src.auto_assign_oneip_source_addresses()) is False, 'a failed send reported success'
+mx.transmit = lambda data: (sent.append(data), len(data))[1]
+print('auto addrs  : mesh operation 6 to a source on 0x2B; anything else is refused')
+
 print('ALL OK')