Skip to main content

Python HDMI Matrix control library for AVGear and possibly other HDMI matrix controllers

Project description

AVGear HDMI Matrix Python Library

Python library to control AVGear HDMI Matrix switches (tested with TMX44PRO AVK, may work with others). Both synchronous and asynchronous APIs are provided. Contributions for other models are welcome!

This is used for the AVGear Matrix integration for homeassistant.

Inspired by pyblackbird.

Features

  • TCP/IP control: Communicate with the matrix over the network
  • Sync & Async APIs: Use either blocking or asyncio-based methods
  • Device info: Query device name, type, version, and status
  • Routing control: Route HDMI inputs to outputs programmatically
  • Video status parsing: Parse and display current input/output routing
  • Context manager support: Use with with or async with for auto-connect/disconnect
  • Logging: Built-in debug/info/error logging

Installation

Clone the repo and install dependencies (if any):

git clone https://github.com/marklynch/hdmimatrix.git
cd hdmimatrix
# Optionally: pip install .

Usage

Synchronous Example

from hdmimatrix import HDMIMatrix

matrix = HDMIMatrix("192.168.0.178", 4001)
with matrix:
    print(matrix.get_device_name())
    print(matrix.get_device_status())
    matrix.route_input_to_output(1, 1)

Asynchronous Example

import asyncio
from hdmimatrix import AsyncHDMIMatrix

async def main():
    matrix = AsyncHDMIMatrix("192.168.0.178", 4001)
    async with matrix:
        print(await matrix.get_device_name())
        print(await matrix.get_device_status())
        await matrix.route_input_to_output(1, 1)

asyncio.run(main())

Video Status Parsing

with matrix:
    routing = matrix.get_video_status_parsed()
    print(routing)  # {output_number: input_number}

API Overview

  • HDMIMatrix (sync) and AsyncHDMIMatrix (async) classes
  • Connection:
    • connect()
    • disconnect()
    • Context manager support (with / async with)
  • Info:
    • get_device_name()
    • get_device_status()
    • get_device_type()
    • get_device_version()
    • get_video_status()
    • get_video_status_parsed()
    • get_hdbt_power_status()
    • get_input_status()
    • get_output_status()
  • Control:
    • power_on()
    • power_off()
    • route_input_to_output(input, output)

Contributing

Pull requests for new features, bug fixes, and support for other AVGear models are welcome!

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hdmimatrix-0.0.4.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hdmimatrix-0.0.4-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file hdmimatrix-0.0.4.tar.gz.

File metadata

  • Download URL: hdmimatrix-0.0.4.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for hdmimatrix-0.0.4.tar.gz
Algorithm Hash digest
SHA256 03290d4b68a1fbe79d7ac176bb2f3d8eff7c17b41dce1021a903d33ee802fabd
MD5 8b79a3944a128d31e1a2cb440082c48c
BLAKE2b-256 00f15f689fd42e928bcbe50a3e590f3d4c42ecae23dd3deac1c3204ffdd313ba

See more details on using hashes here.

File details

Details for the file hdmimatrix-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: hdmimatrix-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for hdmimatrix-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6e484d8f144574ced5cbdd6bacf37cd53319ff996a57dfa120c5bfe875654300
MD5 d4beb2bb11ce4127d4089862534ea50d
BLAKE2b-256 cf3c3d81ecd1b3f143d626c709615ebc66c0ced6eee2d50e328075f6385cdd47

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page