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 This is an example based on the b.mini keyboard for making other keyboards
  14 compatible with QMK; fully supported boards have their own directory.
  15
  16 ## Supported Boards
  17
  18 - [b.fake](https://github.com/qmk/qmk_firmware/tree/master/keyboards/bfake)
  19 - [b.mini](https://github.com/qmk/qmk_firmware/tree/master/keyboards/bmini)
  20 - [b.face](https://github.com/qmk/qmk_firmware/tree/master/keyboards/bface)
  21 - [pearl](https://github.com/qmk/qmk_firmware/tree/master/keyboards/pearl)
  22
  23 ## Installing
  24
  25 First, install the requirements. These commands are for OSX, but all you
  26 need is the AVR toolchain and `bootloadHID` for flashing:
  27
  28 ```
  29 $ brew cask install crosspack-avr
  30 $ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
  31 ```
  32
  33 In order to use the `./program` script, which can reboot the board into
  34 the bootloader, you'll need Python 2 with PyUSB installed:
  35
  36 ```
  37 $ pip install pyusb
  38 ```
  39
  40 Then, with the keyboard plugged in, simply run this command from the
  41 `qmk_firmware` directory:
  42
  43 ```
  44 $ make ps2avrGB:program
  45 ```
  46
  47 If you prefer, you can just build it and flash the firmware directly with
  48 `bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it
  49 in the bootloader:
  50
  51 ```
  52 $ make ps2avrGB
  53 $ bootloadHID -r ps2avrGB_default.hex
  54 ```
  55
  56 ## Setting the board to bootloader mode
  57
  58 If you're lucky, the programming script does this automagically for you. If
  59 however this doesn't work for you, you need to enter the bootloader mode manually
  60 by plugging the keyboard in while holding the bootloader key. If you did this
  61 correctly the LEDs will blink and you'll be able to flash your firmware.
  62
  63 The bootloader key is the top left key of your matrix. For a standard board
  64 from winkeyless.kr this is `L_Ctrl`, but for some custom boards running ps2avrGB
  65 this might be different. For the Pearl it's `Esc`, for a b.fake it is `q`. If
  66 you're unsure you should be able to see the key in the bootmapper client.
  67
  68
  69 ## Troubleshooting
  70
  71 From my experience, it's really hard to brick these boards. But these
  72 tricks have been useful when it got stuck in a weird scenario.
  73
  74 1. Try plugging the board in while holding the bootloader key. This will force
  75    it to boot only the bootloader without loading the firmware. Once this is
  76    done, just reflash the board with the original firmware.
  77 2. Sometimes USB hubs can act weird, so try connecting the board directly
  78    to your computer or plugging/unplugging the USB hub.