diff options
Diffstat (limited to 'keyboards/xiudi/xd75/readme.md')
| -rw-r--r-- | keyboards/xiudi/xd75/readme.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/keyboards/xiudi/xd75/readme.md b/keyboards/xiudi/xd75/readme.md new file mode 100644 index 0000000000..65da5cc02a --- /dev/null +++ b/keyboards/xiudi/xd75/readme.md @@ -0,0 +1,57 @@ +# XD75 + + + +The XD75 is a 15x5 full-grid ortholinear keyboard manufactured by XIUDI. Available in two different versions: XD75Re with hot swap switch sockets and XD75Am with Alps+MX Stem support that needs soldering. + +This port of the QMK firmware is my first shot at using QMK, so if you see any features done wrong (or just plain missing), feel free to fix them and put in a pull request! + +* Keyboard Maintainer: [The QMK Community](https://github.com/qmk) +* Hardware Supported: XD75Re, XD75Am +* Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd75re-xd75am-xd75-xiudi-60-custom-keyboard-pcb), [AliExpress](https://www.aliexpress.com/item/xd75re-Custom-Mechanical-Keyboard-75-keys-TKG-TOOLS-Underglow-RGB-PCB-GH60-60-programmed-gh60-kle/32818745981.html) + +Make example for this keyboard (after setting up your build environment): + + make xd75:default + +Flashing example for this keyboard: + + make xd75:default:flash + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +## LED Control + +There are 3 individual LEDs that can be turned on and off. The functions are named according to how they're labeled on the PCB. + +TODO: it would be nice to have PWM support on these LEDs for fade-in/fade-out effects. + +```c +capslock_led_on(); +gp100_led_on(); +gp103_led_on(); + +bool led_update_user(led_t led_state) { + if (led_state.caps_lock) { + capslock_led_on(); + } else { + capslock_led_off(); + } + + if (some_custom_state) { + gp100_led_on(); + } else { + gp100_led_off(); + } + + return false; +} +``` + +For the curious: + +``` +CAPSLOCK_LED B2 +GP103_LED F4 +GP100_LED F7 +``` |