Skip to content

Chrysalis Introduction

jfmcdowell edited this page May 27, 2019 · 2 revisions

Welcome to Chrysalis

Chrysalis is a graphical configuration tool for Kaleidoscope powered keyboards.

The primary purpose of the application is to allow one to configure their keyboard without having to compile or flash firmware, by storing the configuration on the keyboard itself, in EEPROM. There are no external tools required, just Chrysalis itself.

Overview

Connecting your board

When you open Chrysalis, you will be presented with a menu to select your keyboard. Generally speaking your keyboard should be detected automatically, but in case you have multiple keyboards connected, you may need to select it from the drop-down list box. Your keyboard will be identified by its port or connection method. Each keyboard should have a unique serial identifier. Once your keyboard is selected press the blue Connect button.

Initial Firmware flash

You may be prompted to flash your firmware when first connecting to Chrysalis. Keep in mind that you will have the option of default or experimental firmware options. Follow the on-screen prompts in order to perform this first step operation and then if required, reconnect to the keyboard.

Chrysalis Menu

In the top left corner of the application you will see the Hamburger button. If you click that button you will see a menu of options to interact with the application.

A summary of the menu options are as follows:

Keyboard

  1. Layout & Colormap Editor
  2. Firmware Update
  3. Keyboard Settings

Chrysalis

  1. Select another keyboard
  2. Preferences

Miscellaneous

Note: This section provides links from inside the application to the Keyboardio Discord community and to the Github issues page. They are linked below for your convenience.

  1. Real-time chat
  2. Send feedback
  3. Exit Chrysalis