Bundled plugins¶

Bundled plugins

  • AutoShift
  • CharShift
  • Chord
  • Colormap
  • Colormap-Overlay
  • Cycle
  • CycleTimeReport
  • DefaultLEDModeConfig
  • Kaleidoscope-Devel-ArduinoTrace
  • DynamicMacros
  • DynamicTapDance
  • EEPROM-Keymap
  • EEPROM-Keymap-Programmer
  • EEPROM-Settings
  • Escape-OneShot
  • FingerPainter
  • FirmwareDump
  • FirmwareVersion
  • FocusSerial
  • GhostInTheFirmware
  • Heatmap
  • HostOS
  • HostPowerManagement
  • IdleLEDs
  • Kaleidoscope-Keyclick
  • LED-ActiveLayerColor
  • LED-ActiveLayerKeys
  • LED-ActiveModColor
  • LED-AlphaSquare
  • LED-Palette-Theme
  • LED-Stalker
  • LED-Wavepool
  • LEDBrightnessConfig
  • LEDBrightnessControl
  • Kaleidoscope-LEDControl
  • LEDEffect-BootAnimation
  • LEDEffect-BootGreeting
  • LEDEffect-Breathe
  • LEDEffect-Chase
  • Kaleidoscope-LEDEffect-DigitalRain
  • LEDEffect-Rainbow
  • LEDEffect-SolidColor
  • LEDEffects
  • Kaleidoscope-LEDIndicators
  • LayerFocus
  • LayerNames
  • Leader
  • LongPress
  • MacroSupport
  • Macros
  • MagicCombo
  • MouseKeys
  • NumPad
  • OneShot
  • OneShot Meta Keys
  • PrefixLayer
  • Qukeys
  • Ranges
  • Redial
  • ShapeShifter
  • SpaceCadet
  • Steno
  • Syster
  • TapDance
  • TopsyTurvy
  • Turbo
  • TypingBreaks
  • USB-Quirks
  • Unicode
  • WinKeyToggle

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

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

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 Event Handlers
  • Kaleidoscope Plugin API Internals

Device Drivers

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

Testing

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

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: How to write a Kaleidoscope plugin
    • Next: AutoShift
©2013-2025, Keyboardio & Friends. | Powered by Sphinx 8.2.3 & Alabaster 1.0.0 | Page source