README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# Keyboardio Model 01 Firmware
 
The default firmware for the Keyboardio Model 01
 
 
# Download and install
 
## Set up the Arduino IDE
 
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.
 
### macOS
 
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.
 
 
### Linux
 
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).
 
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.
 
## Create and navigate to the Arduino Sketchbook directory
 
### MacOS
```sh
mkdir -p $HOME/Documents/Arduino
cd $HOME/Documents/Arduino 
```
 
### Linux
 
```sh
mkdir -p $HOME/Arduino
cd $HOME/Arduino 
```
 
## Download hardware platform, including library source code 
 
```sh
mkdir -p hardware/keyboardio
 
## then clone the hardware definitions to make them available to the arduino environment 
git clone --recursive https://github.com/keyboardio/Arduino-Boards.git hardware/keyboardio/avr
````
 
 
## Download the Model 01 Firmware 
 
```sh
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.
 
### Option 1: From the command line 
 
```sh
cd Model01-Firmware
make flash
```
 
When the builder tells you to hit Enter to continue, hold down "Prog" in the top left corner of your keyboard and hit Enter.
 
### Option 2: From the Arduino IDE 
 
 
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.
 
 
# 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.
 
 
# Updating the firmware and libraries
 
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.
 
```sh
cd Model01-Firmware
git pull
```
 
After that, you'll want to update the Kaleidoscope libraries.
 
### MacOS 
```sh
cd $HOME/Documents/Arduino/hardware/keyboardio/avr
make update-submodules
```
 
### Linux 
 
```sh
cd $HOME/Arduino/hardware/keyboardio/avr
make update-submodules
```
 
 
# 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
 
[![Build Status](https://travis-ci.org/keyboardio/Model01-Firmware.svg?branch=master)](https://travis-ci.org/keyboardio/Model01-Firmware)