Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/qmk/qmk_toolbox

A Toolbox companion for QMK Firmware
https://github.com/qmk/qmk_toolbox

atmel avr caterina dfu macos qmk qmk-firmware stm32

Last synced: 4 days ago
JSON representation

A Toolbox companion for QMK Firmware

Awesome Lists containing this project

README 

        
# QMK Toolbox



[![Latest Release](https://img.shields.io/github/v/release/qmk/qmk_toolbox?color=3D87CE&label=Latest&sort=semver&style=for-the-badge)](https://github.com/qmk/qmk_toolbox/releases/latest)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/qmk/qmk_toolbox/build.yml?logo=github&style=for-the-badge)](https://github.com/qmk/qmk_toolbox/actions?query=workflow%3ACI+branch%3Amaster)

[![Discord](https://img.shields.io/discord/440868230475677696.svg?logo=discord&logoColor=white&color=7289DA&style=for-the-badge)](https://discord.gg/qmk)



This is a collection of flashing tools packaged into one app. It supports auto-detection and auto-flashing of firmware to keyboards.



|Windows|macOS|

|-------|-----|

|[![Windows](https://i.imgur.com/jHaX9bV.png)](https://i.imgur.com/jHaX9bV.png)|[![macOS](https://i.imgur.com/8hZEfDD.png)](https://i.imgur.com/8hZEfDD.png)|



## Flashing



QMK Toolbox supports the following bootloaders:



 - ARM DFU (APM32, Kiibohd, STM32, STM32duino) via [dfu-util](http://dfu-util.sourceforge.net/)

 - Atmel/LUFA/QMK DFU via [dfu-programmer](http://dfu-programmer.github.io/)

 - Atmel SAM-BA (Massdrop) via [Massdrop Loader](https://github.com/massdrop/mdloader)

 - BootloadHID (Atmel, PS2AVRGB) via [bootloadHID](https://www.obdev.at/products/vusb/bootloadhid.html)

 - Caterina (Arduino, Pro Micro) via [avrdude](http://nongnu.org/avrdude/)

 - HalfKay (Teensy, Ergodox EZ) via [Teensy Loader](https://pjrc.com/teensy/loader_cli.html)

 - LUFA/QMK HID via [hid_bootloader_cli](https://github.com/abcminiuser/lufa)

 - WB32 DFU (WB32) via [wb32-dfu-updater_cli](https://github.com/WestberryTech/wb32-dfu-updater)

 - LUFA Mass Storage



And the following ISP flashers:



 - AVRISP (Arduino ISP)

 - USBasp (AVR ISP)

 - USBTiny (AVR Pocket)



If there's an interest in any others, they can be added if their commands are known.



## HID Console



The Toolbox also listens to HID messages on usage page `0xFF31` and usage `0x0074`, compatible with PJRC's [`hid_listen`](https://www.pjrc.com/teensy/hid_listen.html).



If you have `CONSOLE_ENABLE = yes` in your keyboard's `rules.mk`, you can print messages with `xprintf()`, useful for debugging:



![Hello world from Console](https://i.imgur.com/bY8l233.png)



See the [QMK Docs](https://docs.qmk.fm/#/newbs_testing_debugging?id=debugging) for more information.



## Installation



### System Requirements



* macOS 12 (Monterey) or higher

* Windows 10 May 2020 Update (20H1) or higher



### Dependencies



When using the QMK Toolbox on Windows, it will prompt at first run to install the necessary drivers.



If you run into any issues with "Device not found" when flashing, then you may need to use [Zadig](https://docs.qmk.fm/#/driver_installation_zadig) to fix the issue.



### Download



The [current version](https://github.com/qmk/qmk_toolbox/releases) of QMK Toolbox is **0.3.3**.



* **Windows:** [standalone](https://github.com/qmk/qmk_toolbox/releases/latest/download/qmk_toolbox.exe), [installer](https://github.com/qmk/qmk_toolbox/releases/latest/download/qmk_toolbox_install.exe)

* **macOS**: [standalone](https://github.com/qmk/qmk_toolbox/releases/latest/download/QMK.Toolbox.app.zip), [installer](https://github.com/qmk/qmk_toolbox/releases/latest/download/QMK.Toolbox.pkg)



For Homebrew users, it is also available as a Cask:



```sh

brew install qmk-toolbox

```