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

Merge pull request #72 from tych0/doc-fixups

Browse Source 
Doc fixups
This commit is contained in:
Jesse Vincent 2018-12-09 12:30:16 -08:00 committed by GitHub
commit e56f0a3007
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Model01-Firmware.ino
View File

@ -108,9 +108,15 @@ enum { MACRO_VERSION_INFO,
* using ___ to let keypresses fall through to the previously active layer * using ___ to let keypresses fall through to the previously active layer
* using XXX to mark a keyswitch as 'blocked' on this layer * using XXX to mark a keyswitch as 'blocked' on this layer
* using ShiftToLayer() and LockLayer() keys to change the active keymap. * using ShiftToLayer() and LockLayer() keys to change the active keymap.
* the special nature of the PROG key
* keeping NUM and FN consistent and accessible on all layers * 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 "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(#) * The order of keymaps in the list is important, as the ShiftToLayer(#) and LockLayer(#)
@ -412,17 +418,21 @@ KALEIDOSCOPE_INIT_PLUGINS(
// interface through which the keymap in EEPROM can be edited. // interface through which the keymap in EEPROM can be edited.
Focus, 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 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, FocusSettingsCommand,
// FocusEEPROMCommand adds a set of Focus commands, which are very helpful in // FocusEEPROMCommand adds a set of Focus commands, which are very helpful in
// both debugging, and in backing up one's EEPROM contents. // both debugging, and in backing up one's EEPROM contents.
FocusEEPROMCommand, FocusEEPROMCommand,
// The boot greeting effect pulses the LED button for 10 seconds after the keyboard is first connected // The boot greeting effect pulses the LED button for 10 seconds after the
// keyboard is first connected
BootGreetingEffect, BootGreetingEffect,
// The hardware test mode, which can be invoked by tapping Prog, LED and the left Fn button at the same time. // The hardware test mode, which can be invoked by tapping Prog, LED and the
// left Fn button at the same time.
TestMode, TestMode,
// LEDControl provides support for other LED modes // LEDControl provides support for other LED modes