Controls the RGB lighting on some keyboards. Tested on Linux and FreeBSD, should work on other operating systems.
Disclaimer: This software is not supported by the manufacturer of the hardware in any way, and relies completely on information from reverse-engineering. There is no warranty, especially in case of damage to the hardware.
USB keyboards with VID 0x0c45, maybe others.
| Name | PID | Tested | Uses control transfer mode |
|---|---|---|---|
| Tecware Phantom RGB TKL ANSI and TKL ISO Glorious GMMK full-size ANSI and TKL ANSI |
0x652f | Yes | No |
| Ajazz AK33 | 0x7903 | Yes | Yes |
| Redragon K550 Yama | 0x5204 | Yes | Yes |
| Redragon K556 Devarajas Redragon K587 PRO Magic Wand Redragon Mitra RGB Redragon SURARA K582 Redragon K589 Shrapnel |
0x5004 | Yes | Yes |
| Redragon K552 Kumara | 0x5104 | Yes | Yes |
| Warrior Kane TC235 | 0x8520 | No | (Yes) |
See --control option for details on the control transfer mode.
You can help to expand this list by providing information whether this software works correctly or not.
Known issues that require your help (please open an issue or pull request if you want to contribute):
- Remapping keys on the Ajazz AK33 and some ISO boards is broken (all keys are shifted around). Remapping works on the Tecware Phantom TKL ISO, but there might be different firmware versions, so be careful when trying this.
- Setting the USB report/poll rate on the Ajazz AK33 is untested
- Custom led patterns don't work correctly on the Redragon K550 Yama, K556 Devarajas and K587 PRO Magic Wand.
- Clone this repository or download a release
git clone https://github.com/dokutan/rgb_keyboard
cd ./rgb_keyboard
- Make sure you have libusb installed (on some distros (e.g. Ubuntu) you might need a dev package)
An AUR package is available.
- compile and copy everything to the right place with (not required: replace the 4 with the number of cpu cores you have)
make -j4
sudo make install
- restart for the udev rule to take effect (without this you probably won't be able to use this softwate without root)
- install pkgconf
- compile with
make CC=clang++ -j4
- copy
rgb_keyboardto some directory in your $PATH, or execute it directly with
./rgb_keyboard
- Current limitations on FreeBSD:
- You need root privileges to use the program
- After the program has finished, the keyboard won't work and needs to be unplugged and plugged back in.
Compiling and running on OS X is not properly tested or supported because i don't have access to a machine with OS X. However all dependencies are available and compiling with clang should work (more information), your feedback and contributions are welcome.
rgb_keyboard --help
to see all options
rgb_keyboard --list-keys arg
to see all keynames (arg = led, map, option)
For the gui see the appropriate section below
Three individual profiles (1-3) are stored on the keyboard. Examples:
rgb_keyboard --active 2
to change to the second profile.
rgb_keyboard --profile 3 ⟨further options⟩
to apply settings to profile 3. Without this option profile 1 is used.
rgb_keyboard --brightness 5 --speed 2 --color 00ff00 --leds rain
to set a specific pattern.
rgb_keyboard --custom-pattern example.conf
to set a custom pattern from a file.
rgb_keyboard --keymap example.keymap
to set a custom keymap from a file.
Take a look at example.conf and example.keymap. Use the --layout option if your keyboard is not an ANSI one, e.g. --layout brazil.
Similar to the config file, instead of a tab an equal sign and instead of a newline a semicolon is being used. Comments are not allowed. The string must end with a semicolon.
rgb_keyboard --custom-keys "key_name=color;key_name=color;"
In case you have multiple keyboards attached or you suspect a keyboard with a different vendor id or product id might be compatible, the keyboard can also be opened by specifying the bus number and device id. These can be found by running lsusb.
rgb_keyboard --bus ⟨bus id⟩ --device ⟨device number⟩ ...
On some systems libusb might no be able to properly detach the kernel driver, and the program will fail to open the keyboard. The --kernel-driver option skips this step and is intended for better compatibility.
Don't open usb interface 0 on the keyboard. This allows input to happen while settings are applied, and is primarily intended for scripting purposes. Because compatibility is untested, this needs to be specifically enabled with this option.
This is the replacement for the --ajazzak33 or -A option. This option expects true or false as an argument and toggles the control transfer mode to send data. Normally this shouldn't be required as the program attempts to use the right mode automatically.
A separate frontend written in Tcl/Tk exists, however not all features are implemented. Running the gui:
chmod +x rgb_keyboard-gui.tcl
./rgb_keyboard-gui.tcl
The gui is not copied to /usr/bin by default, you can do so manually.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.