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

Go to file

Gergely Nagy 311a6761d8 IdleLEDs: Optional support for EEPROM-Storage & Focus Having to recompile and re-flash firmware to set the idle timeout of the plugin isn't a fun or desired experience. It's fine when one already figured out the timeout they want, and have no desire to change it. For everyone else, being able to configure it at run-time via Focus, and have it persist to EEPROM is a much nicer experience. This change adds an alternative version of the plugin, `PersistentIdleLEDs`, a subclass of the original one. This one provides the focus command and persistence. It's a child class, because that results in a smaller footprint than a separate plugin that calls the `IdleLEDs` object. The code borrows from - but is not wire-compatible with - Dygma's implementation by @mattvenn. Signed-off-by: Gergely Nagy <algernon@keyboard.io>		5 years ago
bin	Fix whitespace inconsistencies	5 years ago
doc	IdleLEDs: Optional support for EEPROM-Storage & Focus	5 years ago
etc	Add Windows+Cygwin support for kaleidoscope-builder	5 years ago
examples	IdleLEDs: Optional support for EEPROM-Storage & Focus	5 years ago
extras	Initial import	8 years ago
src	IdleLEDs: Optional support for EEPROM-Storage & Focus	5 years ago
test/MatrixAddr	Update linear addressing branch for firmware drift	6 years ago
.gitignore	.gitignore: Ignore compiled examples too	6 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	CONTRIBUTING.md: Add a very short section about how to accept the DCO	6 years ago
LICENSE	License clarificataion & copyright headers	6 years ago
Makefile	Remove files we do not need in the monorepo	6 years ago
NEWS.md	Dynamic Macros plugin	5 years ago
README.md	inserted missing ```sh	5 years ago
UPGRADING.md	Update linear addressing branch for firmware drift	6 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.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