Python script to make OpenRGB lights available in MQTT
Project description
RGB2MQTT
This is a Python script that will act as a brige between an OpenRGB server and an MQTT broker (like Mosquitto). Useful for if you want to control your PC RGB lights via Home Assistant for example.
This script is inspired by the original script from ghomasHudson and the fork from buttercheetah. This script is licensed under the MIT license, so feel free to try or change it yourself!
Installation
Use pip install -e .
to install the required packages.
If you are running an older Python version (<3.11) than you also need to install tomli: pip install tomli
Configuration
Configuration is stored in a config.toml
file, see the config.toml.example
file.
To generate a configuration file run the rgb2mqtt-config
script after installing.
Be aware that in the device map section, you need to list the name of the OpenRGB device exactly as key.
To figure out which devices are supported by OpenRGB, see the notebooks/tryout_openrgb_sdk.ipynb
file.
Usage
The run the script, use python src/rgb2mqtt/rgb2mqtt.py
, or use rgb2mqtt-run
after installing.
If you want this script to autostart when your PC turns on (on Windows), use the rgb2mqtt-autostart
command.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.