310 lines
12 KiB
C++
310 lines
12 KiB
C++
// -*- mode: c++ -*-
|
|
// Copyright 2016 Keyboardio, inc. <jesse@keyboard.io>
|
|
// See "LICENSE" for license details
|
|
|
|
#ifndef BUILD_INFORMATION
|
|
#define BUILD_INFORMATION "locally built on " __DATE__ " at " __TIME__
|
|
#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"
|
|
|
|
// 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 Keyboardio's internal keyboard testing mode
|
|
#include "Kaleidoscope-HardwareTestMode.h"
|
|
|
|
// Support for host power management (suspend & wakeup)
|
|
#include "Kaleidoscope-HostPowerManagement.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,
|
|
};
|
|
|
|
|
|
|
|
/** 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 { PRIMARY, NUMPAD, FUNCTION }; // layers
|
|
|
|
|
|
/* This comment temporarily turns off astyle's indent enforcement
|
|
so we can make the keymaps actually resemble the physical key layout better
|
|
*/
|
|
// *INDENT-OFF*
|
|
|
|
KEYMAPS(
|
|
[PRIMARY] = KEYMAP_STACKED
|
|
(___, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext,
|
|
Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab,
|
|
Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G,
|
|
Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape,
|
|
Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift,
|
|
ShiftToLayer(FUNCTION),
|
|
|
|
___, Key_6, Key_7, Key_8, Key_9, Key_0, Key_Equals,
|
|
Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Backslash,
|
|
Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote,
|
|
Key_RightAlt, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus,
|
|
Key_RightShift, Key_LeftAlt, Key_Spacebar, Key_RightControl,
|
|
ShiftToLayer(FUNCTION)),
|
|
|
|
[NUMPAD] = KEYMAP_STACKED
|
|
(___, ___, ___, ___, ___, ___, ___,
|
|
___, ___, ___, ___, ___, ___, ___,
|
|
___, ___, ___, ___, ___, ___,
|
|
___, ___, ___, ___, ___, ___, ___,
|
|
___, ___, ___, ___,
|
|
___,
|
|
|
|
M(MACRO_VERSION_INFO), ___, Key_7, Key_8, Key_9, Key_KeypadSubtract, ___,
|
|
___, ___, Key_4, Key_5, Key_6, Key_KeypadAdd, ___,
|
|
___, Key_1, Key_2, Key_3, Key_Equals, ___,
|
|
___, ___, Key_0, Key_Period, Key_KeypadMultiply, Key_KeypadDivide, Key_Enter,
|
|
___, ___, ___, ___,
|
|
___),
|
|
|
|
[FUNCTION] = KEYMAP_STACKED
|
|
(___, Key_F1, Key_F2, Key_F3, Key_F4, Key_F5, Key_CapsLock,
|
|
Key_Tab, ___, Key_mouseUp, ___, Key_mouseBtnR, Key_mouseWarpEnd, Key_mouseWarpNE,
|
|
Key_Home, Key_mouseL, Key_mouseDn, Key_mouseR, Key_mouseBtnL, Key_mouseWarpNW,
|
|
Key_End, Key_PrintScreen, Key_Insert, ___, Key_mouseBtnM, Key_mouseWarpSW, Key_mouseWarpSE,
|
|
___, Key_Delete, ___, ___,
|
|
___,
|
|
|
|
Consumer_ScanPreviousTrack, Key_F6, Key_F7, Key_F8, Key_F9, Key_F10, Key_F11,
|
|
Consumer_PlaySlashPause, Consumer_ScanNextTrack, Key_LeftCurlyBracket, Key_RightCurlyBracket, Key_LeftBracket, Key_RightBracket, Key_F12,
|
|
Key_LeftArrow, Key_DownArrow, Key_UpArrow, Key_RightArrow, ___, LockLayer(NUMPAD),
|
|
Key_PcApplication, Consumer_Mute, Consumer_VolumeDecrement, Consumer_VolumeIncrement, ___, Key_Backslash, Key_Pipe,
|
|
___, ___, Key_Enter, ___,
|
|
___)
|
|
) // KEYMAPS(
|
|
|
|
/* Re-enable astyle's indent enforcement */
|
|
// *INDENT-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 keyState) {
|
|
if (keyToggledOn(keyState)) {
|
|
Macros.type(PSTR("Keyboardio Model 01 - Kaleidoscope "));
|
|
Macros.type(PSTR(BUILD_INFORMATION));
|
|
}
|
|
}
|
|
|
|
/** 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 macroIndex, uint8_t keyState) {
|
|
switch (macroIndex) {
|
|
case MACRO_VERSION_INFO:
|
|
versionInfoMacro(keyState);
|
|
break;
|
|
}
|
|
return MACRO_NONE;
|
|
}
|
|
|
|
|
|
/** 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:
|
|
LEDControl.disable();
|
|
break;
|
|
case kaleidoscope::plugin::HostPowerManagement::Resume:
|
|
LEDControl.enable();
|
|
break;
|
|
case kaleidoscope::plugin::HostPowerManagement::Sleep:
|
|
break;
|
|
}
|
|
}
|
|
|
|
/** 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);
|
|
}
|
|
|
|
// 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,
|
|
|
|
// 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 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 '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;
|
|
|
|
// Set the action key the test mode should listen for to Left Fn
|
|
HardwareTestMode.setActionKey(R3C6);
|
|
|
|
// 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();
|
|
}
|
|
|
|
/** 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();
|
|
}
|