Updating firmware with Chrysalis

Chrysalis is Keyboardio's upcoming graphical configuration tool for the Model 01 and other keyboards powered by Kaleidoscope.

As of January 2019, Chrysalis is still early in its life. Using Chrysalis to change your keyboard's layout is not yet as easy to use as we'd like, but it's improving rapidly.

One thing Chrysalis does do pretty well as of today is to update the Model 01's firmware without the need to install the Arduino IDE or compile anything.

If flashing with Chrysalis doesn't work for you or you're interested in compiling your own firmware, you can use the Arduino IDE on a computer running macOS, Windows or Linux to build and install new firmware. Instructions for installing the Arduino IDE and using it to flash new firmware onto the Model 01 start on this wiki page.

This guide was last updated for Chrysalis version 0.3.1

1. Download and install Chrysalis

You can download the version of Chrysalis matching this guide for Windows, macOS, and Linux at https://github.com/keyboardio/Chrysalis/releases/tag/chrysalis-0.3.1

A newer version may be available at https://github.com/keyboardio/Chrysalis/releases/

• Windows: Download and run https://github.com/keyboardio/Chrysalis/releases/download/chrysalis-0.3.1/Chrysalis-0.3.1.setup.exe to install Chrysalis.

• macOS: Download and open https://github.com/keyboardio/Chrysalis/releases/download/chrysalis-0.3.1/Chrysalis-0.3.1.dmg. Drag Chrysalis.app into your /Applications folder.

• Linux: Download https://github.com/keyboardio/Chrysalis/releases/download/chrysalis-0.3.1/Chrysalis-0.3.1.AppImage, and make it executable.

2. Connect your Model 01 to your computer

3. Start Chrysalis

• Windows: Click on Chrysalis in the Start menu.

• macOS: Double-click on Chrysalis in the Applications folder.

• Linux: Run ./Chrysalis-0.3.1.AppImage from your shell

4: Connect to your keyboard

5: Open Chrysalis' menu

6: Select "Firmware Update"

7: Hold down the Prog key on your keyboard.

8: Click the 'Update' button.

Chrysalis will tell your keyboard to switch into programming mode. When this happens, the Prog key will turn red. Once you see the Prog key turn red, you can release it.

If everything goes as planned, you'll see the keys on the left side of your keyboard flash red, one by one. Chrysalis will then display a green banner at the bottom of the window to tell you that everything went ok. It's now safe to quit Chrysalis and use your keyboard.

If something goes wrong, Chrysalis will show a red error banner at the bottom of the window. You can try unplugging your keyboard, plugging it back in and repeating the flashing pricess from step 4.

Alternatively, you can use the traditional Arduino-based flashing process.

If you need a hand, please drop us a line at [email protected].