cm-rgb-cli - Man Page

configure the RGB LEDs on the AMD Wraith Prism / CM RGB cooler

Description

cm-rgb-cli talks to the AMD Wraith Prism (CM RGB) cooler over USB HID and configures its logo, fan, and ring LEDs.

The set command is a chain of subcommands (logo, fan, ring, save); any combination may be given on one invocation, and the combined configuration is applied to the device in a single update once the chain finishes.

Commands

set [logo|fan|ring|save]...: Configure one or more LED channels and apply the result. See Set Subcommands below.
restore: Reset the device back to its onboard-saved configuration.
version: Print the device's firmware version.
add-udev-rule: Install a udev rule granting unprivileged access to the device. Must be run as root (e.g. via sudo) to write /etc/udev/rules.d/60-cm-rgb.rules; otherwise it prints the rule contents for manual installation.

Set Subcommands

logo

Configure the logo LED.

--color HEX: LED color as a hex triplet, e.g. #00FFFF (default: #00FFFF).
--mode MODE: One of off, static, breathe (default: static).
--speed 1-5: Animation speed, clamped to 1–5 (default: 3).
--brightness 1-5: LED brightness, clamped to 1–5 (default: 3).

fan

Configure the fan LED, optionally with the mirage fan-speed-strobe effect. Takes the same --color, --mode, --speed, and --brightness options as logo, plus:

--mirage-red-freq N: Mirage strobe frequency for the red channel, 3–32768.
--mirage-green-freq N: Mirage strobe frequency for the green channel, 3–32768.
--mirage-blue-freq N: Mirage strobe frequency for the blue channel, 3–32768.

ring

Configure the ring LEDs.

--color HEX: LED color as a hex triplet (default: #00FFFF).
--mode MODE: One of off, static, breathe, swirl, rainbow, cycle (default: static).
--speed 1-5: Animation speed, clamped to 1–5 (default: 3).
--brightness 1-5: LED brightness, clamped to 1–5 (default: 3).