From e60057f640d4bc746caacc2530d7b7c007e50eb6 Mon Sep 17 00:00:00 2001 From: "Sebastian H. Gabrielli" Date: Thu, 7 Jul 2022 17:52:17 +0200 Subject: [PATCH] Added README.md and udev rule --- 50-sebaweb-keyboard.rules | 2 ++ README.md | 25 +++++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 50-sebaweb-keyboard.rules create mode 100644 README.md diff --git a/50-sebaweb-keyboard.rules b/50-sebaweb-keyboard.rules new file mode 100644 index 0000000..3f2de38 --- /dev/null +++ b/50-sebaweb-keyboard.rules @@ -0,0 +1,2 @@ +# Rule to give userspace access to the test keyboard +SUBSYSTEMS=="usb", ATTRS{idVendor}=="cafe", ATTRS{idProduct}=="53ba", TAG+="uaccess" diff --git a/README.md b/README.md new file mode 100644 index 0000000..a54f520 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Custom keyboard control software +This is a piece of software to control the RGB on sebaweb developed rp2040 based keyboards. + +## Compiling +Linux is currently the only supported platform, if you wish to help with porting the software to other platforms you are free to do so. +To compile the program use `cargo` +``` +cargo build --release +``` + +## Installing on linux +Linux is currently the only supported platform, if you wish to help with porting the software to other platforms you are free to do so. +To install the software copy the compiled binary into `/usr/bin/` and the udev rule into `/etc/udev/rules.d/` +TODO: Make makefile or install script +``` +cargo build --release && sudo cp ./target/release/keyboard_control_software /usr/bin/. +sudo cp ./50-sebaweb-keyboard.rules /etc/udev/rules.d/. +``` +NOTE: Do not run the program with sudo rights, for some reason it crashes ¯\\_(ツ)_/¯ + +## Future plans (In no specific order) +- Support other OSes +- Find a better way to select keys that allow for selecting multiple keys at once +- Make keys the colour they currently are on the hardware +- Add function to request the current colours from the device at startup so the colours are synchronized \ No newline at end of file