keyboards/mechmini/readme.md

   1 mechmini
   2 ========
   3
   4 A compact ortholinear/staggered keyboard.
   5
   6 Keyboard Maintainer: QMK Community
   7 Hardware Supported: mechmini PCB
   8 Hardware Availability: https://mechkeys.ca/collections/keyboards/products/mechmini-2-0-pcb
   9
  10 Make example for this keyboard (after setting up your build environment):
  11
  12     make mechmini:default
  13
  14 See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
  15
  16 ## Mechmini Notes
  17
  18 Note that this is a complete replacement for the firmware, so you won't be
  19 using Bootmapper Client to change any keyboard settings, since not all the
  20 USB report options are supported.
  21
  22 ## Installing
  23
  24 First, install the requirements. These commands are for OSX, but all you
  25 need is the AVR toolchain and `bootloadHID` for flashing:
  26
  27 ```
  28 $ brew cask install crosspack-avr
  29 $ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
  30 ```
  31
  32 In order to use the `./program` script, which can reboot the board into
  33 the bootloader, you'll need Python 2 with PyUSB installed:
  34
  35 ```
  36 $ pip install pyusb
  37 ```
  38
  39 Then, with the keyboard plugged in, simply run this command from the
  40 `qmk_firmware` directory:
  41
  42 ```
  43 $ make mechmini:program
  44 ```
  45
  46 If you prefer, you can just build it and flash the firmware directly with
  47 `bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it
  48 in the bootloader:
  49
  50 ```
  51 $ make mechmini
  52 $ bootloadHID -r mechmini_default.hex
  53 ```
  54
  55 ## Troubleshooting
  56
  57 From my experience, it's really hard to brick these boards. But these
  58 tricks have been useful when it got stuck in a weird scenario.
  59
  60 1. Try plugging the board in while pressing `L_Ctrl`. This will force it
  61    to boot only the bootloader without loading the firmware. Once this is
  62    done, just reflash the board with the original firmware.
  63 2. Sometimes USB hubs can act weird, so try connecting the board directly
  64    to your computer or plugging/unplugging the USB hub.