libaxion-dmx 1.0.5

A Python API for controlling Axion Lighting DMX controllers

Axion DMX API

Axion DMX API is a Python library to interact with the Axion Lighting DMX Controller. This package allows you to control various types of DMX lighting channels, including RGB, RGBW, and RGBWW.

Installation

Install the package via pip:

pip install libaxion_dmx

Usage

Initialize the API

To use the API, create an instance of the AxionDmxApi class with the IP address of your DMX controller and the password.

from libaxion_dmx import AxionDmxApi

api = AxionDmxApi(host="192.168.1.2", password="your_password")

Get Name

Get the hostname of the controller:

name = await api.get_name()
if name:
    print(f"Successfully retrieved the name of the controller: {name}")

Authenticate

Authenticate with the controller:

authenticated = await api.authenticate()
if authenticated:
    print("Successfully authenticated with the controller.")

Set Channel Level

Set the level of a specific channel:

await api.set_level(channel=1, level=255)

Get Channel Level

Get the current level of a specific channel:

level = await api.get_level(channel=1)
print(f"Channel 1 level: {level}")

Set Color (RGB)

Set the RGB color of a specific channel:

await api.set_color(channel=1, rgb=(255, 0, 0))  # Set to Red

Set RGBW Color

Set the RGBW color of a specific channel:

await api.set_rgbw(channel=1, rgbw=(255, 0, 0, 255))  # Set to Red with White

Set RGBWW Color

Set the RGBWW color of a specific channel:

await api.set_rgbww(channel=1, rgbww=(255, 0, 0, 255, 128))  # Set to Red with Warm White

Testing

To run the tests for this package, use pytest.

License

This project is licensed under the MIT License - see the LICENSE file for details.