update software documentation

2026-08-09 19:14:18 +02:00
parent 470942665e
commit 39a16e8650
7 changed files with 222 additions and 0 deletions
@@ -0,0 +1,23 @@
+.docname {Keychron Keyboard}
+.include {docs}
+
+# Keychron Keyboard
+
+To enable access to the keyboard for the QMK launcher (or similar programs), set the following udev rule in
+`/etc/udev/rules.d/99-keychron.conf`
+
+```
+# The Keyboard Itself
+KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="3434", ATTRS{idProduct}=="0aa1", MODE="0666", TAG+="uaccess", TAG+="udev-acl"
+# The 2.4 Ghz Wireless Dongle
+KERNEL=="hidraw*", SUBSYSTEM=="hidraw", ATTRS{idVendor}=="3434", ATTRS{idProduct}=="d030", MODE="0666", TAG+="uaccess", TAG+="udev-acl"
+```
+
+Values for `idVendor` and `idProduct` can be found with `lsusb | grep -i Keychron`.
+
+Reload the udev rules `udevadm control --reload-rules`
+
+## Firmware Updates
+
+To enable firmware updates, install `yay -S dfu-util` to provide the required toolbox.
+