Installation
You don't need to install anything to simply use the keyboard - it acts like a normal USB keyboard, and doesn't require any special drivers. Just plug it in and start typing.
If you want to run the typing tutor on your computer or change the keyboard configuration (like to re-arrange keys or add words to the dictionary), then follow these instructions.
Configuration tool and typing tutor
The configuration tool and typing tutor have been tested on Linux and Mac OSX. They might also work on Windows, especially if using the Linux subsystem.
-
Install rust, following instructions from the rust website. Rust 1.27 or later is required.
-
Clone or download the pipit-keyboard repository from github. This repository contains the configuration tool, the typing tutor, and the keyboard firmware.
-
In a terminal, navigate to the
pipit-keyboard
directory. Run$ cargo build
to download and compile the required rust libraries and the config tool / tutor itself.
Arduino IDE
The Arduino IDE allows you to re-program the microcontroller inside the keyboard, updating the firmware and changing the configuration.
-
Install the Arduino IDE. You must install the offline IDE version, instead of using the online "Arduino Create" tool.
-
Install the Teensyduino add-on to the Arduino IDE, to support the
TeensyLC
board used in the keyboard.