mx-remote 5.4.0__tar.gz → 5.5.0__tar.gz

{mx_remote-5.4.0 → mx_remote-5.5.0}/AGENTS.md

@@ -83,6 +83,21 @@ reads it via regex, so bump it there only. Release commits follow the convention
 force-includes them in the wheel (they are gitignored). `mx_remote` ships as typed
 (`py.typed`). If stubgen produces nothing the build fails by design.
 
+### Documentation
+`docs/` is both the GitHub-readable guide set and the Sphinx source for
+[the published site](https://opdenkamp.github.io/mx-remote/), which
+`.github/workflows/docs.yml` rebuilds on every push to master. Build it the way
+the workflow does:
+
+```sh
+pip install . -r docs/requirements.txt
+sphinx-build -b html -W --keep-going docs site
+```
+
+Autodoc emits reStructuredText, so a directive belongs in an ```` ```{eval-rst} ````
+block. Outside one it renders as its own source and the build still reports
+success — the workflow greps the output for that.
+
 ## Architecture
 
 Three layers, decoupled by abstract base classes:

{mx_remote-5.4.0 → mx_remote-5.5.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.5
 Name: mx_remote
-Version: 5.4.0
+Version: 5.5.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://github.com/opdenkamp/mx-remote/
+Project-URL: Documentation, https://opdenkamp.github.io/mx-remote/
 Project-URL: Repository, https://github.com/opdenkamp/mx-remote.git
 Project-URL: Bug Tracker, https://github.com/opdenkamp/mx-remote/issues
 Author-email: Lars Op den Kamp <lars@opdenkamp-it.nl>
@@ -41,6 +41,8 @@ streaming, multiviewer control, and more.
 If you are looking to integrate Pulse-Eight **neo**, **OneIP**, or **ProAmp8** devices into
 your own software or home-automation system, this is the library for it.
 
+**Documentation:** [opdenkamp.github.io/mx-remote](https://opdenkamp.github.io/mx-remote/)
+
 ## What is MX Remote?
 
 MX Remote is the network protocol these Pulse-Eight devices use to discover and control one
@@ -97,18 +99,21 @@ asyncio.run(main())
 
 ## Documentation
 
-The full API reference lives in [docs/](docs/README.md).
+The guides below are published at
+**[opdenkamp.github.io/mx-remote](https://opdenkamp.github.io/mx-remote/)** alongside an
+API reference generated from the docstrings, and are readable here in
+[docs/](docs/README.md).
 
 | Page | Covers |
 | --- | --- |
-| [Configuration](configuration.md) | Opening a connection and keeping it in step with the mesh. |
-| [Devices and bays](devices-and-bays.md) | Naming, hiding, EDID and the device registry. |
-| [Routing](routing.md) | Selecting video and audio sources for an output. |
-| [Callbacks](callbacks.md) | Reacting to state changes rather than polling for them. |
-| [Audio](audio.md) | Volume, mute and remote-control passthrough. |
-| [OneIP and V2IP](oneip.md) | Streaming endpoints, stream sources and statistics. |
-| [Multiviewer](multiviewer.md) | Layout, sources and output configuration. |
-| [Diagnostics](diagnostics.md) | Network status, the mxr console app and capture replay. |
+| [Configuration](docs/configuration.md) | Opening a connection and keeping it in step with the mesh. |
+| [Devices and bays](docs/devices-and-bays.md) | Naming, hiding, EDID and the device registry. |
+| [Routing](docs/routing.md) | Selecting video and audio sources for an output. |
+| [Callbacks](docs/callbacks.md) | Reacting to state changes rather than polling for them. |
+| [Audio](docs/audio.md) | Volume, mute and remote-control passthrough. |
+| [OneIP and V2IP](docs/oneip.md) | Streaming endpoints, stream sources and statistics. |
+| [Multiviewer](docs/multiviewer.md) | Layout, sources and output configuration. |
+| [Diagnostics](docs/diagnostics.md) | Network status, the mxr console app and capture replay. |
 
 ## Other languages
 

{mx_remote-5.4.0 → mx_remote-5.5.0}/README.md

@@ -9,6 +9,8 @@ streaming, multiviewer control, and more.
 If you are looking to integrate Pulse-Eight **neo**, **OneIP**, or **ProAmp8** devices into
 your own software or home-automation system, this is the library for it.
 
+**Documentation:** [opdenkamp.github.io/mx-remote](https://opdenkamp.github.io/mx-remote/)
+
 ## What is MX Remote?
 
 MX Remote is the network protocol these Pulse-Eight devices use to discover and control one
@@ -65,18 +67,21 @@ asyncio.run(main())
 
 ## Documentation
 
-The full API reference lives in [docs/](docs/README.md).
+The guides below are published at
+**[opdenkamp.github.io/mx-remote](https://opdenkamp.github.io/mx-remote/)** alongside an
+API reference generated from the docstrings, and are readable here in
+[docs/](docs/README.md).
 
 | Page | Covers |
 | --- | --- |
-| [Configuration](configuration.md) | Opening a connection and keeping it in step with the mesh. |
-| [Devices and bays](devices-and-bays.md) | Naming, hiding, EDID and the device registry. |
-| [Routing](routing.md) | Selecting video and audio sources for an output. |
-| [Callbacks](callbacks.md) | Reacting to state changes rather than polling for them. |
-| [Audio](audio.md) | Volume, mute and remote-control passthrough. |
-| [OneIP and V2IP](oneip.md) | Streaming endpoints, stream sources and statistics. |
-| [Multiviewer](multiviewer.md) | Layout, sources and output configuration. |
-| [Diagnostics](diagnostics.md) | Network status, the mxr console app and capture replay. |
+| [Configuration](docs/configuration.md) | Opening a connection and keeping it in step with the mesh. |
+| [Devices and bays](docs/devices-and-bays.md) | Naming, hiding, EDID and the device registry. |
+| [Routing](docs/routing.md) | Selecting video and audio sources for an output. |
+| [Callbacks](docs/callbacks.md) | Reacting to state changes rather than polling for them. |
+| [Audio](docs/audio.md) | Volume, mute and remote-control passthrough. |
+| [OneIP and V2IP](docs/oneip.md) | Streaming endpoints, stream sources and statistics. |
+| [Multiviewer](docs/multiviewer.md) | Layout, sources and output configuration. |
+| [Diagnostics](docs/diagnostics.md) | Network status, the mxr console app and capture replay. |
 
 ## Other languages
 

{mx_remote-5.4.0 → mx_remote-5.5.0}/docs/README.md

@@ -1,6 +1,6 @@
 # Documentation
 
-The API reference for `mx_remote`. Start at the [project README](../README.md) for installation and a quick start.
+The API reference for `mx_remote`. Start at the [project README](https://github.com/opdenkamp/mx-remote#readme) for installation and a quick start.
 
 | Page | Covers |
 | --- | --- |

mx_remote-5.5.0/docs/_static/brand.css

@@ -0,0 +1,34 @@
+/* Shapes Furo to the house style. The palette itself is set in conf.py, where
+   Furo wants it; this file holds what a variable cannot express. */
+
+/* The mark is portrait, so a width bound keeps it from filling the sidebar. */
+.sidebar-logo {
+  max-width: 4.5rem;
+  margin: 0 auto 0.5rem;
+}
+
+.sidebar-brand-text {
+  font-weight: 600;
+  letter-spacing: -0.025em;
+}
+
+h1, h2, h3, h4 {
+  letter-spacing: -0.025em;
+}
+
+/* Furo underlines links only on hover; the guides lean on them heavily enough
+   that a reader should see where they are while scanning. */
+article a.reference.internal,
+article a.reference.external {
+  text-decoration-color: var(--color-brand-content);
+  text-decoration-line: underline;
+  text-decoration-thickness: 1px;
+  text-underline-offset: 0.15em;
+}
+
+/* Signatures are the spine of the API reference: give them the brand rule so
+   they read as landmarks rather than as another grey block. */
+dl.py > dt {
+  border-left: 3px solid var(--color-brand-content);
+  padding-left: 0.6rem;
+}

mx_remote-5.5.0/docs/_static/favicon.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="27 7 86 86" width="86" height="86" role="img" aria-label="Op den Kamp IT Solutions">
+  <circle cx="70" cy="50" r="30" fill="none" stroke="#0588c4" stroke-width="26"/>
+</svg>

mx_remote-5.5.0/docs/_static/logo-dark.svg

@@ -0,0 +1,8 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="20 0 120 190" width="120" height="190" role="img" aria-label="Op den Kamp IT Solutions">
+  <circle cx="70" cy="50" r="30" fill="none" stroke="#0588c4" stroke-width="26"/>
+  <g fill="#5aafc0">
+    <rect x="27" y="117" width="16" height="66"/>
+    <rect x="57" y="117" width="76" height="16"/>
+    <rect x="87" y="117" width="16" height="66"/>
+  </g>
+</svg>

mx_remote-5.5.0/docs/_static/logo.svg

@@ -0,0 +1,8 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="20 0 120 190" width="120" height="190" role="img" aria-label="Op den Kamp IT Solutions">
+  <circle cx="70" cy="50" r="30" fill="none" stroke="#0588c4" stroke-width="26"/>
+  <g fill="#117a8b">
+    <rect x="27" y="117" width="16" height="66"/>
+    <rect x="57" y="117" width="76" height="16"/>
+    <rect x="87" y="117" width="16" height="66"/>
+  </g>
+</svg>

mx_remote-5.5.0/docs/api.md

@@ -0,0 +1,59 @@
+# API reference
+
+Generated from the docstrings in the package. The guides cover how these fit
+together; this page is the exhaustive list.
+
+Autodoc emits reStructuredText, which the markdown parser does not read, so
+every directive below sits in an `eval-rst` block. Without it the page renders
+the directive source as prose and the build still succeeds.
+
+```{eval-rst}
+.. automodule:: mx_remote
+```
+
+## Client
+
+`Remote` owns the socket, the device registry and the background probe that
+keeps both in step with the mesh.
+
+```{eval-rst}
+.. automodule:: mx_remote.remote.Remote
+   :members:
+```
+
+## Devices, bays and callbacks
+
+A client works against these types rather than the classes implementing them:
+they are what the registry hands out and what a callback receives.
+
+```{eval-rst}
+.. automodule:: mx_remote.Interface
+   :members:
+```
+
+## Device identity
+
+```{eval-rst}
+.. automodule:: mx_remote.Uid
+   :members:
+```
+
+## Remote-control keys and actions
+
+The key and action codes a bay reports, and the target a key was aimed at.
+
+```{eval-rst}
+.. autoclass:: mx_remote.proto.Constants.RCKey
+   :members:
+   :undoc-members:
+
+.. autoclass:: mx_remote.proto.Constants.RCAction
+   :members:
+   :undoc-members:
+
+.. autoclass:: mx_remote.proto.Constants.RCType
+   :members:
+   :undoc-members:
+
+.. autodata:: mx_remote.proto.Constants.MXR_PROTOCOL_VERSION
+```

{mx_remote-5.4.0 → mx_remote-5.5.0}/docs/audio.md

@@ -33,4 +33,4 @@ await bay.tx_action(RCAction.ACTION_VOLUME_DOWN)
 
 ---
 
-[Documentation index](README.md) | [Project README](../README.md)
+[Documentation index](README.md) | [Project README](https://github.com/opdenkamp/mx-remote#readme)

{mx_remote-5.4.0 → mx_remote-5.5.0}/docs/callbacks.md

@@ -87,4 +87,4 @@ bay.unregister_callback(on_bay_changed)
 
 ---
 
-[Documentation index](README.md) | [Project README](../README.md)
+[Documentation index](README.md) | [Project README](https://github.com/opdenkamp/mx-remote#readme)

mx_remote-5.5.0/docs/conf.py

@@ -0,0 +1,102 @@
+######################################################
+##            MX Remote Python Interface            ##
+##                                                  ##
+## author: Lars Op den Kamp (lars@opdenkamp-it.nl)  ##
+## copyright (c) 2021-2026 Op den Kamp IT Solutions ##
+######################################################
+'''Sphinx configuration for the mx_remote documentation site.
+
+The guides in this directory are the prose; the API reference is generated from
+the package's own docstrings, so `mx_remote` must be importable when this runs.
+The workflow installs it rather than mocking it: a reference built against
+mocks documents the mocks on the day an import breaks.
+'''
+
+import pathlib
+import re
+
+_ROOT = pathlib.Path(__file__).resolve().parent.parent
+
+project = 'mx_remote'
+author = 'Lars Op den Kamp'
+copyright = '2021-2026 Op den Kamp IT Solutions'
+
+# Read from the package the same way pyproject.toml does, so the site cannot
+# report a version the package does not carry.
+release = re.search(r"VERSION = '([^']+)'",
+                    (_ROOT / 'mx_remote' / 'const.py').read_text(encoding='utf-8')).group(1)
+version = release
+
+extensions = [
+    'myst_parser',              # the guides are markdown, and stay readable on GitHub
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.intersphinx',
+]
+
+# Anchors for the '#section' links the guides use between each other.
+myst_heading_anchors = 3
+
+exclude_patterns = ['_build', 'requirements.txt']
+
+autodoc_default_options = {
+    'members': True,
+    'show-inheritance': True,
+    'member-order': 'bysource',
+}
+# A member with no docstring says nothing a reader cannot get from the
+# signature, and there are enough of them to bury the ones that do.
+autodoc_typehints = 'description'
+autodoc_class_signature = 'separated'
+
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
+
+html_theme = 'furo'
+html_title = f'mx_remote {release}'
+html_static_path = ['_static']
+html_css_files = ['brand.css']
+# The ring alone, because the full mark is portrait and would letterbox down
+# to a few unreadable pixels in a tab.
+html_favicon = '_static/favicon.svg'
+
+# The palette is the one opdenkamp-it.nl uses, so the site and the docs read as
+# one place: slate text, teal accents, and a near-black teal ground when dark.
+# Furo derives the rest of its colours from these, and applies the light set to
+# both themes, so the dark set only names what differs.
+html_theme_options = {
+    'light_logo': 'logo.svg',
+    'dark_logo': 'logo-dark.svg',
+    'light_css_variables': {
+        'font-stack': '"Inter Variable", Inter, system-ui, -apple-system, sans-serif',
+        'font-stack--monospace': '"JetBrains Mono Variable", "JetBrains Mono", ui-monospace, monospace',
+        'color-brand-primary': '#0f4c5c',
+        'color-brand-content': '#117a8b',
+        'color-brand-visited': '#0f4c5c',
+        'color-foreground-primary': '#0f172a',
+        'color-foreground-secondary': '#475569',
+        'color-foreground-muted': '#64748b',
+        'color-foreground-border': '#e2e8f0',
+        'color-background-primary': '#ffffff',
+        'color-background-secondary': '#f8fafc',
+        'color-background-border': '#e2e8f0',
+        'color-inline-code-background': '#f1f5f9',
+        'color-api-name': '#0f4c5c',
+        'color-api-pre-name': '#117a8b',
+    },
+    'dark_css_variables': {
+        'color-brand-primary': '#5aafc0',
+        'color-brand-content': '#5aafc0',
+        'color-brand-visited': '#8fc9d5',
+        'color-foreground-primary': '#e2e8f0',
+        'color-foreground-secondary': '#94a3b8',
+        'color-foreground-muted': '#7d8ea0',
+        'color-foreground-border': '#1c414d',
+        'color-background-primary': '#0a1f26',
+        'color-background-secondary': '#0d2b34',
+        'color-background-border': '#1c414d',
+        'color-inline-code-background': '#12333d',
+        'color-api-name': '#5aafc0',
+        'color-api-pre-name': '#8fc9d5',
+    },
+}

{mx_remote-5.4.0 → mx_remote-5.5.0}/docs/configuration.md

@@ -130,4 +130,4 @@ await mx.update_config(
 
 ---
 
-[Documentation index](README.md) | [Project README](../README.md)
+[Documentation index](README.md) | [Project README](https://github.com/opdenkamp/mx-remote#readme)

{mx_remote-5.4.0 → mx_remote-5.5.0}/docs/devices-and-bays.md

@@ -44,4 +44,4 @@ await bay.select_edid_profile(EdidProfile.LOWEST_COMMON_DENOMINATOR)
 
 ---
 
-[Documentation index](README.md) | [Project README](../README.md)
+[Documentation index](README.md) | [Project README](https://github.com/opdenkamp/mx-remote#readme)

{mx_remote-5.4.0 → mx_remote-5.5.0}/docs/diagnostics.md

@@ -86,4 +86,4 @@ help(mx_remote.MxrCallbacks)
 
 ---
 
-[Documentation index](README.md) | [Project README](../README.md)
+[Documentation index](README.md) | [Project README](https://github.com/opdenkamp/mx-remote#readme)

mx_remote-5.5.0/docs/index.md

@@ -0,0 +1,34 @@
+# mx_remote
+
+Python 3 library for discovering and controlling [Pulse-Eight](https://www.pulse-eight.com/)
+AV distribution hardware — neo matrices, OneIP HDMI-over-IP units, multiviewers and
+ProAmp8 amplifiers — over the MX Remote protocol they share.
+
+```sh
+pip install mx_remote
+```
+
+```python
+import mx_remote
+
+mx = mx_remote.Remote()
+await mx.start_async()
+```
+
+The guides below cover the library task by task. The [API reference](api.md) is
+generated from the package's docstrings and lists everything.
+
+```{toctree}
+:maxdepth: 2
+
+README
+configuration
+devices-and-bays
+routing
+callbacks
+audio
+oneip
+multiviewer
+diagnostics
+api
+```

{mx_remote-5.4.0 → mx_remote-5.5.0}/docs/multiviewer.md

@@ -49,4 +49,4 @@ await mv.auto_route()
 
 ---
 
-[Documentation index](README.md) | [Project README](../README.md)
+[Documentation index](README.md) | [Project README](https://github.com/opdenkamp/mx-remote#readme)

{mx_remote-5.4.0 → mx_remote-5.5.0}/docs/oneip.md

@@ -40,4 +40,4 @@ if device.v2ip_firmware_versions:
 
 ---
 
-[Documentation index](README.md) | [Project README](../README.md)
+[Documentation index](README.md) | [Project README](https://github.com/opdenkamp/mx-remote#readme)

mx_remote-5.5.0/docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx>=7.2
+furo>=2024.1.29
+myst-parser>=2.0

{mx_remote-5.4.0 → mx_remote-5.5.0}/docs/routing.md

@@ -21,4 +21,4 @@ await output.select_audio_source(source=0)
 
 ---
 
-[Documentation index](README.md) | [Project README](../README.md)
+[Documentation index](README.md) | [Project README](https://github.com/opdenkamp/mx-remote#readme)

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/Interface.py

@@ -1394,7 +1394,7 @@ def v2ip_stream_valid(stream:'V2IPStreamSource|None') -> bool:
     """
     True when a stream source carries an address a frame actually meant to send.
 
-    Mirrors mxr_v2ip_stream_valid(): a multicast ip and a non-zero port. A
+    Mirrors the firmware's own test: a multicast ip and a non-zero port. A
     controller write that offers no addresses leaves the block zeroed, which
     fails both tests.
     """
@@ -1409,7 +1409,7 @@ def v2ip_av_source_valid(video:'V2IPStreamSource|None', anc:'V2IPStreamSource|No
     """
     True when an av source block carries addresses a frame meant to send.
 
-    Mirrors mxr_v2ip_av_source_valid(): video and anc must both be valid, audio
+    Mirrors the firmware's own test: video and anc must both be valid, audio
     is optional and is carried along with them.
     """
     return v2ip_stream_valid(video) and v2ip_stream_valid(anc)

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/const.py

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

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/proto/Constants.py

@@ -113,7 +113,7 @@ MXR_DEVICE_NAME_LEN = 16
 
 The field carries no terminator of its own when the value fills it, so read
 exactly this many bytes and only then cut at a NUL - scanning on runs into the
-neighbouring struct member (firmware V2IP#349)."""
+neighbouring struct member."""
 
 MXR_FW_VERSION_LEN = 128
 """Width of the fixed-size firmware version name field (mxr_fw_version.name)."""
@@ -341,8 +341,8 @@ class BayStatusMask(IntFlag):
 		return "none"
 
 
-# Bay status bit-field accessors (not flag bits). Mirrors MXR_BAY_STATUS_RC_TYPE
-# and MXR_BAY_STATUS_HDCP_STATUS in mx_remote_proto.h.
+# Bay status bit-field accessors (not flag bits), mirroring the firmware's
+# MXR_BAY_STATUS_RC_TYPE and MXR_BAY_STATUS_HDCP_STATUS.
 BAY_STATUS_RC_TYPE_SHIFT = 16
 BAY_STATUS_RC_TYPE_MASK = (0xF << BAY_STATUS_RC_TYPE_SHIFT)
 BAY_STATUS_HDCP_STATUS_SHIFT = 22
@@ -369,7 +369,7 @@ _MXR_SIG_BPP_VALUES: dict[int, int] = {
 def mxr_sig_bpp_get(bpp: int) -> int:
 	'''Map an mxr_signal_type bpp *index* to the bit depth it stands for.
 
-	Mirrors mxr_sig_bpp_get() in mxr_bay.c. The field is an index, not a value:
+	The field is an index, not a value:
 	1=8, 2=10, 3=12, 4=16, 0=unknown and 5 the unset sentinel - reading it as a
 	bit depth is a common trap. Returns 0 for both unknown and unset.'''
 	return _MXR_SIG_BPP_VALUES.get(bpp, MXR_SIG_BPP_UNKNOWN)
@@ -441,8 +441,7 @@ class MxrSignalType:
 class VideoWallOperation(IntEnum):
 	'''What a V2IP_VIDEOWALL frame asks the addressed sink to do with its window.
 
-	Mirrors enum vw_mesh_op in the v2ipwall module
-	(github.com/opdenkamp/mod-v2ip-videowall, src/v2ip_videowall.h).'''
+	Mirrors vw_mesh_op in the v2ipwall module, which owns this opcode.'''
 	PREVIEW = 0
 	'''Show the window without storing it, so it dies on reboot or revert.'''
 

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/proto/FrameBayConfig.py

@@ -17,7 +17,7 @@ class FrameBayConfig(FrameBase):
     '''Bay configuration for the bays a remote device advertises.
 
     A device pages its bays across several of these frames: firmware sizes each
-    page against mxr_max_payload_len() and shrinks it further on OOM, so the
+    page against its own maximum payload length and shrinks it further on OOM, so the
     record count varies from frame to frame and no single frame holds the whole
     list. Each page is a valid stand-alone frame with the same per-record
     format - the receiver merges records into its cache and must never treat

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/proto/FrameFactoryReset.py

@@ -7,7 +7,7 @@
 '''Protocol frame for SYS_FACTORY_RESET (opcode 0x3A).
 
 A mesh controller or management app broadcasts this to factory-reset peers.
-Payload variants accepted by the firmware (see _mxr_check_mng_payload):
+Payload variants the firmware accepts:
     empty           controller-only target (just the sender)
     1 byte = 0xFF   broadcast to all peers (controller/management only)
     16 bytes        single target uid

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/proto/FrameLinks.py

@@ -15,7 +15,7 @@ class FrameLinks(FrameBase):
     '''Configured links for the device that sent this frame.
 
     Paged the same way as the bay config: a device with many bays splits its
-    links across several frames sized against mxr_max_payload_len(), so the
+    links across several frames sized against its own maximum payload, so the
     record count varies per frame and the receiver merges records into its
     cache rather than replacing it.'''
     @cached_property

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/proto/FrameV2IPAudio.py

@@ -646,7 +646,7 @@ def _pack_audio_entry_route_in(ep_id: int, supported: int, active: int) -> bytes
 def pack_audio_features(dev: AudioDeviceData) -> bytes:
     '''Pack the mxr_v2ip_audio_dev FEATURES body.
 
-    Entry order matches aud_dev_serialise in mod-v2ip-audio/src/device.c:
+    Entry order matches the audio module's own serialiser:
     optional device control address first, then for each endpoint the
     ENDPOINT entry, optional ADDRESS, optional PARENT, optional ROUTE_IN.
     '''

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/proto/FrameV2IPVideoWall.py

@@ -23,9 +23,8 @@ from ..Uid import MxrDeviceUid
 #   28..29   u8  op              vw_mesh_op
 #   29..32   padding, zeroed
 #
-# Defined by the v2ipwall module (github.com/opdenkamp/mod-v2ip-videowall,
-# src/v2ip_videowall.h), which MatrixOS does not carry - it reserves only the
-# opcode number. The receiver accepts 32 bytes or more and ignores the rest.
+# Defined by the v2ipwall module, which MatrixOS does not carry - it reserves
+# only the opcode number. The receiver accepts 32 bytes or more and ignores the rest.
 #
 # A wrong offset here is quiet at `op` and loud everywhere else. A shifted
 # window is visibly in the wrong place; a misread op is still a valid op, so a

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/proto/V2IPStats.py

@@ -154,9 +154,9 @@ class V2IPRxStats:
         # ONE byte at 40, with three of padding after it: it is a plain enum and
         # Cortex-M builds with -fshort-enums.
         #
-        # This sender does zero that padding - mxr_bsp_v2ip_tx_v2ip_stats()
-        # writes through pointers into an already-zeroed pbuf rather than
-        # copying a stack struct, so unlike 0x45 there is no stack content here.
+        # This sender does zero that padding: it writes through pointers into
+        # an already-zeroed buffer rather than copying a stack struct, so unlike
+        # 0x45 there is no stack content here.
         # Keep the read one byte anyway: that is a property of one sender's
         # implementation, not of the protocol, and the 0x45 sender demonstrates
         # what the other approach puts on the wire. A width that is only correct

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/remote/ConnectionAsync.py

@@ -22,8 +22,8 @@ _LOGGER = logging.getLogger(__name__)
 #
 # Delivery is currently to a group: a device has two endpoints, the multicast
 # group and the interface broadcast address, and nothing resolves a per-device
-# address. Do not build on that. mxr_transmit() threads a device through its
-# endpoint selection so directed sends can be added later.
+# address. Do not build on that: the firmware threads a device through its own
+# endpoint selection, so directed sends can be added later.
 #
 # Two things keep this correct if they are:
 #

{mx_remote-5.4.0 → mx_remote-5.5.0}/mx_remote/remote/Remote.py

@@ -409,8 +409,8 @@ class Remote(DeviceRegistry, ConnectionCallbacks):
         if (sent > 0):
             # Only a hello that went out buys the next interval. A send that wrote
             # nothing leaves _hello_due where it was, so the next probe tick tries
-            # again, which is what firmware does - it resets hello_timeout only in
-            # the success branch of mxr_transmit. Arming here on failure instead
+            # again, which is what firmware does - it re-arms its own timer only
+            # after a send succeeds. Arming here on failure instead
             # would silence a client for a full interval every time a write failed,
             # and on an interface that never writes, permanently.
             self._arm_hello()

{mx_remote-5.4.0 → mx_remote-5.5.0}/pyproject.toml

@@ -51,7 +51,7 @@ pattern = "VERSION = '(?P<version>[^']+)'"
 
 [project.urls]
 Homepage = "https://github.com/opdenkamp/mx-remote/"
-Documentation = "https://github.com/opdenkamp/mx-remote/"
+Documentation = "https://opdenkamp.github.io/mx-remote/"
 Repository = "https://github.com/opdenkamp/mx-remote.git"
 "Bug Tracker" = "https://github.com/opdenkamp/mx-remote/issues"
 

{mx_remote-5.4.0 → mx_remote-5.5.0}/tests/capture.py

@@ -1,6 +1,5 @@
-# Real 0x45 frames off a live mesh, captured by the MatrixOS session. Every unit
-# on that mesh was CEC-configured, so _v2ip_rc_fill_proto_status() writes
-# status_name[0] = 0 and returns - the string must be empty in all three. That is
+# Real 0x45 frames captured off a live mesh. Every unit on that mesh was
+# CEC-configured, so the sender leaves status_name empty and returns - the string must be empty in all three. That is
 # what makes them a usable fixture: the expected value is known from firmware
 # behaviour rather than from our own decoder.
 import os, sys, time, logging

{mx_remote-5.4.0 → mx_remote-5.5.0}/tests/hello.py

@@ -53,8 +53,8 @@ print('silent network, 3.5s: %d hellos' % len(hellos))
 assert len(hellos) >= 2, 'a client must keep announcing with no traffic arriving'
 
 # ---- arriving datagrams must not announce, asserted by behaviour rather than by
-# name. Checking that "tx_hello" is absent from on_datagram_received passes the
-# moment the method is renamed, while the receipt-driven path is back in place.
+# name: checking that "tx_hello" is absent from on_datagram_received passes as
+# soon as the announce is called under another name.
 def announces_on_receipt():
     mx = mx_remote.Remote(open_connection=False)
     mx._uid = bytes(range(0x20, 0x30))