2017-08-14 15:50:14 -07:00
# Keyboardio Model 01 Firmware
2017-07-26 23:22:10 -07:00
2017-08-14 15:50:14 -07:00
The default firmware for the Keyboardio Model 01
2017-07-26 23:22:10 -07:00
2017-08-14 15:50:14 -07:00
# Download and install
## Set up the Arduino IDE
2017-07-26 23:22:10 -07:00
Setup the Arduino IDE on your system. Make sure you install at least version 1.6, since older version may not support all required features.
2017-08-14 15:50:14 -07:00
## macOS
2017-07-26 23:22:10 -07:00
2017-08-14 15:45:07 -07:00
On macOS, install the Arduino IDE using [homebrew ](http://brew.sh/ ) [cask ](https://caskroom.github.io/ ) with `brew cask install arduino` or download the application from [the official website ](https://www.arduino.cc/en/Main/Software ) and move it to your `/Applications` folder.
2017-07-26 23:22:10 -07:00
2017-08-14 15:50:14 -07:00
### Linux
2017-07-26 23:22:10 -07:00
2017-08-14 15:45:07 -07:00
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.3 or so, you'll need to install the Arduino IDE following the instructions [on the wiki ](https://github.com/keyboardio/Kaleidoscope/wiki/Arduino-Setup-Linux ), installing the Arduino package somewhere that 'arduino' and 'arduino-builder' end up in your $PATH
2017-07-26 23:22:10 -07:00
2017-08-14 15:50:14 -07:00
## Create and navigate to the Arduino Sketchbook directory
2017-08-04 17:19:51 +09:00
2017-08-14 15:50:14 -07:00
### MacOS
2017-08-14 15:45:07 -07:00
```sh
mkdir -p $HOME/Documents/Arduino
cd $HOME/Documents/Arduino
```
2017-08-14 15:50:14 -07:00
### Linux
2017-08-14 15:45:07 -07:00
```sh
mkdir -p $HOME/Arduino
cd $HOME/Arduino
2017-08-14 15:13:13 -07:00
```
2017-07-26 23:22:10 -07:00
2017-08-14 15:50:14 -07:00
## Download hardware platform, including library source code
2017-07-26 23:22:10 -07:00
```sh
2017-08-14 15:45:07 -07:00
mkdir -p hardware/keyboardio
2017-08-14 15:50:14 -07:00
## then clone the hardware definitions to make them available to the arduino environment
2017-08-14 15:45:07 -07:00
git clone --recursive https://github.com/keyboardio/Arduino-Boards.git hardware/keyboardio/avr
````
2017-07-26 23:22:10 -07:00
2017-08-14 15:50:14 -07:00
## Download the Model 01 Firmware
```sh
git clone https://github.com/keyboardio/Model01-Firmware.git
```
# Build and flash the firmware from the commandline
2017-07-26 23:22:10 -07:00
2017-08-14 15:45:07 -07:00
```sh
cd Model01-Firmware
make flash
2017-07-26 23:22:10 -07:00
```
2017-08-14 15:45:07 -07:00
When the builder tells you to hit Enter to continue, hold down "Prog" on your keyboard and hit Enter.
2017-08-14 15:50:14 -07:00
# Thanks!
2017-07-26 23:22:10 -07:00
< 3 jesse
2017-07-27 13:15:34 +02:00
[](https://travis-ci.org/keyboardio/Model01-Firmware)