wxcafe/Model01-Firmware
1
0
Fork 0
Code Releases Activity

Documentation fixups

Browse Source 
Fixed up some of the USBQuirks and MagicCombo-related documentation, based on
feedback from @obra.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
This commit is contained in:
Gergely Nagy 2018-07-01 23:06:11 +02:00
parent 583d5429cd
commit 1e6c2c702c
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Model01-Firmware.ino
View File

@ -291,7 +291,11 @@ void hostPowerManagementEventHandler(kaleidoscope::HostPowerManagement::Event ev
* These are the names of your magic combos. They will be used by the * These are the names of your magic combos. They will be used by the
* `USE_MAGIC_COMBOS` call below. * `USE_MAGIC_COMBOS` call below.
*/ */
enum { COMBO_PROTOCOL_TOGGLE }; enum {
// Toggle between Boot (6-key rollover; for BIOSes and early boot) and NKRO
// mode.
COMBO_TOGGLE_NKRO_MODE
};
static void toggleKeyboardProtocol(uint8_t combo_index) { static void toggleKeyboardProtocol(uint8_t combo_index) {
USBQuirks.toggleKeyboardProtocol(); USBQuirks.toggleKeyboardProtocol();
@ -300,7 +304,7 @@ static void toggleKeyboardProtocol(uint8_t combo_index) {
/** Magic combo list, a list of key combo and action pairs the firmware should /** Magic combo list, a list of key combo and action pairs the firmware should
* recognise. * recognise.
*/ */
USE_MAGIC_COMBOS([COMBO_PROTOCOL_TOGGLE] = {.action = toggleKeyboardProtocol, USE_MAGIC_COMBOS([COMBO_TOGGLE_NKRO_MODE] = {.action = toggleKeyboardProtocol,
// Left Fn + Esc + Shift // Left Fn + Esc + Shift
.keys = { R3C6, R2C6, R3C7 } .keys = { R3C6, R2C6, R3C7 }
}); });
@ -361,12 +365,14 @@ KALEIDOSCOPE_INIT_PLUGINS(
HostPowerManagement, HostPowerManagement,
// The MagicCombo plugin lets you use key combinations to trigger custom // The MagicCombo plugin lets you use key combinations to trigger custom
// actions - a bit like Macros, but use multiple keys instead of one. // actions - a bit like Macros, but triggered by pressing multiple keys at the
// same time.
MagicCombo, MagicCombo,
// The USBQuriks plugin lets you do some quirky business with USB, such as // The USBQuirks plugin lets you do some things with USB that we aren't
// toggling the key report protocol between Boot (used by BIOSes) and Report // comfortable - or able - to do automatically, but can be useful
// (NKRO). // nevertheless. Such as toggling the key report protocol between Boot (used
// by BIOSes) and Report (NKRO).
USBQuirks USBQuirks
); );