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

Go to file

Michael Richters c9727199d4 Corrected macro for HID_CONSUMER_AC_DOWNLOAD These macros were copied and pasted, I'm guessing from the USB HID Usage Tables document, where this keycode is identified with a parenthetical, unlike all of the others around it: `AC Download (Save Target As)`. When automatically converted into a preprocessor macro, it gets a trailing underscore and an argument, which is not what we want. This change won't actually fix anything that's currently broken, but it might matter someday.		7 years ago
bin	Merge pull request #290 from jwakely/missing-bootloader	7 years ago
doc	Delete DRAFT_Intro_Docs.md	7 years ago
etc	Use the new find-device-port-macos script to find the correct port	7 years ago
examples	Include the HIDAdaptor library in the examples	7 years ago
src	Corrected macro for HID_CONSUMER_AC_DOWNLOAD	7 years ago
.gitignore	Add a gitignore file	8 years ago
.kaleidoscope-builder.conf	Remove the hook for the now-removed layout transformation script	8 years ago
.travis.yml	Attempt to switch to shared build infrastructure for build and test.	8 years ago
CODE_OF_CONDUCT.md	Code of conduct	8 years ago
LICENSE	Update the text of the GPL-2 to the latest text	8 years ago
Makefile	Update Makefile with OSX fixes and new paths	7 years ago
README.md	Link to the example firmware sketch from the README	7 years ago
library.properties	The Big Rename	8 years ago

README.md

Kaleidoscope

Flexible firmware for Arduino-powered keyboards.

This package contains the "core" of Kaleidoscope and an example firmware "Sketch."

If you're just getting started with the Keyboardio Model 01, the introductory docs are here and the source for the basic firmware package is here: https://github.com/keyboardio/Model01-Firmware. It's probably a good idea to start there, learn how to modify your keymap and maybe turn some modules on or off, and then come back to the full repository when you have more complex changes in mind.

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.

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 Kaleidoscope 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/kaleidoscope/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