Added Mechmini 2.0 to Mechmini keyboard folder

This creates a v1 and v2 subproject.  V1 retains all the same implementations of the bootmapper-ported Mechmnini 1 including #2196.  V2 adds the Mechmini 2.0 kayboard support (I know it took me way to long to get it a pull request in).

All readme's updated to reflect compiling the two seperate keyboards.  Simply either `make mechmini/v1:default` or `make mechmini/v2:defualt`.  Utilizing the rules.mk using `make mechmini:default` will automatically create the Mechmini 2 default keymap as this is the current version and has a much wider user base.
This commit is contained in:
TurboMech 2018-01-03 05:48:09 -05:00 committed by Jack Humbert
parent 0a5d302622
commit 9cb1d36974
27 changed files with 1163 additions and 214 deletions

View file

@ -1,13 +1,17 @@
mechmini
Mechmini
========
A compact ortholinear/staggered keyboard.
A 40% compact ortholinear/staggered keyboard.
Keyboard Maintainer: QMK Community
Hardware Supported: mechmini PCB
Hardware Availability: https://mechkeys.ca/collections/keyboards/products/mechmini-2-0-pcb
Version 1 was originally bootmapper (ps2avrGB) and can be ported to QMK following the v1 readme (../mechmini/v1/readme.md). This version is no longer in production.
Make example for this keyboard (after setting up your build environment):
Version 2 (Mechmini 2.0) was shipped powered by QMK [More info on MECHKEYS](https://mechkeys.ca).
Keyboard Maintainer: QMK Community (version 1) & [TurboMech](https://github.com/TurboMech) (version 2 - aka Mechmini 2.0)
Hardware Supported: Mechmini keyboard
Hardware Availability: https://mechkeys.ca/collections/keyboards/products/mechmini-2-0
Make example for this keyboard (after setting up your build environment), this will make the Mechmini 2.0 default keymap (split space) - please see v1 readme for v1 make instructions:
make mechmini:default
@ -15,50 +19,6 @@ See [build environment setup](https://docs.qmk.fm/build_environment_setup.html)
## Mechmini Notes
Note that this is a complete replacement for the firmware, so you won't be
using Bootmapper Client to change any keyboard settings, since not all the
USB report options are supported.
There are 2 versions of the Mechmini keyboard. Please read the readme for the version you have for make instructions.
## Installing
First, install the requirements. These commands are for OSX, but all you
need is the AVR toolchain and `bootloadHID` for flashing:
```
$ brew cask install crosspack-avr
$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
```
In order to use the `./program` script, which can reboot the board into
the bootloader, you'll need Python 2 with PyUSB installed:
```
$ pip install pyusb
```
Then, with the keyboard plugged in, simply run this command from the
`qmk_firmware` directory:
```
$ make mechmini:program
```
If you prefer, you can just build it and flash the firmware directly with
`bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it
in the bootloader:
```
$ make mechmini
$ bootloadHID -r mechmini_default.hex
```
## Troubleshooting
From my experience, it's really hard to brick these boards. But these
tricks have been useful when it got stuck in a weird scenario.
1. Try plugging the board in while pressing `L_Ctrl`. This will force it
to boot only the bootloader without loading the firmware. Once this is
done, just reflash the board with the original firmware.
2. Sometimes USB hubs can act weird, so try connecting the board directly
to your computer or plugging/unplugging the USB hub.