Tuxedo-rs 🐧+🦀=❤️

Rust libraries for interacting with hardware from TUXEDO Computers.

Tuxedo-rs is a community project. It is not developed nor supported by TUXEDO Computers.
Although we only supports TUXEDO hardware for now, other vendors are free to contribute their own bindings.

Motivation

The TUXEDO Control Center (TCC) is a neat application that allows you to control different parts of your hardware, such as fans, webcam and performance profiles. However, TCC and its tccd service rely on Node.js which makes it slow, memory hungry and hard to package.

Also, tuxedo-rs is modular and contains several crates with different levels of abstraction, which makes it easy for everyone to built their own tools on top.

Why Rust?

~~All software should be rewritten in Rust~~
Very robust code
Strong compile-time guarantees
High performance
Easy to package (no additional runtime or dependencies)

Structure

Tested hardware

This list includes devices that were successfully tested with tuxedo-rs. Since I have limited access to hardware, please consider adding your device(s) to the list.

TUXEDO Aura 15 Gen1
TUXEDO Pulse 14 Gen1

Installation

Currently, tuxedo-rs isn't available from package archives so you have to install it from source.

Tuxedo driver modules

If you use a distribution that doesn't package the required tuxedo hardware drivers, you can install the from source.

git clone https://github.com/tuxedocomputers/tuxedo-keyboard.git
cd tuxedo-keyboard
git checkout release
sudo make dkmsinstall

Tailord

Tailord is the system service that runs in the background and interacts with the driver modules. It exposes a D-BUS interface that can be used by applications to configure the hardware.

cd tailord
meson setup --prefix=/usr _build
ninja -C _build
ninja -C _build install

If you have the TUXEDO Control Center (TCC) and its daemons installed, make sure to deactivate them first.

sudo systemctl disable tccd.service 
sudo systemctl stop tccd.service 
sudo systemctl disable tccd-sleep.service 
sudo systemctl stop tccd-sleep.service

Then, enable tailord with the following commands:

sudo systemctl enable tailord.service 
sudo systemctl start tailord.service

Tailor GUI

Tailord will soon be available as flatpak. In the meantime, you can install it from source. If you're not building it with flatpak-builder, make sure you have the following dependencies installed on your system.

Ubuntu:

sudo apt install meson libadwaita-1-dev libgtk-4-dev

Arch Linux:

sudo pacman -S meson libadwaita gtk4

Fedora:

sudo dnf -y install meson libadwaita-devel gtk4-devel

Then build and install Tailor GUI with meson:

cd tailor_gui
meson setup --prefix=/usr _build
ninja -C _build
ninja -C _build install

Roadmap

Ioctl abstraction for tuxedo_io
Sysfs abstraction for tuxedo_keyboard
Support for hardware based on uniwill
Daemon with DBus interface for user space application
Client library for interacting with the daemon
CLI that interacts with the daemon
Native GUI that interacts with the daemon
OPTIONAL: Rewrite various tuxedo kernel modules in Rust

crisidev/tuxedo-rs