keyboards/xd75/readme.md

   1 # XD75
   2
   3 ![XD75](https://cdn.shopify.com/s/files/1/2711/4238/products/HTB1MzOISXXXXXXgXpXXq6xXFXXXO_1024x1024.jpg)
   4
   5 The XD75Re is a 15x5 full-grid ortholinear keyboard manufactured by XIUDI. 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!
   6
   7 Keyboard Maintainer: [The QMK Community](https://github.com/qmk)
   8 Hardware Supported: XD75Re
   9 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)
  10
  11 Make example for this keyboard (after setting up your build environment):
  12
  13     make xd75:default
  14
  15 Flashing example:
  16
  17     make xd75:default:dfu
  18
  19 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).
  20
  21
  22 ## LED control
  23
  24 There are 3 individual LEDs that can be turned on and off, plus the keycap LEDs (which are all wired into the same pin).  The functions are named according to how they're labeled on the PCB.
  25
  26 TODO: it would be nice to have PWM support on these LEDs for fade-in/fade-out effects.
  27
  28 ```c
  29 capslock_led_on();
  30 gp100_led_on();
  31 gp103_led_on();
  32 keycaps_led_on();
  33
  34
  35 // led_set_user example - you could also turn these on/off in response
  36 // to events in process_record_user or matrix_scan_user
  37 void led_set_user(uint8_t usb_led) {
  38     if (usb_led & (1<<USB_LED_CAPS_LOCK)) {
  39         capslock_led_on();
  40     } else {
  41         capslock_led_off();
  42     }
  43
  44     if (some_custom_state) {
  45       gp100_led_on();
  46     }
  47     else {
  48       gp100_led_off();
  49     }
  50 }
  51 ```
  52
  53 For the curious:
  54
  55 ```
  56 CAPSLOCK_LED    B2
  57 GP103_LED       F4
  58 KEYCAPS_LED     F5
  59 GP100_LED       F7
  60 ```