Skip to content

1. Installation & Configuration

gfduszynski edited this page Sep 28, 2020 · 3 revisions

1. Prerequisites

1.1. USB Cable

Make sure you have connected USB cable to your cooler.
Do NOT connect RGB Header cable or the cooler will go bananas.
Mixing those two together is not supported by cm-rgb and probably by the cooler itself.

You can verify that your cooler is available by running:

lsusb | grep 2516:0051

You should get something like this:

Bus 003 Device 003: ID 2516:0051 Cooler Master Co., Ltd.

1.2. Dependencies

We need to install dependencies for cython-hidapi(https://github.com/trezor/cython-hidapi) before we proceed to install cm-rgb.

Ubuntu
sudo apt-get install python-dev libusb-1.0-0-dev libudev-dev
Arch
sudo pacman -S libusb hidapi

NOTE: If you experience problems with hidapi you may also try package from the AUR which should satisfy the dependency.

pacaur -S python-hidapi
Gentoo

You might want to see available ebuild: https://github.com/gfduszynski/cm-rgb/issues/12

Other platforms

It's possible you already have what is necessary to install cm-rgb pip package so give it a try. If you have any problems regarding hidapi installation check cython-hidapi, your issue may already have a solution there.

If you still have a problem please create an issue :)

2. Installation

Stick with the pip if you don't have a good reason to install from git.

A. Installing from PIP

This is pretty straight forward.

pip install cm-rgb
B. Installing from Git
git clone https://github.com/gfduszynski/cm-rgb.git
cd cm-rgb
pip install .

3. Configuration

Script must have access to USB device to function properly. It would be wise not to run this as root.

Run following to add udev rule :

cm-rgb-cli add-udev-rule

It may be required to reload udev for changes to take effect.
Now you should be able to run cm-rgb-cli without sudo.

4. Usage

See wiki page for tips on how to use the cli & monitor. (TODO)