Skip to main content

OpenRGB-Python

Documentation Status

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
  • 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: yay -S python-openrgb This AUR package is out of date. Use 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

Metadata

Release files for openrgb-python 0.3.8

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

Built distribution (wheel)

Table of built distributions (wheels) for openrgb-python 0.3.8
File Interpreter ABI Platform
openrgb_python-0.3.8-py3-none-any.whl Python 3 none any Details

Release files / openrgb_python-0.3.8-py3-none-any.whl

Download URL openrgb_python-0.3.8-py3-none-any.whl
Size 30.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6e61a92a2119c7cdab4e615302a0707cd8d8f12e3f001067a6b5fae0c5e7e7b2
BLAKE2b-256 checksum
How to use checksums
120a703b4318b508b123303e6ee4d8998e0efa778524fd8fd497fb35692dd54f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Security for openrgb-python 0.3.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.8 This release

1 release file No provenance

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