temp

// -*- mode: c++ -*-
// Copyright 2016 Keyboardio, inc. <jesse@keyboard.io>
// See "LICENSE" for license details

#ifndef BUILD_INFORMATION
#define BUILD_INFORMATION "locally built"
#endif


/**
 * These #include directives pull in the Kaleidoscope firmware core,
 * as well as the Kaleidoscope plugins we use in the Model 01'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"
#include "Kaleidoscope-SimpleKeyColormapper.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 01'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
     };



/** The Model 01's key layouts are defined as 'keymaps'. By default, there are three
  * keymaps: The standard QWERTY keymap, the "Function layer" keymap and the "Numpad"
  * keymap.
  *
  * Each keymap is defined as a list using the 'KEYMAP_STACKED' macro, built
  * of first the left hand's layout, followed by the right hand's layout.
  *
  * Keymaps typically consist mostly of `Key_` definitions. There are many, many keys
  * defined as part of the USB HID Keyboard specification. You can find the names
  * (if not yet the explanations) for all the standard `Key_` defintions offered by
  * Kaleidoscope in these files:
  *    https://github.com/keyboardio/Kaleidoscope/blob/master/src/kaleidoscope/key_defs_keyboard.h
  *    https://github.com/keyboardio/Kaleidoscope/blob/master/src/kaleidoscope/key_defs_consumerctl.h
  *    https://github.com/keyboardio/Kaleidoscope/blob/master/src/kaleidoscope/key_defs_sysctl.h
  *    https://github.com/keyboardio/Kaleidoscope/blob/master/src/kaleidoscope/key_defs_keymaps.h
  *
  * Additional things that should be documented here include
  *   using ___ to let keypresses fall through to the previously active layer
  *   using XXX to mark a keyswitch as 'blocked' on this layer
  *   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 {QWERTY,NUMPAD,FUNCTION,BUTTERFLY,CAPSON}; // layers
const Key keymaps[][ROWS][COLS] PROGMEM = {
[QWERTY] = KEYMAP_STACKED
(LockLayer(CAPSON),Key_1,Key_6,Key_2,Key_3,Key_4,Key_5,Key_Backtick,Key_Q,Key_W,Key_E,Key_R,Key_T,Key_Tab,Key_Home,Key_A,Key_S,Key_D,Key_F,Key_G,Key_End,Key_Z,Key_X,Key_C,Key_V,Key_B,Key_Escape,Key_LeftShift,Key_Backspace,Key_LeftAlt,Key_LeftControl,ShiftToLayer(FUNCTION),Key_8,Key_9,Key_0,Key_Minus,Key_7,Key_Equals,LockLayer(NUMPAD),Key_Enter,Key_Y,Key_U,Key_I,Key_O,Key_P,Key_LeftBracket,Key_H,Key_J,Key_K,Key_L,Key_Semicolon,Key_Quote,LockLayer(BUTTERFLY),Key_N,Key_M,Key_Comma,Key_Period,Key_Slash,Key_RightBracket,Key_RightControl,Key_RightAlt,Key_Spacebar,Key_RightShift,ShiftToLayer(FUNCTION)),
[NUMPAD] = KEYMAP_STACKED
(___,___,___,___,___,___,Key_5,___,___,___,___,___,___,Key_Tab,___,___,___,___,___,___,___,___,___,___,___,___,Key_Escape,Key_LeftShift,Key_Backspace,Key_LeftAlt,Key_LeftControl,ShiftToLayer(FUNCTION),___,___,Key_Keypad7,Key_Keypad8,Key_Keypad9,Key_2,LockLayer(NUMPAD),Key_Enter,___,Key_Keypad4,Key_Keypad5,Key_Keypad6,Key_KeypadAdd,LSHIFT(Key_LeftBracket),___,Key_Keypad1,Key_Keypad2,Key_Keypad3,Key_KeypadSubtract,Key_Quote,LockLayer(BUTTERFLY),___,Key_Keypad0,Key_KeypadDot,Key_KeypadMultiply,Key_KeypadDivide,Key_Enter,Key_RightControl,Key_RightAlt,Key_Spacebar,Key_RightShift,ShiftToLayer(FUNCTION)),
[FUNCTION] = KEYMAP_STACKED
(Key_PageUp,Key_F1,Key_F2,Key_F3,Key_F4,Key_F5,Key_LEDEffectNext,Key_PageDown,Key_mouseWarpEnd,Key_Insert,Key_mouseUp,Key_mouseBtnM,Key_mouseBtnR,Key_mouseWarpNE,LSHIFT(Key_End),Key_mouseWarpNW,Key_mouseL,Key_mouseDn,Key_mouseR,Key_mouseBtnL,LSHIFT(Key_Home),LCTRL(Key_Slash),LCTRL(Key_B),LCTRL(Key_I),LCTRL(Key_Period),Key_mouseWarpSW,Key_mouseWarpSE,Key_LeftShift,Key_Delete,Key_LeftAlt,Key_LeftControl,ShiftToLayer(FUNCTION),Consumer_ScanPreviousTrack,Key_F6,Key_F7,Key_F8,Key_F9,Key_F10,Key_F11,Consumer_PlaySlashPause,Key_PageUp,Key_Home,Key_UpArrow,Key_End,Key_0,Key_F12,Key_PageDown,Key_LeftArrow,Key_DownArrow,Key_RightArrow,Key_3,Key_4,LockLayer(BUTTERFLY),___,Consumer_Mute,Consumer_VolumeDecrement,Consumer_VolumeIncrement,Key_Backslash,Key_Pipe,Key_RightControl,Key_RightAlt,Key_Spacebar,Key_RightShift,ShiftToLayer(FUNCTION)),
[BUTTERFLY] = KEYMAP_STACKED
(Key_PageUp,Key_F1,Key_F2,Key_F3,Key_F4,Key_F5,Key_LEDEffectNext,Key_PageDown,Key_mouseWarpEnd,Key_Insert,Key_mouseUp,Key_mouseBtnM,Key_mouseBtnR,Key_mouseWarpNE,LSHIFT(Key_End),Key_mouseWarpNW,Key_mouseL,Key_mouseDn,Key_mouseR,Key_mouseBtnL,LSHIFT(Key_Home),LCTRL(Key_Slash),LCTRL(Key_B),LCTRL(Key_I),LCTRL(Key_Period),Key_mouseWarpSW,Key_mouseWarpSE,Key_LeftShift,Key_Delete,Key_LeftAlt,Key_LeftControl,ShiftToLayer(FUNCTION),Consumer_ScanPreviousTrack,Key_F6,Key_F7,Key_F8,Key_F9,Key_F10,Key_F11,Consumer_PlaySlashPause,Consumer_ScanNextTrack, Key_LeftCurlyBracket,LSHIFT(Key_UpArrow),Key_2,Key_0,Key_F12,___,LSHIFT(Key_LeftArrow),LSHIFT(Key_DownArrow),LSHIFT(Key_RightArrow),Key_3,Key_4,LockLayer(BUTTERFLY),___,Consumer_Mute,Consumer_VolumeDecrement,Consumer_VolumeIncrement,Key_Backslash,Key_Pipe,Key_RightControl,Key_RightAlt,Key_Spacebar,Key_RightShift,ShiftToLayer(FUNCTION)),
[CAPSON] = KEYMAP_STACKED
(LockLayer(CAPSON),LSHIFT(Key_1),LSHIFT(Key_6),LSHIFT(Key_2),LSHIFT(Key_3),LSHIFT(Key_4),LSHIFT(Key_5),LSHIFT(Key_Backtick),LSHIFT(Key_Q),LSHIFT(Key_W),LSHIFT(Key_E),LSHIFT(Key_R),LSHIFT(Key_T),LSHIFT(Key_Tab),LSHIFT(Key_End),LSHIFT(Key_A),LSHIFT(Key_S),LSHIFT(Key_D),LSHIFT(Key_F),LSHIFT(Key_G),LSHIFT(Key_Home),LSHIFT(Key_Z),LSHIFT(Key_X),LSHIFT(Key_C),LSHIFT(Key_V),LSHIFT(Key_B),___,___,___,___,___,___,LSHIFT(Key_8),LSHIFT(Key_9),LSHIFT(Key_0),LSHIFT(Key_Minus),LSHIFT(Key_7),LSHIFT(Key_Equals),LockLayer(NUMPAD),Key_Enter,LSHIFT(Key_Y),LSHIFT(Key_U),LSHIFT(Key_I),LSHIFT(Key_O),LSHIFT(Key_P),LSHIFT(Key_LeftBracket),LSHIFT(Key_H),LSHIFT(Key_J),LSHIFT(Key_K),LSHIFT(Key_L),LSHIFT(Key_Semicolon),LSHIFT(Key_Quote),LockLayer(BUTTERFLY),LSHIFT(Key_N),LSHIFT(Key_M),LSHIFT(Key_Comma),LSHIFT(Key_Period),LSHIFT(Key_Slash),LSHIFT(Key_RightBracket),___,___,___,___,___)
};

/** 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 }
}, {
  .action = enterHardwareTestMode,
  // 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, solidGreen, 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(150);
  LEDRainbowWaveEffect.brightness(150);

  // 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();
}