Keyboardio Model 01 Firmware

This is the source code for ~~the default~~ Tim Baummann’s customized firmware for the Keyboardio Model 01. ~~The default Tim Baumann's customized firmware for the Keyboardio Model 01

If you don't intend to customize your keyboard's firmware, you may want to consider using Chrysalis, our graphical configuration tool instead.

To use or customize this firmware, you need to have Arduino and Kaleidoscope installed on your computer.

If you don't yet have Kaleidoscope and Arduino installed on your computer, set them up now

Set up dependencies

First, download all dependencies:

git submodule init --update

Then, for each subdirectory of deps/, create a soft link from the Arduino libraries directory ($HOME/Arduino/libraries) to the subdirectory.

A note on building on NixOS

Start the Arduino IDE from the Arduino Nix Environment:

$ nix-shell https://github.com/nix-community/nix-environments/archive/master.tar.gz -A arduino
[nix-shell] $ arduino

Set up the Arduino IDE

Setup the Arduino IDE on your system. Make sure you install at least version 1.8.11, since older version may not support all required features.

Out of the box, Arduino does not include support for Kaleidoscope keyboards. To be able to build and install new firmware on your keyboard, you will need to teach Arduino about Kaleidoscope.

You can find instructions for setting up the Arduino IDE and adding support for Kaleidoscope on the Kaleidoscope wiki

Once that's done, you're ready to download the Model 01's firmware source code.

Download the Model 01 Firmware

git clone https://github.com/keyboardio/Model01-Firmware.git

Build and flash the firmware

Before you begin, make sure your Model 01 is connected to your computer.

Open the sketch you wish to flash (for example, Model01-Firmware.ino).

Make sure that you've picked the Model 01 from the Boards list in the tools menu.

Click the Upload button or press Ctrl-U.

Hold down the "Prog" key in the top left corner of your keyboard, until the compile finishes and the upload begins.

Start to customize the firmware

You can customize your keyboard's key layout and LED effects by modifying the Model01-Firmware.ino file in the same directory as this README. Model01-Firmware.ino is a computer program written in 'Arduino C'. You can find documentation about Arduino C at https://arduino.cc.

Getting help

As you start to explore customization of your keyboard's firmware, the community at https://community.keyboard.io can often be a valuable resource.

Thanks!

<3 jesse

timjb/Model01-Firmware