From 1200082996d57557f9466757f6712b2141c44004 Mon Sep 17 00:00:00 2001 From: Gergely Polonkai Date: Wed, 1 Jun 2022 10:29:04 +0200 Subject: [PATCH] Remove unnecessary comments --- Model100.ino | 267 +-------------------------------------------------- 1 file changed, 1 insertion(+), 266 deletions(-) diff --git a/Model100.ino b/Model100.ino index 50fc905..6316a8b 100644 --- a/Model100.ino +++ b/Model100.ino @@ -7,87 +7,28 @@ #endif -/** - * These #include directives pull in the Kaleidoscope firmware core, - * as well as the Kaleidoscope plugins we use in the Model 100's firmware - */ - - -// The Kaleidoscope core #include "Kaleidoscope.h" - -// Support for storing the keymap in EEPROM #include "Kaleidoscope-EEPROM-Settings.h" #include "Kaleidoscope-EEPROM-Keymap.h" - -// Support for communicating with the host via a simple Serial protocol #include "Kaleidoscope-FocusSerial.h" - -// Support for keys that move the mouse #include "Kaleidoscope-MouseKeys.h" - -// Support for macros #include "Kaleidoscope-Macros.h" - -// Support for controlling the keyboard's LEDs #include "Kaleidoscope-LEDControl.h" - -// Support for "Numpad" mode, which is mostly just the Numpad specific LED mode #include "Kaleidoscope-NumPad.h" - -// Support for the "Boot greeting" effect, which pulses the 'LED' button for 10s -// when the keyboard is connected to a computer (or that computer is powered on) #include "Kaleidoscope-LEDEffect-BootGreeting.h" - -// Support for LED modes that set all LEDs to a single color #include "Kaleidoscope-LEDEffect-SolidColor.h" - -// Support for an LED mode that makes all the LEDs 'breathe' #include "Kaleidoscope-LEDEffect-Breathe.h" - -// Support for an LED mode that makes a red pixel chase a blue pixel across the keyboard #include "Kaleidoscope-LEDEffect-Chase.h" - -// Support for LED modes that pulse the keyboard's LED in a rainbow pattern #include "Kaleidoscope-LEDEffect-Rainbow.h" - -// Support for an LED mode that lights up the keys as you press them #include "Kaleidoscope-LED-Stalker.h" - -// Support for an LED mode that prints the keys you press in letters 4px high #include "Kaleidoscope-LED-AlphaSquare.h" - -// Support for shared palettes for other plugins, like Colormap below #include "Kaleidoscope-LED-Palette-Theme.h" - -// Support for an LED mode that lets one configure per-layer color maps #include "Kaleidoscope-Colormap.h" - -// Support for Keyboardio's internal keyboard testing mode #include "Kaleidoscope-HardwareTestMode.h" - -// Support for host power management (suspend & wakeup) #include "Kaleidoscope-HostPowerManagement.h" - -// Support for magic combos (key chords that trigger an action) #include "Kaleidoscope-MagicCombo.h" - -// Support for USB quirks, like changing the key state report protocol #include "Kaleidoscope-USB-Quirks.h" -/** This 'enum' is a list of all the macros used by the Model 100's firmware - * The names aren't particularly important. What is important is that each - * is unique. - * - * These are the names of your macros. They'll be used in two places. - * The first is in your keymap definitions. There, you'll use the syntax - * `M(MACRO_NAME)` to mark a specific keymap position as triggering `MACRO_NAME` - * - * The second usage is in the 'switch' statement in the `macroAction` function. - * That switch statement actually runs the code associated with a macro when - * a macro key is pressed. - */ - enum { MACRO_VERSION_INFO, MACRO_ANY, @@ -116,56 +57,18 @@ enum { * using ShiftToLayer() and LockLayer() keys to change the active keymap. * keeping NUM and FN consistent and accessible on all layers * - * The PROG key is special, since it is how you indicate to the board that you - * want to flash the firmware. However, it can be remapped to a regular key. - * When the keyboard boots, it first looks to see whether the PROG key is held - * down; if it is, it simply awaits further flashing instructions. If it is - * not, it continues loading the rest of the firmware and the keyboard - * functions normally, with whatever binding you have set to PROG. More detail - * here: https://community.keyboard.io/t/how-the-prog-key-gets-you-into-the-bootloader/506/8 - * - * The "keymaps" data structure is a list of the keymaps compiled into the firmware. - * The order of keymaps in the list is important, as the ShiftToLayer(#) and LockLayer(#) - * macros switch to key layers based on this list. - * - * - * A key defined as 'ShiftToLayer(FUNCTION)' will switch to FUNCTION while held. * Similarly, a key defined as 'LockLayer(NUMPAD)' will switch to NUMPAD when tapped. */ -/** - * Layers are "0-indexed" -- That is the first one is layer 0. The second one is layer 1. - * The third one is layer 2. - * This 'enum' lets us use names like QWERTY, FUNCTION, and NUMPAD in place of - * the numbers 0, 1 and 2. - * - */ - enum { PRIMARY, NUMPAD, FUNCTION, -}; // layers +}; -/** - * To change your keyboard's layout from QWERTY to DVORAK or COLEMAK, comment out the line - * - * #define PRIMARY_KEYMAP_QWERTY - * - * by changing it to - * - * // #define PRIMARY_KEYMAP_QWERTY - * - * Then uncomment the line corresponding to the layout you want to use. - * - */ - #define PRIMARY_KEYMAP_QWERTY -// #define PRIMARY_KEYMAP_DVORAK -// #define PRIMARY_KEYMAP_COLEMAK -// #define PRIMARY_KEYMAP_CUSTOM /* This comment temporarily turns off astyle's indent enforcement @@ -284,11 +187,6 @@ KEYMAPS( /* Re-enable astyle's indent enforcement */ // clang-format on -/** versionInfoMacro handles the 'firmware version info' macro - * When a key bound to the macro is pressed, this macro - * prints out the firmware build information as virtual keystrokes - */ - static void versionInfoMacro(uint8_t key_state) { if (keyToggledOn(key_state)) { Macros.type(PSTR("Keyboardio Model 100 - Kaleidoscope ")); @@ -296,14 +194,6 @@ static void versionInfoMacro(uint8_t key_state) { } } -/** anyKeyMacro is used to provide the functionality of the 'Any' key. - * - * When the 'any key' macro is toggled on, a random alphanumeric key is - * selected. While the key is held, the function generates a synthetic - * keypress event repeating that randomly selected key. - * - */ - static void anyKeyMacro(KeyEvent &event) { if (keyToggledOn(event.state)) { event.key.setKeyCode(Key_A.getKeyCode() + (uint8_t)(millis() % 36)); @@ -311,19 +201,6 @@ static void anyKeyMacro(KeyEvent &event) { } } - -/** macroAction dispatches keymap events that are tied to a macro - to that macro. It takes two uint8_t parameters. - - The first is the macro being called (the entry in the 'enum' earlier in this file). - The second is the state of the keyswitch. You can use the keyswitch state to figure out - if the key has just been toggled on, is currently pressed or if it's just been released. - - The 'switch' statement should have a 'case' for each entry of the macro enum. - Each 'case' statement should call out to a function to handle the macro in question. - - */ - const macro_t *macroAction(uint8_t macro_id, KeyEvent &event) { switch (macro_id) { @@ -339,11 +216,6 @@ const macro_t *macroAction(uint8_t macro_id, KeyEvent &event) { } -// These 'solid' color effect definitions define a rainbow of -// LED color modes calibrated to draw 500mA or less on the -// Keyboardio Model 100. - - static kaleidoscope::plugin::LEDSolidColor solidRed(160, 0, 0); static kaleidoscope::plugin::LEDSolidColor solidOrange(140, 70, 0); static kaleidoscope::plugin::LEDSolidColor solidYellow(130, 100, 0); @@ -352,9 +224,6 @@ static kaleidoscope::plugin::LEDSolidColor solidBlue(0, 70, 130); static kaleidoscope::plugin::LEDSolidColor solidIndigo(0, 0, 170); static kaleidoscope::plugin::LEDSolidColor solidViolet(130, 0, 120); -/** toggleLedsOnSuspendResume toggles the LEDs off when the host goes to sleep, - * and turns them back on when it wakes up. - */ void toggleLedsOnSuspendResume(kaleidoscope::plugin::HostPowerManagement::Event event) { switch (event) { case kaleidoscope::plugin::HostPowerManagement::Suspend: @@ -368,50 +237,23 @@ void toggleLedsOnSuspendResume(kaleidoscope::plugin::HostPowerManagement::Event } } -/** hostPowerManagementEventHandler dispatches power management events (suspend, - * resume, and sleep) to other functions that perform action based on these - * events. - */ void hostPowerManagementEventHandler(kaleidoscope::plugin::HostPowerManagement::Event event) { toggleLedsOnSuspendResume(event); } -/** This 'enum' is a list of all the magic combos used by the Model 100's - * firmware The names aren't particularly important. What is important is that - * each is unique. - * - * These are the names of your magic combos. They will be used by the - * `USE_MAGIC_COMBOS` call below. - */ enum { - // Toggle between Boot (6-key rollover; for BIOSes and early boot) and NKRO - // mode. COMBO_TOGGLE_NKRO_MODE, - // Enter test mode COMBO_ENTER_TEST_MODE }; -/** Wrappers, to be used by MagicCombo. **/ - -/** - * This simply toggles the keyboard protocol via USBQuirks, and wraps it within - * a function with an unused argument, to match what MagicCombo expects. - */ static void toggleKeyboardProtocol(uint8_t combo_index) { USBQuirks.toggleKeyboardProtocol(); } -/** - * This enters the hardware test mode - */ static void enterHardwareTestMode(uint8_t combo_index) { HardwareTestMode.runTests(); } - -/** Magic combo list, a list of key combo and action pairs the firmware should - * recognise. - */ USE_MAGIC_COMBOS({.action = toggleKeyboardProtocol, // Left Fn + Esc + Shift .keys = {R3C6, R2C6, R3C7}}, @@ -419,55 +261,19 @@ USE_MAGIC_COMBOS({.action = toggleKeyboardProtocol, // Left Fn + Prog + LED .keys = {R3C6, R0C0, R0C6}}); -// First, tell Kaleidoscope which plugins you want to use. -// The order can be important. For example, LED effects are -// added in the order they're listed here. KALEIDOSCOPE_INIT_PLUGINS( - // The EEPROMSettings & EEPROMKeymap plugins make it possible to have an - // editable keymap in EEPROM. EEPROMSettings, EEPROMKeymap, - - // Focus allows bi-directional communication with the host, and is the - // interface through which the keymap in EEPROM can be edited. Focus, - - // FocusSettingsCommand adds a few Focus commands, intended to aid in - // changing some settings of the keyboard, such as the default layer (via the - // `settings.defaultLayer` command) FocusSettingsCommand, - - // FocusEEPROMCommand adds a set of Focus commands, which are very helpful in - // both debugging, and in backing up one's EEPROM contents. FocusEEPROMCommand, - - // The boot greeting effect pulses the LED button for 10 seconds after the - // keyboard is first connected BootGreetingEffect, - - // The hardware test mode, which can be invoked by tapping Prog, LED and the - // left Fn button at the same time. HardwareTestMode, - - // LEDControl provides support for other LED modes LEDControl, - - // We start with the LED effect that turns off all the LEDs. LEDOff, - - // The rainbow effect changes the color of all of the keyboard's keys at the same time - // running through all the colors of the rainbow. LEDRainbowEffect, - - // The rainbow wave effect lights up your keyboard with all the colors of a rainbow - // and slowly moves the rainbow across your keyboard LEDRainbowWaveEffect, - - // The chase effect follows the adventure of a blue pixel which chases a red pixel across - // your keyboard. Spoiler: the blue pixel never catches the red pixel LEDChaseEffect, - - // These static effects turn your keyboard's LEDs a variety of colors solidRed, solidOrange, solidYellow, @@ -475,102 +281,31 @@ KALEIDOSCOPE_INIT_PLUGINS( solidBlue, solidIndigo, solidViolet, - - // The breathe effect slowly pulses all of the LEDs on your keyboard LEDBreatheEffect, - - // The AlphaSquare effect prints each character you type, using your - // keyboard's LEDs as a display AlphaSquareEffect, - - // The stalker effect lights up the keys you've pressed recently StalkerEffect, - - // The LED Palette Theme plugin provides a shared palette for other plugins, - // like Colormap below LEDPaletteTheme, - - // The Colormap effect makes it possible to set up per-layer colormaps ColormapEffect, - - // The numpad plugin is responsible for lighting up the 'numpad' mode - // with a custom LED effect NumPad, - - // The macros plugin adds support for macros Macros, - - // The MouseKeys plugin lets you add keys to your keymap which move the mouse. MouseKeys, - - // The HostPowerManagement plugin allows us to turn LEDs off when then host - // goes to sleep, and resume them when it wakes up. HostPowerManagement, - - // The MagicCombo plugin lets you use key combinations to trigger custom - // actions - a bit like Macros, but triggered by pressing multiple keys at the - // same time. MagicCombo, - - // The USBQuirks plugin lets you do some things with USB that we aren't - // comfortable - or able - to do automatically, but can be useful - // nevertheless. Such as toggling the key report protocol between Boot (used - // by BIOSes) and Report (NKRO). USBQuirks); -/** The 'setup' function is one of the two standard Arduino sketch functions. - * It's called when your keyboard first powers up. This is where you set up - * Kaleidoscope and any plugins. - */ void setup() { - // First, call Kaleidoscope's internal setup function Kaleidoscope.setup(); - - // While we hope to improve this in the future, the NumPad plugin - // needs to be explicitly told which keymap layer is your numpad layer NumPad.numPadLayer = NUMPAD; - - // We configure the AlphaSquare effect to use RED letters AlphaSquare.color = CRGB(255, 0, 0); - - // We set the brightness of the rainbow effects to 150 (on a scale of 0-255) - // This draws more than 500mA, but looks much nicer than a dimmer effect LEDRainbowEffect.brightness(255); LEDRainbowWaveEffect.brightness(255); - - // Set the action key the test mode should listen for to Left Fn HardwareTestMode.setActionKey(R3C6); - - // The LED Stalker mode has a few effects. The one we like is called - // 'BlazingTrail'. For details on other options, see - // https://github.com/keyboardio/Kaleidoscope/blob/master/docs/plugins/LED-Stalker.md StalkerEffect.variant = STALKER(BlazingTrail); - - // We want to make sure that the firmware starts with LED effects off - // This avoids over-taxing devices that don't have a lot of power to share - // with USB devices LEDOff.activate(); - - // To make the keymap editable without flashing new firmware, we store - // additional layers in EEPROM. For now, we reserve space for five layers. If - // one wants to use these layers, just set the default layer to one in EEPROM, - // by using the `settings.defaultLayer` Focus command, or by using the - // `keymap.onlyCustom` command to use EEPROM layers only. EEPROMKeymap.setup(5); - - // We need to tell the Colormap plugin how many layers we want to have custom - // maps for. To make things simple, we set it to five layers, which is how - // many editable layers we have (see above). ColormapEffect.max_layers(5); } -/** loop is the second of the standard Arduino sketch functions. - * As you might expect, it runs in a loop, never exiting. - * - * For Kaleidoscope-based keyboard firmware, you usually just want to - * call Kaleidoscope.loop(); and not do anything custom here. - */ - void loop() { Kaleidoscope.loop(); }