/qmk_firmware

keyboard controller firmware for Atmel AVR and ARM USB families

Primary LanguageCGNU General Public License v2.0GPL-2.0

GibDox Keyboard layout

Gib Instructions

Set up Machine

  • Install the prerequisites from here.
brew install qmk/qmk/qmk
# If you don't already have this repo, provide a non-existent path and `qmk setup` will clone it for you.
qmk setup -H /path/to/qmk_firmware

Flash Keyboard

  • Run for each hand (with the left hand plugged in directly, and the keyboard in flash mode):
# Flashes the left hand as the directly connected one.
make ergodox_infinity:gib:dfu-util MASTER=left
# Flashes the right hand as the indirectly connected one.
make ergodox_infinity:gib:dfu-util

Keep a paperclip handy in case you brick your device (can't get it into reset mode to flash new firmware), in which case you want to hit the reset buttons on the bottom of each half.

More than one DFU device found

If you hit this error:

dfu-util: Invalid DFU suffix signature
dfu-util: A valid DFU suffix will be required in a future dfu-util release!!!
dfu-util: More than one DFU capable USB device found! Try `--list' and specify the serial number or disconnect all but one device

Try dfu-util -l, and see what the other device is. In my case I had one called runtime. The workaround is to run make with the keyboard plugged in but not in flash mode. When you see execution halt on these lines:

dfu-util: error detaching
Resetting USB...

then put the keyboard into flash mode. This works reliably for me.

Original README below:

Quantum Mechanical Keyboard Firmware

Current Version Discord Docs Status GitHub contributors GitHub forks

This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.

Documentation

The docs are powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" link at the bottom of any page.

Supported Keyboards

The project also includes community support for lots of other keyboards.

Maintainers

QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.