Regium Klavye: A CLI application and python library for Royal Kludge keyboards

• Regium Klavye: A CLI application and python library for Royal Kludge keyboards
• Examples:
  • Command Line example:
  • Library Examples:

Regium klavye is a CLI application and python library that allows configuration for Royal Kludge keyboards. The application is mainly tested to run on Linux but should run on Windows and Mac OS.

The goal is to provide an easy to use, simple, library and command-line interface for Royal Kludge keyboards. While it started as a way to control my RK68 keyboard lighting in Linux, I intend to add support for more devices down the line.

This application does not have any affiliation with Royal Kludge. I am not reliable for any damage that the application may cause to your keyboard. In the case you do have problems, please create an issue so it can be fixed or removed all together depending on the severity.

Examples:

Command Line example:

$ python -m regium_klavye # Prints out help message.
$ python -m regium_klavye set-color -c red  # Sets the keyboard lighting to red.
$ python -m regium_klavye set-color -c 0 255 0  # Sets keyboard lighting to green.
$ python -m regium_klavye set-anim --anim neon_stream  # Set an animation with minimal parameters.
$ python -m regium_klavye set-anim --anim neon_stream --color 255 0 100 --color_mix 1 --sleep 1 --brightness 3 --speed 4  # Set an animation with its full parameters.

Library Examples:

Example for setting colors for the first supported and detected keyboard.

>>> from regium_klavye import rkapi
>>> keyboards = rkapi.get_keyboards()
>>> keyboard = keyboards[0]  # Assuming we want to change the first keyboard.
>>> keyboard.apply_color((255, 0, 255))  # Sets the keyboards lighting to red.

Example for setting colors for the a specific keyboard.

>>> from regium_klavye import rkapi
>>> my_keyboard = rkapi.get_keyboard(0x258a, 0x005e)  # Get the first supported keyboard with the specified vendor ID and and product ID.  
>>> my_keyboard.apply_color((0, 30, 200))  # Set the color for that keyboard.

For each keyboard please read supported commands from the documentation, as every implemented keyboard might not have full functionality.