Firmware for the Keyboardio Model 01 and other keyboards with AVR or ARM MCUs.
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.
 
 
 
 
 
 
Go to file
Jesse Vincent c0d66cee1a
Move the sample layouts into the firmware sketch
8 years ago
etc Add udev rules for linux, so we don't have problems programming 8 years ago
examples Move the sample layouts into the firmware sketch 8 years ago
src The Big Rename 8 years ago
tools Move the sample layouts into the firmware sketch 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
.kaleidoscope-builder.conf The Big Rename 8 years ago
.travis.yml travis: Call make build-all to build all the examples 8 years ago
LICENSE Update the text of the GPL-2 to the latest text 8 years ago
Makefile The Big Rename 8 years ago
NOTICE We no longer have the subdir NOTICE was talking about. 8 years ago
README.md The Big Rename 8 years ago
library.properties The Big Rename 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/kaleidoscope, 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.

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 kaleidoscope directory
cd $HOME/kaleidoscope
# 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 Kaleidoscope Firmware

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

<3 jesse

BuildStatus