Kaleidoscope

Flexible firmware for computer 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.

Installation and setup

• Getting Started
  • Set up the Arduino IDE with Kaleidoscope support
• Setting up your development environment
• Set up the Arduino IDE
  • Install Arduino on macOS
  • Install Arduino on Linux
  • Install Arduino on Windows 10
  • Install Arduino on FreeBSD
• 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

For users

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

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

For developers

Understanding the codebase

• Kaleidoscope C++ Coding Style
• Design philosophy
• Docker
• Glossary
• Developing interdependent plugins
• Kaleidoscope Maintainers
• Building a numbered release of Kaleidoscope for Arduino

API Design

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

Device Drivers

• kaleidoscope::driver::bootloader
  • Using the driver
  • Methods provided by all bootloader drivers
    • .rebootBootloader()
  • List of bootloaders
  • avr::Caterina:
    • avr::HalfKay
    • avr::FLIP
• kaleidoscope::driver::led::WS2812
  • Using the driver
  • Driver methods
    • .led_count()
    • .sync()
    • .setColorAt(index, color)
    • .setColorAt(index, r, g, b)
    • .getColorAt(index)
  • Further information

Testing

• Release testing
• Tested operating systems
• Test process
  • Basic testing
  • Basic testing, part 2
  • NKRO
  • Test media keys
  • Test numlock
  • Test LED Effects
  • Second connection
  • Programming
• If the current platform supports the Arduino IDE (Win/Lin/Mac)
• Testing Kaleidoscope
• Writing tests
  • Simulator tests
    • Adding a New Test Case
  • Testing with gtest/gmock
    • Adding a low-level test
    • Test Infrastructure

Changes

• Kaleidoscope v2.0
  • New features
  • keymap internals are now a one dimensional array
  • PER_KEY_DATA macros
  • New hardware support
  • New plugins
  • Breaking changes
  • Bugfixes
• Upgrade notes
  • New features
  • Breaking changes
  • Deprecated APIs and their replacements
• Removed APIs
  • Removed on 2023-11-13
  • Removed on 2022-03-03
  • Removed on 2020-10-10
  • Removed on 2020-06-16
  • Removed on 2020-01-06
  • Removed on 2019-01-18
  • Removed on 2019-01-17
  • Removed on 2018-08-20
  • Removed on 2018-06-10 (originally scheduled for 2018-05-27)

Code of Conduct

• Contributor Covenant Code of Conduct

Examples

• All example sketches
  • Basic/Basic.ino
  • Devices/EZ/ErgoDox/ErgoDox.ino
  • Devices/KBDFans/KBD4x/KBD4x.ino
  • Devices/Keyboardio/Atreus/Atreus.ino
  • Devices/Keyboardio/Imago/Imago.ino
  • Devices/Keyboardio/Model01/Model01.ino
  • Devices/Keyboardio/Model100/Model100.ino
  • Devices/OLKB/Planck/Planck.ino
  • Devices/SOFTHRUF/Splitography/Splitography.ino
  • Devices/Technomancy/Atreus/Atreus.ino
  • Devices/gHeavy/ButterStick/ButterStick.ino
  • Devices/gHeavy/FaunchPad/FaunchPad.ino
  • Features/AppSwitcher/AppSwitcher.cpp
  • Features/AppSwitcher/AppSwitcher.h
  • Features/AppSwitcher/AppSwitcher.ino
  • Features/CycleTimeReport/CycleTimeReport.ino
  • Features/EEPROM/DynamicMacros/DynamicMacros.ino
  • Features/EEPROM/EEPROM-Keymap-Programmer/EEPROM-Keymap-Programmer.ino
  • Features/EEPROM/EEPROM-Keymap/EEPROM-Keymap.ino
  • Features/EEPROM/EEPROM-Settings/EEPROM-Settings.ino
  • Features/FocusSerial/FocusSerial.ino
  • Features/GhostInTheFirmware/GhostInTheFirmware.ino
  • Features/HostOS/HostOS.ino
  • Features/HostPowerManagement/HostPowerManagement.ino
  • Features/Layers/Layers.ino
  • Features/ModLayer/ModLayer.ino
  • Features/MouseKeys/MouseKeys.ino
  • Features/ShiftBlocker/ShiftBlocker.ino
  • Features/Steno/Steno.ino
  • Features/TypingBreaks/TypingBreaks.ino
  • Internal/Sketch_Exploration/Sketch_Exploration.ino
  • Keystrokes/AutoShift/AutoShift.ino
  • Keystrokes/CharShift/CharShift.ino
  • Keystrokes/Chord/Chord.ino
  • Keystrokes/Cycle/Cycle.ino
  • Keystrokes/DynamicTapDance/DynamicTapDance.ino
  • Keystrokes/Escape-OneShot/Escape-OneShot.ino
  • Keystrokes/Leader/Leader.ino
  • Keystrokes/LeaderPrefix/LeaderPrefix.ino
  • Keystrokes/LongPress/LongPress.ino
  • Keystrokes/Macros/Macros.ino
  • Keystrokes/MagicCombo/MagicCombo.ino
  • Keystrokes/OneShot/OneShot.ino
  • Keystrokes/OneShotMetaKeys/OneShotMetaKeys.ino
  • Keystrokes/PrefixLayer/PrefixLayer.ino
  • Keystrokes/Qukeys/Qukeys.ino
  • Keystrokes/Redial/Redial.ino
  • Keystrokes/ShapeShifter/ShapeShifter.ino
  • Keystrokes/SpaceCadet/SpaceCadet.ino
  • Keystrokes/Syster/Syster.ino
  • Keystrokes/TapDance/TapDance.ino
  • Keystrokes/TopsyTurvy/TopsyTurvy.ino
  • Keystrokes/Turbo/Turbo.ino
  • Keystrokes/Unicode/Unicode.ino
  • Keystrokes/WinKeyToggle/WinKeyToggle.ino
  • LEDs/Colormap/Colormap.ino
  • LEDs/FingerPainter/FingerPainter.ino
  • LEDs/Heatmap/Heatmap.ino
  • LEDs/IdleLEDs/IdleLEDs.ino
  • LEDs/LED-ActiveLayerColor/LED-ActiveLayerColor.ino
  • LEDs/LED-ActiveModColor/LED-ActiveModColor.ino
  • LEDs/LED-AlphaSquare/LED-AlphaSquare.ino
  • LEDs/LED-Brightness/LED-Brightness.ino
  • LEDs/LED-Palette-Theme/LED-Palette-Theme.ino
  • LEDs/LED-Stalker/LED-Stalker.ino
  • LEDs/LED-Wavepool/LED-Wavepool.ino
  • LEDs/LEDEffect-BootGreeting/LEDEffect-BootGreeting.ino
  • LEDs/LEDEffects/LEDEffects.ino
  • LEDs/PersistentLEDMode/PersistentLEDMode.ino

Indices and tables

• Index

• Module Index

• Search Page

Links

Source code on GitHub