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

Go to file

Jesse Vincent 13e216faa1 try to get rtd to see our master doc		5 years ago
bin	Fixed builds on msys2	5 years ago
docs	Move most of our docs into the 'docs' directory as we being Read The Docs setup	5 years ago
etc	try to get rtd to see our master doc	5 years ago
examples	Revamp the Atreus2 layout.	5 years ago
extras	Initial import	8 years ago
src	Merge pull request #781 from keyboardio/usbquirks-fix	5 years ago
test/MatrixAddr	Update linear addressing branch for firmware drift	5 years ago
.gitignore	Move most of our docs into the 'docs' directory as we being Read The Docs setup	5 years ago
.kaleidoscope-builder.conf	Remove the hook for the now-removed layout transformation script	8 years ago
.travis.yml	travis: Force Arduino to use the current copy of Kaleidoscope	5 years ago
CODE_OF_CONDUCT.md	Code of conduct	8 years ago
CONTRIBUTING.md	Remove files we do not need in the monorepo	6 years ago
LICENSE	License clarificataion & copyright headers	6 years ago
Makefile	Copied Makefile from Model01-Firmware	5 years ago
NEWS.md	Key union converted to a proper class	5 years ago
README.md	Added a compiler/Arduino version check	5 years ago
library.properties	library.properties: Remove the AVR architecture restriction	5 years ago

README.md

Kaleidoscope

Flexible firmware for Arduino-powered keyboards.

This package contains the "core" of Kaleidoscope and a number of example firmware "Sketches".

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

Setup the Arduino IDE

Setup the Arduino IDE on your system. Make sure you install at least version 1.8.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.

Get into the right directory

macOS

mkdir -p $HOME/Documents/Arduino/hardware
cd $HOME/Documents/Arduino/hardware

Linux

mkdir -p $HOME/Arduino/hardware
cd $HOME/Arduino/hardware

Windows

TODO: Write me

Install the libraries and hardware definitions

Clone the hardware definitions

git clone --recursive https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio.git keyboardio

Build the Kaleidoscope Firmware for your keyboard

(This part assumes you're building firmware for the Keyboardio Model 01)

# Go to your device firmware directory
cd keyboardio/avr/libraries/Model01-Firmware

# Build your firmware!
make


# Install your firmware
make flash

<3 jesse