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
- 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
For users¶
Customizing your firmware
For developers¶
Understanding the codebase
API Design
Testing
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