Kaleidoscope Maintainers¶

We consider pull requests to the Kaleidoscope GitHub repo.

obra
noseglasses
algernon

Kaleidoscope

Navigation

Installation and setup

Getting Started
Setting up your development environment
Set up the Arduino IDE
Add keyboard support to Arduino
Build and install the latest firmware for your keyboard
Select your keyboard
Install the latest default firmware on your keyboard
Build the firmware
Install the firmware

Customizing your firmware

Layers
Core plugin overview
Using EEPROM
Migrating EEPROM contents between firmware changes
What can go on your keymap
Core LED Effects
How to write a Kaleidoscope plugin
Bundled plugins

Supported devices

ErgoDox EZ
Keyboardio Atreus
Keyboardio Model 01
OLKB Planck
SOFTHRUF Splitography
Technomancy Atreus

Understanding the codebase

Kaleidoscope C++ Coding Style
Design philosophy
Docker
Glossary
Developing interdependent plugins
Kaleidoscope Maintainers

API Design

Kaleidoscope Device API internals
Kaleidoscope’s Plugin Event Handlers
Kaleidoscope Plugin API Internals

Device Drivers

kaleidoscope::driver::bootloader
kaleidoscope::driver::led::WS2812

Testing

Automated Testing
Release testing
Tested operating systems
Test process
If the current platform supports the Arduino IDE (Win/Lin/Mac)
Testing Kaleidoscope

Changes

Kaleidoscope v2.0
Upgrade notes
Removed APIs

Code of Conduct

Contributor Covenant Code of Conduct

Examples

All example sketches

Related Topics

Documentation overview
- Previous: Developing interdependent plugins
- Next: Kaleidoscope Device API internals

Quick search

©2023, Keyboardio & Friends. | Powered by Sphinx 4.5.0 & Alabaster 0.7.13 | Page source