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

Go to file

Gergely Nagy aad2dfe2cc Remove now-obsolete idle checks from a few plugins A long-long time ago, Kaleidoscope used to call `onKeyswitchEvent` (or rather, it's then-current incarnation) even when keys were idle. For a number of plugins, this was a case they didn't want to handle, and bailed out early. When we changed Kaleidoscope to not call the event handlers for idle keys, these plugins weren't modified at the same time, and the superfluous check remained, making the firmware both larger and marginally slower. Since the event handlers are never called when idle, it is safe to remove these checks. Affected plugins are `Leader`, `OneShot`, and `TapDance`. Signed-off-by: Gergely Nagy <algernon@keyboard.io>		6 years ago
bin	kaleidoscope-builder: Support config files in the sketch dir too	6 years ago
doc	MagicCombo: Document that the old API error message will be removed	6 years ago
etc	etc/kaleidoscope-builder.conf: Fix ARDUINO_IDE_VERSION	6 years ago
examples	examples: Make astyle happy	6 years ago
extras	Initial import	8 years ago
src	Remove now-obsolete idle checks from a few plugins	6 years ago
.gitignore	Remove files we do not need in the monorepo	6 years ago
.kaleidoscope-builder.conf	Remove the hook for the now-removed layout transformation script	8 years ago
.travis.yml	Remove files we do not need in the monorepo	6 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	Remove files we do not need in the monorepo	6 years ago
README.md	Remove files we do not need in the monorepo	6 years ago
UPGRADING.md	Move most sources to a kaleidoscope/ subdir and namespace	6 years ago
library.properties	Remove files we do not need in the monorepo	6 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/Kaleidoscope-Bundle-Keyboardio.git
# and make them available to the arduino environment
mkdir -p $SKETCHBOOK_DIR/hardware
ln -s $HOME/kaleidoscope/Kaleidoscope-Bundle-Keyboardio $SKETCHBOOK_DIR/hardware/keyboardio

Build the Kaleidoscope Firmware for your keyboard

# go to your keyboardio directory
cd $HOME/kaleidoscope/Kaleidoscope-Bundle-Keyboardio/libraries/Model01-Firmware
# and build your firmware!
make

<3 jesse