Skip to content

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

License

Notifications You must be signed in to change notification settings

jdlien/Kaleidoscope

 
 

Repository files navigation

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.6, since older version may not support all required features.

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

then 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)

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

# Build your firmware!
make


# Install your firmware
make flash

<3 jesse

Build Status

About

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

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 76.8%
  • C 19.8%
  • Shell 2.6%
  • Other 0.8%