Skip to main content

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:

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.

Metadata

Release files for mx-remote 5.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mx-remote 5.5.1
File Size Uploaded
mx_remote-5.5.1.tar.gz 197.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mx-remote 5.5.1
File Interpreter ABI Platform
mx_remote-5.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 412.9 kB

Release files / mx_remote-5.5.1.tar.gz

Download URL mx_remote-5.5.1.tar.gz
Size 197.3 kB
Tags Source
SHA-256 checksum
How to use checksums
5405a0b65ef9e4da356ddb2debb07a9fef5ddfaf3067ab24165c5707b164f81d
BLAKE2b-256 checksum
How to use checksums
6a16384ba61ba43e3cc00979ff2f301bffc9bf53e9cc013a15115d83e3d06487
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.5.1-py3-none-any.whl

Download URL mx_remote-5.5.1-py3-none-any.whl
Size 215.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f14a437e4d6d2ef22760849ab231894d6fe1be8faf79c907cd4fc3186b42f3b4
BLAKE2b-256 checksum
How to use checksums
44e1181219d83ac35b1a32b64663e4579cefeaaea22bc1074e2dcd993c072fad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.6

Release history Release notifications | RSS feed

7.0.0

2 release files

6.3.0

2 release files

6.2.0

2 release files

6.0.0

2 release files

5.11.0

2 release files

5.10.0

2 release files

5.9.1

2 release files

5.9.0

2 release files

5.8.0

2 release files

5.7.0

2 release files

5.6.0

2 release files

This release

5.5.1 This release

2 release files

5.5.0

2 release files

5.4.0

2 release files

5.3.0

2 release files

5.2.0

2 release files

5.1.0

2 release files

5.0.0

2 release files

4.7.9

2 release files

4.7.8

2 release files

4.7.7

2 release files

4.7.6

2 release files

4.7.5

2 release files

4.7.4

2 release files

4.7.3

2 release files

4.7.2

2 release files

4.7.1

1 release file

2.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page