MX Remote - Python Client for Pulse-Eight MatrixOS devices
Python 3 library for discovering and controlling Pulse-Eight AV distribution hardware over a local network: video/audio matrices, HDMI-over-IP encoders/decoders, multiviewers, and audio amplifiers. Supports device discovery, video/audio routing, volume control, remote-control key passthrough, HDMI-over-IP 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
What is MX Remote?
MX Remote is the network protocol these Pulse-Eight devices use to discover and control one another over UDP (multicast or broadcast). All of them run the shared MatrixOS firmware, which speaks this protocol natively. This library is a client implementation of that protocol — its purpose is to expose the devices to third-party software.
Supported devices
All devices below run MatrixOS and are controlled through the same protocol:
- Pulse-Eight neo — HDBaseT video/audio matrices (neo:4, neo:8, neo:X, and splitters)
- Pulse-Eight OneIP — HDMI-over-IP units: Transmitter (TX), Receiver (RX), Transceiver (TZ), and Multiviewer
- Pulse-Eight ProAmp8 — 8-zone audio amplifier with Dolby support
Requirements
- Python 3.11 or later
- Network access to one or more of the Pulse-Eight devices above (multicast or broadcast)
Installation
pip install .
Quick Start
The minimum code to discover devices on the network:
import asyncio
import mx_remote
async def main():
mx = mx_remote.Remote()
await mx.start_async()
# wait for devices to be discovered
await asyncio.sleep(5)
for uid, device in mx.remotes.items():
print(f"{device.serial} ({device.name}) - {device.model_name} - {device.status}")
for port, bay in device.bays.items():
print(f" {bay.bay_label} [{bay.mode}] signal={bay.signal_detected}")
await mx.close()
asyncio.run(main())
Documentation
The guides below are published at opdenkamp.github.io/mx-remote alongside an API reference generated from the docstrings, and are readable here in docs/.
| Page | Covers |
|---|---|
| Configuration | Opening a connection and keeping it in step with the mesh. |
| Devices and bays | Naming, hiding, EDID and the device registry. |
| Routing | Selecting video and audio sources for an output. |
| Callbacks | Reacting to state changes rather than polling for them. |
| Audio | Volume, mute and remote-control passthrough. |
| OneIP and V2IP | Streaming endpoints, stream sources and statistics. |
| Multiviewer | Layout, sources and output configuration. |
| Diagnostics | Network status, the mxr console app and capture replay. |
Other languages
The same protocol, implemented independently:
- Go — https://github.com/opdenkamp/mx-remote-golang
- Rust — https://github.com/opdenkamp/mx-remote-rust (also ships a C ABI, for C and C++)
Python is the oldest of the three and the one that still decodes what older
firmware sent: 0x06, 0x36 and 0x47 are superseded opcodes kept because a
unit on older firmware still emits them. So it decodes a slightly wider set than
the others, and the difference is deliberate rather than drift.
License
BSD 3-Clause License. See LICENSE for details.
1 maintainer
Metadata
1 maintainer
Release files for mx-remote 5.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mx_remote-5.6.0.tar.gz | 214.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mx_remote-5.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 437.5 kB
Release files / mx_remote-5.6.0.tar.gz
| Download URL | mx_remote-5.6.0.tar.gz |
|---|---|
| Size | 214.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8da206fe40f15e7d2bee838940fa062abe2e60a6eeb42760d1166114c2831eb4
|
|
BLAKE2b-256 checksum How to use checksums |
a1602f6fd7cb320bb471979e3b90d5de2d16e68411677c278cbd715458b959c0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.6
|
Release files / mx_remote-5.6.0-py3-none-any.whl
| Download URL | mx_remote-5.6.0-py3-none-any.whl |
|---|---|
| Size | 222.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3d83e5c3af9d293e164ed0cdb70015f07f9f015ac63e4d9f7ece35a1098e1ee4
|
|
BLAKE2b-256 checksum How to use checksums |
3a0231adf0f0488a4526b63e651090f603c57d999a30f7ddd3884947a4f8411b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.6
|
