A python client for the OpenRGB SDK
Project description
OpenRGB-Python
OpenRGB-Python is a client for the OpenRGB SDK, a manufacturer-independent, cross-platform way to control your RGB devices. OpenRGB-Python can be used to interface with other programs, create custom effects, or anything else you can think of!
I started this project because I wanted to be able to control the color of my lights based on temps. I tried to implement the features in the best (easiest to use) way possible.
SDK Feature Support:
- Setting client name
- Getting device info
- Setting color by device
- Setting color by zone
- Setting color by led
- Setting mode
- Setting custom mode
- Resizing zones
Additional Features (Not part of the OpenRGB SDK):
- Loading profiles
- Saving profiles
Installation
requires python >= 3.7
Use this method for the newest, but possibly buggy, package:
pip3 install git+https://github.com/jath03/openrgb-python#egg=openrgb-python
Arch Linux:
yay -S python-openrgb-git
For a more stable package:
pip3 install openrgb-python
Arch Linux:
This AUR package is out of date. Use yay -S python-openrgb
python-openrgb-git
instead.
Thanks to @GabMus for the AUR packages
Usage
from openrgb import OpenRGBClient
from openrgb.utils import RGBColor, DeviceType
client = OpenRGBClient()
client.clear() # Turns everything off
motherboard = client.get_devices_by_type(DeviceType.MOTHERBOARD)[0]
motherboard.set_color(RGBColor(0, 255, 0))
motherboard.zones[0].set_color(RGBColor(255, 0, 0))
motherboard.zones[1].leds[0].set_color(RGBColor.fromHSV(0, 100, 100))
motherboard.set_mode("breathing")
client.save_profile("profile1")
Documentation
https://openrgb-python.readthedocs.io/en/latest/
For an alternative python implementation, check out B Horn's OpenRGB-PyClient
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.
Source Distribution
Built Distribution
Hashes for openrgb_python-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25ec408bf0bae120b22a4afaa671d1c0172ebb112bcb64493b427b0f06b06bb0 |
|
MD5 | 1f16cb536acf5130ae15ec1b54651fe4 |
|
BLAKE2b-256 | e70be3b7529452865737d6f808422606cc4d1766595a6bf8246a6ecad1e4791f |