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 Or if you have a MechMini:
  44
  45 ```
  46 $ make ps2avrGB-mechmini-program
  47 ```
  48
  49 If you prefer, you can just build it and flash the firmware directly with
  50 `bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it
  51 in the bootloader:
  52
  53 ```
  54 $ make ps2avrGB
  55 $ bootloadHID -r ps2avrGB_default.hex
  56 ```
  57
  58 ## Troubleshooting
  59
  60 From my experience, it's really hard to brick these boards. But these
  61 tricks have been useful when it got stuck in a weird scenario.
  62
  63 1. Try plugging the board in while pressing `L_Ctrl`. This will force it
  64    to boot only the bootloader without loading the firmware. Once this is
  65    done, just reflash the board with the original firmware.
  66 2. Sometimes USB hubs can act weird, so try connecting the board directly
  67    to your computer or plugging/unplugging the USB hub.