Skip to main content

A python client for the OpenRGB SDK

Project description

openrgb-python

Documentation Status

A python client for the OpenRGB SDK

I started this project because I wanted to be able to control the color of my lights based on temps. Because of this goal, the full functionality of the OpenRGB SDK isn't implemented, but I tried to implement the supported 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

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

For a more stable package:

pip3 install openrgb-python

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.DEVICE_TYPE_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))

API docs

https://openrgb-python.readthedocs.io/en/stable/

For an alternative python implementation, check out B Horn's OpenRGB-PyClient

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

openrgb-python-0.0.3.tar.gz (7.0 kB view hashes)

Uploaded Source

Built Distribution

openrgb_python-0.0.3-py3-none-any.whl (20.8 kB view hashes)

Uploaded Python 3

Supported by

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