keyboards/ps2avrGB/README.md

   1 ps2avrGB keyboard firmware
   2 ==========================
   3
   4 This is a port of the QMK firmware for boards that are based on the
   5 ps2avrGB firmware, like the [ps2avrGB
   6 keyboard](https://www.keyclack.com/product/gb-ps2avrgb/) or the ones sold
   7 by [Winkeyless](http://winkeyless.kr/product/ps2avrgb-parts/).
   8
   9 Note that this is a complete replacement for the firmware, so you won't be
  10 using Bootmapper Client to change any keyboard settings, since not all the
  11 USB report options are supported.
  12
  13 ## Supported Boards
  14
  15 Only the [B.mini X2](http://winkeyless.kr/product/b-mini-x2-pcb/) has been
  16 tested so far (since it's the only one I own). But other boards that use
  17 the ps2avrGB firmware should work as well.
  18
  19 ## Installing
  20
  21 First, install the requirements. These commands are for OSX, but all you
  22 need is the AVR toolchain and `bootloadHID` for flashing:
  23
  24 ```
  25 $ brew cask install crosspack-avr
  26 $ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
  27 ```
  28
  29 In order to use the `./program` script, which can reboot the board into
  30 the bootloader, you'll need Python 2 with PyUSB installed:
  31
  32 ```
  33 $ pip install pyusb
  34 ```
  35
  36 Then, with the keyboard plugged in, simply run this command from the
  37 `qmk_firmware` directory:
  38
  39 ```
  40 $ make ps2avrGB:program
  41 ```
  42
  43 If you prefer, you can just build it and flash the firmware directly with
  44 `bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it
  45 in the bootloader:
  46
  47 ```
  48 $ make ps2avrGB
  49 $ bootloadHID -r ps2avrGB_default.hex
  50 ```
  51
  52 ## Setting the board to bootloader mode
  53
  54 If you're lucky, the programming script does this automagically for you. If
  55 however this doesn't work for you, you need to enter the bootloader mode manually
  56 by plugging the keyboard in while holding the bootloader key. If you did this
  57 correctly the LEDs will blink and you'll be able to flash your firmware.
  58
  59 The bootloader key is the top left key of your matrix. For a standard board
  60 from winkeyless.kr this is `L_Ctrl`, but for some custom boards running ps2avrGB
  61 this might be different. For the Pearl it's `Esc`, for a b.fake it is `q`. If
  62 you're unsure you should be able to see the key in the bootmapper client.
  63
  64
  65 ## Troubleshooting
  66
  67 From my experience, it's really hard to brick these boards. But these
  68 tricks have been useful when it got stuck in a weird scenario.
  69
  70 1. Try plugging the board in while holding the bootloader key. This will force
  71    it to boot only the bootloader without loading the firmware. Once this is
  72    done, just reflash the board with the original firmware.
  73 2. Sometimes USB hubs can act weird, so try connecting the board directly
  74    to your computer or plugging/unplugging the USB hub.