keybrd library is an open source library for creating custom-keyboard firmware.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

tutorial_0_introduction.md 2.1KB

Tutorial 0 - Introduction

The first two tutorials are intended to be read in sequence:

  1. Breadboard keyboard
  2. Single-layer keybrd

Tutorial 1 is about making a breadboard keyboard, which is used in tutorials 2 through 6. Tutorial 2 is needed to understand the remaining tutorials. The remaining tutorials can be read in any order.

You will need a breadboard keyboard with a Teensy 2.0 controller to run tutorial sketches 2 through 6. If you use a different controller, you may have to change pin assignments and port classes. If you already have a keyboard with an Arduino compatible controller, you can use that instead of a breadboard keyboard. All the tutorial sketches use 2 to 8 keys. If your keyboard has more keys, they are simply ignored by the sketch.

The tutorials assume the reader:

  • is familiar with C++
  • is new to Arduino, firmware, controllers, and the internal workings of keyboards

Most of the tutorial sketches are obsolete and will not compile. Will be updated soon.

The tutorial sketches will be changed to Teensy LC and MCP23018 I/O expander

Some of the pictures do not match the sketches, they will be updated after changing to Teensy LC

Schematic diagrams are missing from tutorials 2 and 4, they will be added after changing to Teensy LC

Creative Commons License
keybrd tutorial by Wolfram Volpi is licensed under a Creative Commons Attribution 4.0 International License.
Permissions beyond the scope of this license may be available at https://github.com/wolfv6/keybrd/issues/new.