mx-remote 8.0.2__tar.gz → 9.0.0__tar.gz

{mx_remote-8.0.2 → mx_remote-9.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mx_remote
-Version: 8.0.2
+Version: 9.0.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-8.0.2 → mx_remote-9.0.0}/docs/api.md

@@ -85,6 +85,23 @@ place, backgrounds and logo images.
 .. autodata:: mx_remote.proto.Constants.OSD_SYNC_PERCENT_MAX
 ```
 
+## Overlay messages
+
+The message on a unit's output, which the overlay sync opcode carries too.
+
+```{eval-rst}
+.. autoclass:: mx_remote.OsdMessage
+   :members:
+
+.. autoclass:: mx_remote.proto.Constants.OsdMessageFlag
+   :members:
+
+.. autoclass:: mx_remote.proto.Constants.OsdMessagePriority
+   :members:
+
+.. autodata:: mx_remote.proto.Constants.OSD_MESSAGE_TEXT_MAX
+```
+
 ## Device identity
 
 ```{eval-rst}
@@ -180,6 +197,8 @@ state only the device reports.
 
 .. autodata:: mx_remote.proto.Constants.ONEIP_STREAM_TTL_DEFAULT
 
+.. autodata:: mx_remote.proto.Constants.ONEIP_SINK_ROTATION_MAX
+
 .. autodata:: mx_remote.proto.Constants.ONEIP_PTP_DOMAIN_MAX
 ```
 
@@ -240,6 +259,18 @@ What an output plays from a session description, and how it is timed.
 .. autodata:: mx_remote.proto.Constants.ONEIP_SDP_MAX
 ```
 
+## OneIP stream encryption
+
+How a source unit encrypts its streams, as it reports it.
+
+```{eval-rst}
+.. autoclass:: mx_remote.OneIPPrivacy
+   :members:
+
+.. autoclass:: mx_remote.OneIPPrivacyStream
+   :members:
+```
+
 ## OneIP test card
 
 A sink's test pattern, tone and lip-sync flash, and the ranges it accepts.

{mx_remote-8.0.2 → mx_remote-9.0.0}/docs/oneip.md

@@ -247,6 +247,10 @@ 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.
 
+`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
+switch is refused there.
+
 ### PTP
 
 A device's PTP mode, domain and grandmaster priority1 are settings like the
@@ -284,10 +288,23 @@ same block, behind `SAP_EXPIRE` and `SAP_INTERVAL`, and are set the same way;
 `SAP_LISTEN` and `SAP_ANNOUNCE` are switches like the other on/off settings.
 A device with an encoder reports its streams' TTL there too, behind
 `STREAM_TTL`; a TTL of 0 is refused, as a device changes nothing for one.
+A device with an HDMI output reports the angle its output is turned by,
+clockwise, behind `SINK_ROTATION`, with the step its video processor turns by.
+It takes 0 or a multiple of that step up to `ONEIP_SINK_ROTATION_MAX`, so any
+other angle is refused before it is sent, and the step is never written.
+`set_all_oneip_device_settings` can only check the range; each device judges
+the step.
+
+```python
+m = settings.ptp_messages
+print(m.sink_rotation, m.sink_rotation_step)   # e.g. 0 and 90
+await device.set_oneip_ptp_messages(OneIPDeviceSetting.SINK_ROTATION,
+                                    OneIPPtpMessages(sink_rotation=180))
+```
 
 Only the values behind the bits named are sent. A DSCP above `ONEIP_DSCP_MAX` is
 refused, and not cached from another controller's write. A write carrying one of
-these runs on to 224 bytes, or 232 with the TTL; every other write keeps the 176
+these runs on to 224 bytes, or 232 with the TTL or the rotation; every other write keeps the 176
 every device knows.
 
 What the device's clock is actually doing is its PTP state, which only the
@@ -412,6 +429,47 @@ save then takes this content rather than the controller's. Logo images are
 served over HTTP from this client, on `logo_port` or a free port. Content a unit
 would refuse is refused before anything is sent; see `send_osd_sync`.
 
+### Overlay messages
+
+A unit shows a message on its output, over the picture, until it restarts. The
+text is markup of at most `OSD_MESSAGE_TEXT_MAX` bytes with no control
+character, shown with a logo: 0 the built-in one, -1 none, 1 to 5 a slot. Its
+priority places it against the unit's own messages, such as Locate Device.
+
+```python
+from mx_remote.proto.Constants import OsdMessagePriority
+
+await sink.show_osd_message('Back at <b>3</b>', logo=-1, priority=OsdMessagePriority.TOP)
+await sink.request_osd_message()   # the unit answers with what it shows
+await sink.clear_osd_message()
+
+print(sink.osd_message)   # None until the unit has answered
+```
+
+A unit takes a message only from management, which this client announces
+itself as, and answers every write and request with the message it then has;
+`on_osd_message_changed` reports a change. The answer carries
+`OsdMessageFlag.REFUSED` when the unit did not take the write, as when its
+video processor has no message layer. A text, logo or priority a unit would
+refuse is refused before it is sent, as is a device that is not a OneIP output.
+
+### Stream encryption
+
+A source unit from protocol 0x30 encrypts its video, audio and ancillary
+streams, and reports what a receiver needs to decrypt them whenever that
+changes and at least once a minute. The key itself never travels: every unit of
+a mesh holds the same one, and this library holds none.
+
+```python
+await source.request_oneip_privacy()    # report now
+await mx.request_all_oneip_privacy()    # every source unit of the mesh
+
+print(source.oneip_privacy)   # None until the unit has reported
+```
+
+A request to a unit that is not a source, or that is below protocol 0x30, is
+refused before it is sent.
+
 ### Every device at once
 
 One broadcast changes settings on every OneIP device of the mesh. Each device

{mx_remote-8.0.2 → mx_remote-9.0.0}/mx_remote/Interface.py

@@ -6,7 +6,7 @@
 ######################################################
 
 from abc import ABC, abstractmethod
-from dataclasses import dataclass
+from dataclasses import dataclass, replace
 from datetime import datetime, timezone
 from enum import IntEnum
 import time
@@ -2215,8 +2215,8 @@ def _wire_enum(cls:Any, value:int) -> Any:
 @dataclass(frozen=True)
 class OneIPPtpMessages:
     """
-    How a OneIP device paces its PTP messages, its SAP timings and its streams'
-    TTL, which a frame carries in the same block. Each value is behind its own bit of
+    How a OneIP device paces its PTP messages, its SAP timings, its streams'
+    TTL and its output's rotation, which a frame carries in the same block. Each value is behind its own bit of
     OneIPDeviceSettings.valid, one of ONEIP_DEVICE_SETTINGS_BLOCK.
 
     Intervals are base-2 logarithms of seconds, so -3 is 125 ms and 1 is 2 s.
@@ -2241,6 +2241,19 @@ class OneIPPtpMessages:
     """The TTL of the device's streams, 1 to 255, behind STREAM_TTL. A device
     whose video processor cannot change it keeps the setting and sends
     ONEIP_STREAM_TTL_DEFAULT."""
+    sink_rotation: int = 0
+    """The degrees the device's HDMI output is turned by, clockwise, at most
+    ONEIP_SINK_ROTATION_MAX, behind SINK_ROTATION."""
+    sink_rotation_step: int = 0
+    """The step the output turns by: the device takes only an angle that is a
+    multiple of it, and 0 alone when it is 0. Only the device reports it,
+    behind the same bit."""
+
+    def takes_sink_rotation(self, degrees:int) -> bool:
+        """Whether a device reporting this step takes degrees as its output's
+        rotation."""
+        return (degrees == 0) or ((0 < degrees <= ONEIP_SINK_ROTATION_MAX) and (self.sink_rotation_step != 0)
+                                  and (degrees % self.sink_rotation_step == 0))
 
     def merge(self, other:'OneIPPtpMessages', which:OneIPDeviceSetting) -> 'OneIPPtpMessages':
         """The values behind the bits of which copied from other, the rest kept."""
@@ -2253,7 +2266,9 @@ class OneIPPtpMessages:
             dscp=(other if (S.PTP_DSCP in which) else self).dscp,
             sap_expire_min=(other if (S.SAP_EXPIRE in which) else self).sap_expire_min,
             sap_interval_s=(other if (S.SAP_INTERVAL in which) else self).sap_interval_s,
-            stream_ttl=(other if (S.STREAM_TTL in which) else self).stream_ttl)
+            stream_ttl=(other if (S.STREAM_TTL in which) else self).stream_ttl,
+            sink_rotation=(other if (S.SINK_ROTATION in which) else self).sink_rotation,
+            sink_rotation_step=(other if (S.SINK_ROTATION in which) else self).sink_rotation_step)
 
     def describe(self, valid:OneIPDeviceSetting) -> list[str]:
         """The values behind the bits of valid, one "name=value" each."""
@@ -2266,7 +2281,8 @@ class OneIPPtpMessages:
                     (S.PTP_DSCP, 'ptp_dscp', self.dscp),
                     (S.SAP_EXPIRE, 'sap_expire_min', self.sap_expire_min),
                     (S.SAP_INTERVAL, 'sap_interval_s', self.sap_interval_s),
-                    (S.STREAM_TTL, 'stream_ttl', self.stream_ttl))
+                    (S.STREAM_TTL, 'stream_ttl', self.stream_ttl),
+                    (S.SINK_ROTATION, 'sink_rotation', self.sink_rotation))
                 if (bit in valid)]
 
 @dataclass(frozen=True)
@@ -2317,8 +2333,7 @@ class OsdSyncRequest:
     missing: bytes
     """The settings it lacks, bit i standing for setting i, 16 bytes."""
     source: MxrDeviceUid
-    """Who sent the sync it asks about. Empty when it asks for a new sync, and
-    from a unit whose module does not name the source."""
+    """Who sent the sync it asks about. Empty when it asks for a new sync."""
 
     def is_missing(self, index:int) -> bool:
         """Whether the unit lacks setting index."""
@@ -2394,6 +2409,28 @@ class OsdSyncReport:
     reason: str
     """Why it failed or refused any."""
 
+@dataclass(frozen=True)
+class OsdMessage:
+    """
+    The message on a unit's output, as the unit last reported it. The unit
+    holds it until it restarts.
+    """
+    flags: OsdMessageFlag
+    """Whether a message is set and shown, whether the unit can show one, and
+    whether it refused the write it answers. Without SET the other fields are
+    empty."""
+    logo: int
+    """The logo shown with it: 0 the built-in logo, -1 none, 1 to 5 a slot."""
+    priority: OsdMessagePriority|int
+    """Where it stands against the unit's own messages."""
+    text: str
+    """Its markup."""
+
+    def __str__(self) -> str:
+        if (OsdMessageFlag.SET not in self.flags):
+            return f"none{' (refused)' if (OsdMessageFlag.REFUSED in self.flags) else ''}"
+        return f"'{self.text}' logo {self.logo} {self.flags!r}"
+
 @dataclass(frozen=True)
 class OsdSyncEntry:
     """One setting of an overlay sync this client sends."""
@@ -2471,6 +2508,59 @@ class OneIPSinkSdp:
         return (f"'{self.name}' {self.group}:{self.port} {encoding} {self.channels}ch {self.rate_hz}Hz"
                 f"{' audio only' if (OneIPSdpFlag.AUDIO_ONLY in self.flags) else ''}")
 
+@dataclass(frozen=True)
+class OneIPPrivacyStream:
+    """
+    How one of a OneIP source unit's streams is encrypted, as the unit reports
+    it: the values of the stream's ``a=privacy`` and ``a=extmap`` session
+    description attributes.
+
+    A receiver needs these to decrypt the stream. The key itself never travels:
+    every unit of a mesh holds the same one. This library holds no key and
+    decrypts nothing.
+    """
+    group: str = '0.0.0.0'
+    """The stream's destination address."""
+    port: int = 0
+    """The stream's UDP port."""
+    version: int = 0
+    """Steps whenever the parameters change."""
+    on: bool = False
+    """Whether the stream is encrypted. Without it the stream goes out in the
+    clear, and the fields below mean nothing."""
+    full_id: int = 0
+    """The RTP header extension id of the full IV counter."""
+    short_id: int = 0
+    """The RTP header extension id of the short IV counter."""
+    iv: bytes = bytes(8)
+    """The initialisation vector, 8 bytes."""
+    key_generator: bytes = bytes(16)
+    """The key generator, 16 bytes."""
+    key_id: bytes = bytes(8)
+    """Names the mesh's key, 8 bytes. A receiver holding another drops the stream."""
+    key_version: int = 0
+    """The key version."""
+
+    def __str__(self) -> str:
+        if not self.on:
+            return f"{self.group}:{self.port} clear"
+        return f"{self.group}:{self.port} encrypted, key {self.key_id.hex()} v{self.key_version}"
+
+@dataclass(frozen=True)
+class OneIPPrivacy:
+    """
+    How a OneIP source unit's streams are encrypted, as it last reported it. A
+    unit reports this whenever it changes, at least once a minute, and when
+    asked. A unit that is in no mesh sends in the clear.
+    """
+    video: OneIPPrivacyStream
+    audio: OneIPPrivacyStream
+    anc: OneIPPrivacyStream
+    """The ancillary data stream."""
+
+    def __str__(self) -> str:
+        return f"video {self.video}, audio {self.audio}, anc {self.anc}"
+
 @dataclass(frozen=True)
 class OneIPTestTone:
     """A OneIP sink's test tone."""
@@ -2714,16 +2804,25 @@ class OneIPDeviceSettings:
                               else previous._power_save_level),
             ptp_messages=previous._ptp_messages.merge(self._ptp_messages, valid))
 
-    def as_applied_to(self, reported:OneIPDeviceSetting) -> 'OneIPDeviceSettings':
+    def as_applied_to(self, reported:'OneIPDeviceSettings|OneIPDeviceSetting|None') -> 'OneIPDeviceSettings':
         """
-        This block limited to what a device takes from a write about it.
+        This block limited to what a device that reported reported takes from a
+        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, and never what only it can report about
-        itself.
+        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.
+
+        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.
         """
-        valid = (self._valid & reported) & ~ONEIP_DEVICE_SETTINGS_REPORTED_ONLY
+        if (reported is None):
+            reported = OneIPDeviceSettings()
+        elif not isinstance(reported, OneIPDeviceSettings):
+            reported = OneIPDeviceSettings(valid=OneIPDeviceSetting(reported))
+        own = reported._ptp_messages
+        valid = (self._valid & reported._valid) & ~ONEIP_DEVICE_SETTINGS_REPORTED_ONLY
         if not (0 <= self._ir_profile < ONEIP_IR_PROFILE_MAX):
             valid &= ~OneIPDeviceSetting.IR_PROFILE
         if not (ONEIP_IR_PROFILE_NOT_SET <= self._ir_profile_sink < ONEIP_IR_PROFILE_MAX):
@@ -2738,13 +2837,16 @@ class OneIPDeviceSettings:
             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,
                                   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,
                                   ptp_priority1=self._ptp_priority1,
                                   power_save_level=self._power_save_level,
-                                  ptp_messages=self._ptp_messages)
+                                  ptp_messages=replace(self._ptp_messages,
+                                                       sink_rotation_step=own.sink_rotation_step))
 
     def __eq__(self, other:Any) -> bool:
         if not isinstance(other, OneIPDeviceSettings):
@@ -3452,6 +3554,26 @@ class DeviceBase(ABC):
     def osd_sync_report(self) -> OsdSyncReport|None:
         '''This unit's last report on taking an overlay sync, None until it has.'''
 
+    @property
+    @abstractmethod
+    def osd_message(self) -> OsdMessage|None:
+        '''The message on this unit's output, as it last reported it to this
+        client, None until it has. A unit reports it only when asked, or when
+        this client writes it.'''
+
+    @abstractmethod
+    async def request_osd_message(self) -> bool:
+        '''ask this unit for the message on its output'''
+
+    @abstractmethod
+    async def show_osd_message(self, text:str, logo:int=-1,
+                               priority:OsdMessagePriority=OsdMessagePriority.NORMAL) -> bool:
+        '''show a message on this unit's output, in place of any it has'''
+
+    @abstractmethod
+    async def clear_osd_message(self) -> bool:
+        '''take the message down from this unit's output'''
+
     @property
     @abstractmethod
     def oneip_sink_sdp(self) -> OneIPSinkSdp|None:
@@ -3459,6 +3581,17 @@ class DeviceBase(ABC):
         reported it, None until it has. It reports when that changes and at
         least once a minute.'''
 
+    @property
+    @abstractmethod
+    def oneip_privacy(self) -> OneIPPrivacy|None:
+        '''How this OneIP source unit's streams are encrypted, as it last
+        reported it, None until it has. It reports when that changes and at
+        least once a minute.'''
+
+    @abstractmethod
+    async def request_oneip_privacy(self) -> bool:
+        '''ask this OneIP source unit how its streams are encrypted now'''
+
     @abstractmethod
     async def play_oneip_sdp(self, sdp:str) -> bool:
         '''have this OneIP output play the stream a session description describes'''
@@ -4056,6 +4189,11 @@ class MxrCallbacks:
         _LOGGER.debug(f"{dev} overlay sync {report.seq}: {report.state!r} {report.reason}")
         self.on_device_update(dev)
 
+    def on_osd_message_changed(self, dev:DeviceBase, message:OsdMessage) -> None:
+        ''' called when unit 'dev' reported something different about the message on its output '''
+        _LOGGER.debug(f"{dev} overlay message: {message}")
+        self.on_device_update(dev)
+
     def on_osd_sync_requested(self, dev:DeviceBase, request:OsdSyncRequest) -> None:
         ''' called when 'dev' asked for an overlay sync, or for settings of one '''
         pass

{mx_remote-8.0.2 → mx_remote-9.0.0}/mx_remote/Interface.pyi

@@ -787,6 +787,9 @@ class OneIPPtpMessages:
     sap_expire_min: int = ...
     sap_interval_s: int = ...
     stream_ttl: int = ...
+    sink_rotation: int = ...
+    sink_rotation_step: int = ...
+    def takes_sink_rotation(self, degrees: int) -> bool: ...
     def merge(self, other: OneIPPtpMessages, which: OneIPDeviceSetting) -> OneIPPtpMessages: ...
     def describe(self, valid: OneIPDeviceSetting) -> list[str]: ...
 
@@ -853,6 +856,13 @@ class OsdSyncReport:
     refused: int
     reason: str
 
+@dataclass(frozen=True)
+class OsdMessage:
+    flags: OsdMessageFlag
+    logo: int
+    priority: OsdMessagePriority | int
+    text: str
+
 @dataclass(frozen=True)
 class OsdSyncEntry:
     value: OsdSyncValue
@@ -891,6 +901,25 @@ class OneIPSinkSdp:
     @property
     def active(self) -> bool: ...
 
+@dataclass(frozen=True)
+class OneIPPrivacyStream:
+    group: str = ...
+    port: int = ...
+    version: int = ...
+    on: bool = ...
+    full_id: int = ...
+    short_id: int = ...
+    iv: bytes = ...
+    key_generator: bytes = ...
+    key_id: bytes = ...
+    key_version: int = ...
+
+@dataclass(frozen=True)
+class OneIPPrivacy:
+    video: OneIPPrivacyStream
+    audio: OneIPPrivacyStream
+    anc: OneIPPrivacyStream
+
 @dataclass(frozen=True)
 class OneIPTestTone:
     mode: OneIPToneMode | int = ...
@@ -949,7 +978,7 @@ class OneIPDeviceSettings:
     @property
     def ptp_messages(self) -> OneIPPtpMessages | None: ...
     def merge(self, previous: OneIPDeviceSettings | None) -> OneIPDeviceSettings: ...
-    def as_applied_to(self, reported: OneIPDeviceSetting) -> OneIPDeviceSettings: ...
+    def as_applied_to(self, reported: OneIPDeviceSettings | OneIPDeviceSetting | None) -> OneIPDeviceSettings: ...
     def __eq__(self, other: Any) -> bool: ...
     def __ne__(self, other: Any) -> bool: ...
 
@@ -1305,7 +1334,21 @@ class DeviceBase(ABC):
     def osd_sync_report(self) -> OsdSyncReport | None: ...
     @property
     @abstractmethod
+    def osd_message(self) -> OsdMessage | None: ...
+    @abstractmethod
+    async def request_osd_message(self) -> bool: ...
+    @abstractmethod
+    async def show_osd_message(self, text: str, logo: int = -1, priority: OsdMessagePriority = ...) -> bool: ...
+    @abstractmethod
+    async def clear_osd_message(self) -> bool: ...
+    @property
+    @abstractmethod
     def oneip_sink_sdp(self) -> OneIPSinkSdp | None: ...
+    @property
+    @abstractmethod
+    def oneip_privacy(self) -> OneIPPrivacy | None: ...
+    @abstractmethod
+    async def request_oneip_privacy(self) -> bool: ...
     @abstractmethod
     async def play_oneip_sdp(self, sdp: str) -> bool: ...
     @abstractmethod
@@ -1537,6 +1580,7 @@ class MxrCallbacks:
     def on_status_hdbt_connected_changed(self, bay: BayBase, val: bool) -> None: ...
     def on_osd_sync(self, dev: DeviceBase, sync: OsdSync) -> None: ...
     def on_osd_sync_report(self, dev: DeviceBase, report: OsdSyncReport) -> None: ...
+    def on_osd_message_changed(self, dev: DeviceBase, message: OsdMessage) -> None: ...
     def on_osd_sync_requested(self, dev: DeviceBase, request: OsdSyncRequest) -> None: ...
     def on_osd_sync_setting(self, dev: DeviceBase, setting: OsdSyncSetting) -> None: ...
     def on_bay_content_changed(self, bay: BayBase, content: BayContent) -> None: ...

{mx_remote-8.0.2 → mx_remote-9.0.0}/mx_remote/const.py

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

{mx_remote-8.0.2 → mx_remote-9.0.0}/mx_remote/proto/Constants.py

@@ -10,7 +10,7 @@
 from enum import IntEnum, IntFlag
 from typing import TypeVar
 
-MXR_PROTOCOL_VERSION = 0x2F
+MXR_PROTOCOL_VERSION = 0x30
 """Highest mx_remote protocol version this library understands.
 
 Mirrors the firmware's own protocol version. Bump
@@ -31,7 +31,8 @@ every 20-30s once every device it knows is on 0x2A.
 0x2B.
 
 0x2E is the row of V2IP_SINK_SDP, so an output's session description report
-arrives stamped 0x2E, and 0x2F the row of V2IP_OSD_SYNC."""
+arrives stamped 0x2E, 0x2F the row of V2IP_OSD_SYNC and 0x30 the row of
+V2IP_PRIVACY."""
 
 MXR_PROTOCOL_VERSION_SLOW_HELLO = 0x2A
 """First protocol version whose devices may hello only every 20-30s."""
@@ -121,6 +122,7 @@ MXR_OPCODE_VERSIONS: dict[int, int] = {
     0x51: 0x2D,  # BAY_CONTENT
     0x52: 0x2E,  # V2IP_SINK_SDP
     0x53: 0x2F,  # V2IP_OSD_SYNC
+    0x54: 0x30,  # V2IP_PRIVACY
 }
 """Per-opcode minimum compatible protocol version, mirroring the firmware's
 own opcode table. Transmitters stamp the
@@ -374,9 +376,16 @@ class OneIPDeviceSetting(IntFlag):
 	STREAM_TTL         = (1 << 29)
 	'''The TTL of the device's streams, video, audio and ancillary alike.
 	Reported only by a device with an encoder.'''
+	CLOUD              = (1 << 30)
+	'''Connects to the cloud service. A device that does not report it
+	connects regardless.'''
+	SINK_ROTATION      = (1 << 31)
+	'''The angle the device's HDMI output is turned by. Reported only by a
+	device with an HDMI output.'''
 
 ONEIP_DEVICE_SETTING_SWITCHES = OneIPDeviceSetting(0xFF) | OneIPDeviceSetting.AES67 \
-	| OneIPDeviceSetting.SAP_LISTEN | OneIPDeviceSetting.SAP_ANNOUNCE | OneIPDeviceSetting.POWER_SAVE_DISABLED
+	| OneIPDeviceSetting.SAP_LISTEN | OneIPDeviceSetting.SAP_ANNOUNCE | OneIPDeviceSetting.POWER_SAVE_DISABLED \
+	| OneIPDeviceSetting.CLOUD
 """The settings that are on or off, as opposed to carrying a value, and that
 can be written."""
 
@@ -392,14 +401,17 @@ ONEIP_DEVICE_SETTINGS_PTP_MESSAGES = OneIPDeviceSetting.PTP_ANNOUNCE | OneIPDevi
 """The PTP message settings."""
 
 ONEIP_DEVICE_SETTINGS_BLOCK = ONEIP_DEVICE_SETTINGS_PTP_MESSAGES | OneIPDeviceSetting.SAP_EXPIRE \
-	| OneIPDeviceSetting.SAP_INTERVAL | OneIPDeviceSetting.STREAM_TTL
+	| OneIPDeviceSetting.SAP_INTERVAL | OneIPDeviceSetting.STREAM_TTL | OneIPDeviceSetting.SINK_ROTATION
 """The settings whose values a frame carries in a block of their own behind the
-rest, OneIPPtpMessages: the PTP message settings, the two SAP values and the
-stream TTL."""
+rest, OneIPPtpMessages: the PTP message settings, the two SAP values, the
+stream TTL and the output's rotation."""
 
 ONEIP_STREAM_TTL_DEFAULT = 64
 """The TTL a OneIP device's streams carry until it is set."""
 
+ONEIP_SINK_ROTATION_MAX = 359
+"""The largest angle a OneIP device's HDMI output is turned by, in degrees."""
+
 class OneIPPtpMode(IntEnum):
 	'''How a OneIP device takes part in PTP.'''
 	OFF      = 0
@@ -428,6 +440,31 @@ class OsdSyncWhat(IntFlag):
 	LOGO_SLOTS  = (1 << 3)
 	'''The logo images in the four slots.'''
 
+class OsdMessageFlag(IntFlag):
+	'''What a unit says of the message on its output.'''
+	SET       = (1 << 0)
+	'''A message is set. In a write: show it, rather than take it down.'''
+	SHOWN     = (1 << 1)
+	'''The output shows it, rather than another message ahead of it.'''
+	SUPPORTED = (1 << 2)
+	'''The unit's video processor composes the message layer.'''
+	REFUSED   = (1 << 3)
+	'''The unit did not take the write it answers, and reports the message it
+	kept.'''
+
+class OsdMessagePriority(IntEnum):
+	'''Where a message stands against the unit's own messages: its upgrade,
+	Locate Device and encrypted source messages.'''
+	LOW    = 0
+	'''After them.'''
+	NORMAL = 1
+	'''Between them.'''
+	TOP    = 2
+	'''Before them.'''
+
+OSD_MESSAGE_TEXT_MAX = 255
+"""The longest message text a unit takes, in bytes."""
+
 class OsdSyncState(IntEnum):
 	'''How far a unit has got with taking an overlay sync.'''
 	TAKING   = 0

{mx_remote-8.0.2 → mx_remote-9.0.0}/mx_remote/proto/Constants.pyi

@@ -108,6 +108,8 @@ class OneIPDeviceSetting(IntFlag):
     SAP_INTERVAL: Incomplete
     POWER_SAVE_DISABLED: Incomplete
     STREAM_TTL: Incomplete
+    CLOUD: Incomplete
+    SINK_ROTATION: Incomplete
 
 ONEIP_DEVICE_SETTING_SWITCHES: Incomplete
 ONEIP_DEVICE_SETTINGS_REPORTED_ONLY: Incomplete
@@ -115,6 +117,7 @@ ONEIP_DEVICE_SETTINGS_PTP: Incomplete
 ONEIP_DEVICE_SETTINGS_PTP_MESSAGES: Incomplete
 ONEIP_DEVICE_SETTINGS_BLOCK: Incomplete
 ONEIP_STREAM_TTL_DEFAULT: int
+ONEIP_SINK_ROTATION_MAX: int
 
 class OneIPPtpMode(IntEnum):
     OFF: int
@@ -131,6 +134,19 @@ class OsdSyncWhat(IntFlag):
     BACKGROUNDS: Incomplete
     LOGO_SLOTS: Incomplete
 
+class OsdMessageFlag(IntFlag):
+    SET: Incomplete
+    SHOWN: Incomplete
+    SUPPORTED: Incomplete
+    REFUSED: Incomplete
+
+class OsdMessagePriority(IntEnum):
+    LOW: int
+    NORMAL: int
+    TOP: int
+
+OSD_MESSAGE_TEXT_MAX: int
+
 class OsdSyncState(IntEnum):
     TAKING: int
     DONE: int

{mx_remote-8.0.2 → mx_remote-9.0.0}/mx_remote/proto/Factory.py

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