The default firmware for the Keyboardio Model 01
This is a quick start guide for folks who are familiar with Arduino and prefer to use the command line. For everyone else:
-
Check out the wiki for a more in depth introduction to how the Model 01 keyboard and the Kaleidoscope firmware work.
-
If you have questions, The community forums are happy to help!
Check out the wiki for a more in depth introduction to how the Model 01 keyboard and the Kaleidoscope firmware work.
If you have questions, The community forums are happy to help!
Setup the Arduino IDE on your system. Make sure you install at least version 1.6.10, since older version may not support all required features.
On macOS, install the Arduino IDE using homebrew cask with brew cask install arduino or download the application from the official website and move it to your /Applications folder.
If you have brew cask already installed the setup.sh script will install it
for you.
On Linux, your distribution's package manager probably includes the Arduino IDE, but it may be an out of date version. If your distribution installs a version of Arduino before 1.6.10, you'll need to install the Arduino IDE following the instructions on the wiki.
If you install Arduino into some place that's /not/ /usr/local/arduino, you'll need to set the $ARDUINO_PATH environment variable to the directory containing the arduino and arduino-builder binaries.
git clone https://github.com/keyboardio/Model01-Firmware.git
cd Model01-Firmware
./setup.shBefore you begin, make sure your Model 01 is connected to your computer.
make flashWhen the builder tells you to hit Enter to continue, hold down "Prog" in the top left corner of your keyboard and hit Enter.
Open the sketch you wish to flash (for example, Model01-Firmware.ino).
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.
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.
From time to time, you may want to pull the latest version of this firmware from GitHub. To do that, navigate to the Model01-Firmware directory in your shell and pull the latest code.
cd Model01-Firmware
git pullAfter that, you'll want to update the Kaleidoscope libraries.
cd $HOME/Documents/Arduino/hardware/keyboardio/avr
make update-submodulescd $HOME/Arduino/hardware/keyboardio/avr
make update-submodulesAs you start to explore customization of your keyboard's firmware, the community at https://community.keyboard.io can often be a valuable resource.
<3 jesse
