Installation of keyboard drivers for TUXEDO models with RGB keyboard - TUXEDO Computers

For Ubuntu and openSUSE there are ready to install packages in our repositories.
These are also available in the official Manjaro repository. Some distributions (like Arch Linux) are offering this driver maintained by third-party contributors.

The following manual to compile the driver module by yourself is aimed at experts. If your TUXEDO has been pre-installed by us (or if you've used WebFAI), you can skip the first section of this manual.

Compiling the driver

The following dependencies must be considered for compiling:

• make
• gcc
• linux-headers
• dkms

As an example for Ubuntu-based systems, the following is performed:

sudo apt install git dkms build-essential linux-headers-$(uname -r)

If you have executed a TUXEDO pre-installation or the tuxedo.sh, please remove the possibly existing tuxedo-wmi driver or add it to the blacklist:

sudo -s
echo "blacklist tuxedo-wmi" | sudo tee -a /etc/modprobe.d/blacklist.conf

Now you can download and compile the module:

git clone https://github.com/tuxedocomputers/tuxedo-keyboard
cd tuxedo-keyboard/
git checkout release
make clean && mak

To install the module:

make clean
sudo make dkmsinstall

Now you have to add the module to the autostart:

sudo su
echo tuxedo_keyboard >> /etc/modules

And so you can start the driver module directly:

sudo modprobe tuxedo_keyboard

When you uninstall drivers, you must do the following:

sudo make dkmsremove
sudo rm -rf /etc/modprobe.d/tuxedo_keyboard.conf

Usage

It can be controlled via the numeric keyboard on the right part of the keyboard, combined with the function key at the bottom left.

• Fn + Plus = Brighter
• Fn + Minus = Darker
• Fn + Multiplication = Turn Off/On
• Fn + Division = Change Mode

However, our Polaris und Fusion 15 are using a different keyboard-design,  Fn + Spacebar is being used instead to adjust the Brightness / On-Off-State.

A graphical user interface to adjust the colours is already in the works. Until then, you can adjust the configuration files.
 

Option 1 - Works on most models except Polaris, Polaris and Fusion 15

For example, the following two commands sets the default color to white (which is blue by default)

sudo su
echo "options tuxedo_keyboard mode=0 color_left=0xFFFFFF color_center=0xFFFFFF color_right=0xFFFFFF" > /etc/modprobe.d/tuxedo_keyboard.conf

The bold sections denote the color section, the underlined section the color value in hexadecimal code. The latter can easily be determined via the following website or in an image processing program (e.g. Gimp).

https://www.farb-tabelle.de/en/table-of-color.htm

Example code for Ubuntu orange:
echo "options tuxedo_keyboard mode=0 color_left=0xE95420 color_center=0xE95420 color_right=0xE95420" > /etc/modprobe.d/tuxedo_keyboard.conf

These changes will be applied with every boot.

However, reloading the driver module will make the changes apply immediately:

Option 2 for Stellaris

sudo -s
echo "options tuxedo_keyboard color=WHITE" > /etc/modprobe.d/tuxedo_keyboard.conf

Hex-Values are not implemented yet, but fixed colors can be used.

This command lists all possible colors:
 

cat /sys/devices/platform/tuxedo_keyboard/uw_kbd_bl_color/color_string

Option 3 für XP15 / XP17 Gen 12 and XUX7 from Gen 11 on

These keyboards do offer a per-key backlight control. The colours are being defined via a value between 0 - 255.
In this example, we set it to "white":
sudo -s
echo "options tuxedo_keyboard-ite color_green=255 color_red=255 color_blue=255 set_color=1 > /etc/modprobe.d/tuxedo_keyboard.conf
 

Special Notes for XMG Fusion 15

The lightbar below can be finally controlled, albeit a bit different "fussy", we are working on it.

Enthusiasts can take a deeper look at the parameters in /sys/class/leds.

• The LEDs are being controlled individually and not "all at once".
• Brightness is specified by a value between 0 - 36.
• The color of the keyboard itself cannot be controlled, yet. A driver update will be released for that matter soon.

To change the color to "White", one can simply set all color areas to it's maximum value.

sudo -s
echo 36 > /sys/class/leds/lightbar_rgb\:1\:status/brightness
echo 36 > /sys/class/leds/lightbar_rgb\:2\:status/brightness
echo 36 > /sys/class/leds/lightbar_rgb\:3\:status/brightness

Special Notes for Polaris & Stellaris:

On Polaris and Stellaris models, the brightness is controlled via Fn+Spacebar. Color control via hotkey is not implemented yet. (Numblock does not work).

The following steps are intended for interested and experienced Linux users.

The syntax for controlling the colors is a bit different from the other models. To set the color "Blue" as default, you have to unload the module first:

sudo rmmod tuxedo_keyboardThen you can set and load the new color:

sudo -s echo "options tuxedo_keyboard color=BLUE" > /etc/modprobe.d/tuxedo_keyboard.confAt runtime, you can switch to "Blue" with:

sudo modprobe tuxedo_keyboard color=BLUESupported colors are:

BLACK, RED, GREEN, BLUE, YELLOW, MAGENTA, CYAN, WHITESee also:

cat /sys/devices/platform/tuxedo_keyboard/uw_kbd_bl_color/color_stringColor values in hex code are not yet supported, but a solution is already in the works.

More modes and technical details can be found here: https://github.com/tuxedocomputers/tuxedo-keyboard