Firmware for the Keyboardio Model 01 and other keyboards with AVR or ARM MCUs.

Go to file

Gergely Nagy 1acc23063e Rearrange the SYNTHETIC bits, and their handling Introduces the RESERVED bit, a bit reserved for plugins. If it is set, the core handlers will not handle the event. Also rearranges the SYNTHETIC bits, to make slightly more sense. In practice, this means that LED_TOGGLE was promoted to a flag bit, under IS_INTERNAL. The handler that deals with synthetic events was updated to look at the flag bits in an order that does not cause confusion, and preparations were also made to turn it into an independent handler on its own (but that step has not been taken yet). This is just groundwork to clean things up, and make the event flow easier to follow. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>		8 years ago
etc	Add udev rules for linux, so we don't have problems programming	8 years ago
examples/KeyboardioFirmware	Rework the hook handling	8 years ago
libraries	Rearrange the SYNTHETIC bits, and their handling	8 years ago
src	Rearrange the SYNTHETIC bits, and their handling	8 years ago
tools	generate_keymaps: Don't prepend Key_ to everything	8 years ago
.gitignore	Add a gitignore file	8 years ago
.gitmodules	Undo numist's nicer code layout so we can build as a 'regular' arduino sketch	8 years ago
.travis.yml	Try coming up the current arduino builder, because why not	8 years ago
LICENSE	iFor simplicity sake, just use GPLv2 for now.	10 years ago
Makefile	force make flash to properly reset the device on Linux.	8 years ago
NOTICE	We no longer have the subdir NOTICE was talking about.	8 years ago
README.md	add install instructions to readme	8 years ago
library.properties	Reintroduce dot_a_linkage	8 years ago

README.md

We're in the midst of refactoring our really bad prototype firmware into a more reasonable production firmware.

Right now, the code is really ugly. It'll be nicer soon. Please don't judge us too harshly.

Getting Started

Pick a directory to work in, you'll need to clone multiple repositories. We'll assume you picked $HOME/keyboardio, if you chose another adapt the commands below accordingly.

Setup 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.

On Linux, follow the instructions on the wiki.
On macOS, install using homebrew cask with brew cask install arduino or download the application from the official website and move it to your /Applications folder.

Install the Keyboardio Hardware Definitions

# you'll need to know your arduino sketchbook directory

# on macOS the default is
SKETCHBOOK_DIR=$HOME/Documents/Arduino
# on Linux the default is
SKETCHBOOK_DIR=$HOME/Arduino

# go to your keyboardio directory
cd $HOME/keyboardio
# then clone the hardware definitions
git clone --recursive https://github.com/keyboardio/Arduino-Boards.git
# and make them available to the arduino environment
mkdir -p $SKETCHBOOK_DIR/hardware/keyboardio
ln -s $HOME/keyboardio/Arduino-Boards $SKETCHBOOK_DIR/hardware/keyboardio/avr

Clone and Build the Keyboardio Firmware

# go to your keyboardio directory
cd $HOME/keyboardio
# then clone the firmware repository
git clone https://github.com/keyboardio/KeyboardioFirmware.git
# and build your firmware!
cd KeyboardioFirmware
make

<3 jesse