Added README.md and udev rule
This commit is contained in:
parent
871bdaf9c0
commit
e60057f640
2
50-sebaweb-keyboard.rules
Normal file
2
50-sebaweb-keyboard.rules
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Rule to give userspace access to the test keyboard
|
||||||
|
SUBSYSTEMS=="usb", ATTRS{idVendor}=="cafe", ATTRS{idProduct}=="53ba", TAG+="uaccess"
|
||||||
25
README.md
Normal file
25
README.md
Normal file
@ -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
|
||||||
Loading…
Reference in New Issue
Block a user