keyboards/xd75/readme.md

   1 xd75 keyboard firmware
   2 ======================
   3
   4 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!
   5
   6 ## Quantum MK Firmware
   7
   8 For more info on this firmware (and how to make it your own), head over to [qmk.fm](http://qmk.fm).
   9
  10 ## Building
  11
  12 Download or clone the whole firmware and navigate to the
  13 keyboards/xd75 folder. Once your dev env is setup, you'll be able to
  14 type `make` to generate your .hex - you can then use the Teensy Loader
  15 to install the resulting .hex file, or have the `make` process install
  16 it using DFU.
  17
  18 ### Default
  19
  20 To build with the default keymap, simply run `make xd75:default` from the root directory (i.e. two levels above this file), and to install via DFU, `make xd75:default:dfu`, also from the root directory.
  21
  22 Note that DFU is likely to require root permissions, so installing the
  23 firmware likely requires a command line like:
  24
  25 ```
  26 $ sudo make xd75:default:dfu
  27 ```
  28
  29 ### LED control
  30
  31 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.
  32
  33 TODO: it would be nice to have PWM support on these LEDs for fade-in/fade-out effects.
  34
  35 ```c
  36 capslock_led_on();
  37 gp100_led_on();
  38 gp103_led_on();
  39 keycaps_led_on();
  40
  41
  42 // led_set_user example - you could also turn these on/off in response
  43 // to events in process_record_user or matrix_scan_user
  44 void led_set_user(uint8_t usb_led) {
  45     if (usb_led & (1<<USB_LED_CAPS_LOCK)) {
  46         capslock_led_on();
  47     } else {
  48         capslock_led_off();
  49     }
  50
  51     if (some_custom_state) {
  52       gp100_led_on();
  53     }
  54     else {
  55       gp100_led_off();
  56     }
  57 }
  58 ```
  59
  60 For the curious:
  61
  62 ```
  63 CAPSLOCK_LED    B2
  64 GP103_LED       F4
  65 KEYCAPS_LED     F5
  66 GP100_LED       F7
  67 ```
  68
  69 ### Other Keymaps
  70
  71 The "default" keymap included is basically the OLKB Atomic keymap with
  72 a few buttons added for RGB underglow control. This should be usable
  73 as a starting point, but most people will be best served creating
  74 their own keymap and flashing it - more info on creating your own
  75 keymap is available in [the official QMK
  76 documentation](https://docs.qmk.fm).
  77
  78 Keymaps follow the format **__\<name\>.c__** and are stored in
  79 subdirectories under `keyboards/xd75/keymaps`
  80
  81 To build the firmware binary hex file for a specific keymap, and
  82 install it, using DFU, just do `make` with a keymap like this:
  83
  84 ```
  85 $ make xd75:[default|<name>]
  86 ```
  87