@ -86,80 +86,144 @@ Another thing to be aware of is the prog key. It sends a special signal to the k
[comment]:<> (@jesse @algernon are there more limitations that should be documented?)
[comment]:<> (@jesse @algernon are there more limitations that should be documented?)
<h2>Other Resources</h2>
* Keyboardio forum:
https://community.keyboard.io/
* Git repository for the Model 01 basic firmware:
https://github.com/keyboardio/Model01-Firmware
* Git repository for Kaleidoscope, which contains all the keyboardio modules:
https://github.com/keyboardio/Kaleidoscope
* Git repository for Calliope, the GUI tool for configuring the keyboardio that is still under development:
https://github.com/Lepidopterarium/Chrysalis
<h2>Install Arduino support</h2>
<h2>Install Arduino support</h2>
The Arduino system has been designed to be accessible to people at all skill levels, and Keyboardio is built on top of the Arduino platform because we share that goal. There are many ways to set up your system to work with the keyboardio firmware. This is the easiest process for folks who are new to Arduino, or to programming generally. If you follow the instructions below step by step you should be fine. :-)
The Arduino system has been designed to be accessible to people at all skill levels, and Keyboardio is built on top of the Arduino platform because we share that goal. There are many ways to set up your system to work with the keyboardio firmware. This is the easiest process for folks who are new to Arduino, or to programming generally. If you follow the instructions below step by step you should be fine. :-)
<h4>Step One: Set up the Arduino IDE</h4>
<h4>Step One: Set up the Arduino IDE</h4>
Download the Arduino IDE install package from:
1. Download the Arduino IDE install package from:
https://www.arduino.cc/en/Main/Software
https://www.arduino.cc/en/Main/Software
Click on your operating system name to download the correct version.
2. Click on your operating system name to download the correct version.
_**Note:** This tutorial has been written using the Mac version._
_**Note:** This tutorial has been written using the Mac version._
Install the Arduino IDE. On a mac the application is called "Arduino.app". You probably want to put it in your Applications directory.
3. Install the Arduino IDE. On a mac the application is called "Arduino.app". You probably want to put it in your Applications directory.
<h4>Step Two: Install keyboardio support into the IDE</h4>
<h4>Step Two: Install keyboardio support into the IDE</h4>
It will open a default sketch; just ignore that. (If you close the default sketch window the application will close.)
1. Open the Arduino IDE. It will open a default sketch; just ignore that. (If you close the default sketch window the application will close.)
Open the “Arduino” menu and click on “Preferences”
At the bottom of the "Settings" tab is the 'Additional Board Manager URLs` box. Paste this into it:
2. Open the “Arduino” menu and click on “Preferences”
and click ‘OK’ to close the dialog
3. At the bottom of the "Settings" tab is the 'Additional Board Manager URLs` box. Paste this into it: https://raw.githubusercontent.com/keyboardio/boardsmanager/master/package\_keyboardio\_index.json then click ‘OK’ to close the dialog
Open the ‘Tools’ menu, click on ‘Board’ and then click on ‘Boards Manager’
4. the ‘Tools’ menu, click on ‘Board’ and then click on ‘Boards Manager’
Type‘Keyboardio’ into the search box. You will see an entry that says "keyboardio by Keyboardio" Click on it to select it, and then click ‘Install’. Once the install completes, click "Close".
5.‘Keyboardio’ into the search box. You will see an entry that says "keyboardio by Keyboardio" Click on it to select it, and then click ‘Install’. Once the install completes, click "Close".
Open the ‘Tools’ menu again, click on ‘Board’ and then click on ‘Keyboardio Model 01’– You may have to scroll through a long list of other boards to get there.
6. the ‘Tools’ menu again, click on ‘Board’ and then click on ‘Keyboardio Model 01’– You may have to scroll through a long list of other boards to get there.
Plug in the keyboardio.
7. in the keyboardio.
Open the Tools menu again, and scroll down to "Port > ". Select the Keyboardio. (It may already be seleted.)
8. the Tools menu again, and scroll down to "Port > ". Select the Keyboardio. (It may already be seleted.)
<h4>Step Three: Build the default firmware and load it on the Keyboardio</h4>
<h4>Step Three: Build the default firmware and load it on the Keyboardio</h4>
Click on the “File” menu, click on the “Examples” submenu. Click on ‘Model01-Firmware’
1. In the “File” menu, click on the “Examples” submenu. Scroll down to ‘Model01-Firmware’
While holding down the prog key, click on the right arrow in the sketch window menu bar to compile compile and install.
2. While holding down the prog key, click on the right arrow in the sketch window menu bar to compile compile and install.
The Keyboardio LED's will flash across the board as the firmware is installed, and then the "LED" key will glow blue.
**Congrats, you've just installed the latest firmware!!**
<h2>Edit A Keymap</h2>
Editing a keymap is core to what the keyboardio is about, and probably one of the first things to try. For this example, let's imagine you want to map ESCAPE to the PROG key in the default keymap, as the QWERTY G-ds intended.
<h4> Step One: Edit </h4>
1. Open the Arduino IDE. In the “File” menu, click on the “Examples” submenu. Scroll down to ‘Model01-Firmware’.
There is a lot going on in this file. By all means, read through the code and the comments and get familiar with it if you like. Or you can just breeze past it for now and skip down to the keymaps:
2. Scroll down to this line:
```
enum { QWERTY, FUNCTION, NUMPAD }; // layers
```
That's where the keymaps section begins. It tells you that there are three layers:
* QWERTY is the default, or zero layer
* FUNCTION is layer 1
* NUMPAD is layer 2
The QWERTY keymap itself is a little further down, and looks like this:
It's a map of your keyboard's layout. The top block that starts with "(\_\_\_," and ends with "ShiftToLayer(FUNCTION)," is the left half of the keyboardio. that first "\_\_\_," represets the PROG key. It is a transparent key in the keymap, free to be mapped to anything you like.
At the end of the fourth row is "Key\_Escape," which corresponds to the ESC key on your keyboard. That means "Key\_Escape," is the keycode for the ESC key.
3. Replace "\_\_\_," with "Key\_Escape," in the first row, so your keymap now looks like this:
Jennifer Leigh
7 years ago
committed by
GitHub