keyboards/mechmini/README.md

   1 mechmini 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
  14 ## Installing
  15
  16 First, install the requirements. These commands are for OSX, but all you
  17 need is the AVR toolchain and `bootloadHID` for flashing:
  18
  19 ```
  20 $ brew cask install crosspack-avr
  21 $ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
  22 ```
  23
  24 In order to use the `./program` script, which can reboot the board into
  25 the bootloader, you'll need Python 2 with PyUSB installed:
  26
  27 ```
  28 $ pip install pyusb
  29 ```
  30
  31 Then, with the keyboard plugged in, simply run this command from the
  32 `qmk_firmware` directory:
  33
  34 ```
  35 $ make mechmini-program
  36 ```
  37
  38 If you prefer, you can just build it and flash the firmware directly with
  39 `bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it
  40 in the bootloader:
  41
  42 ```
  43 $ make mechmini
  44 $ bootloadHID -r mechmini_default.hex
  45 ```
  46
  47 ## Troubleshooting
  48
  49 From my experience, it's really hard to brick these boards. But these
  50 tricks have been useful when it got stuck in a weird scenario.
  51
  52 1. Try plugging the board in while pressing `L_Ctrl`. This will force it
  53    to boot only the bootloader without loading the firmware. Once this is
  54    done, just reflash the board with the original firmware.
  55 2. Sometimes USB hubs can act weird, so try connecting the board directly
  56    to your computer or plugging/unplugging the USB hub.