Kaleidoscope
latest

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
    • AutoShift
    • CharShift
    • Colormap
    • 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
    • LED-ActiveLayerColor
    • LED-ActiveModColor
    • LED-AlphaSquare
    • LED-Palette-Theme
    • LED-Stalker
    • LED-Wavepool
    • LEDBrightnessConfig
    • Kaleidoscope-LEDControl
    • LEDEffect-BootAnimation
    • LEDEffect-BootGreeting
    • LEDEffect-Breathe
    • LEDEffect-Chase
    • Kaleidoscope-LEDEffect-DigitalRain
    • LEDEffect-Rainbow
    • LEDEffect-SolidColor
    • LEDEffects
    • LayerFocus
    • LayerNames
    • Leader
    • 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

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
Kaleidoscope
  • Docs »
  • Bundled plugins
  • Edit on GitHub

Bundled plugins¶

Bundled plugins

  • AutoShift
  • CharShift
  • Colormap
  • 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
  • LED-ActiveLayerColor
  • LED-ActiveModColor
  • LED-AlphaSquare
  • LED-Palette-Theme
  • LED-Stalker
  • LED-Wavepool
  • LEDBrightnessConfig
  • Kaleidoscope-LEDControl
  • LEDEffect-BootAnimation
  • LEDEffect-BootGreeting
  • LEDEffect-Breathe
  • LEDEffect-Chase
  • Kaleidoscope-LEDEffect-DigitalRain
  • LEDEffect-Rainbow
  • LEDEffect-SolidColor
  • LEDEffects
  • LayerFocus
  • LayerNames
  • Leader
  • 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
Next Previous

© Copyright 2023, Keyboardio & Friends Revision bd14e553.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.