History

Gergely Nagy 26340b7edb Rename the `command` arg of `onFocusEvent` to `input` With the new patterns, `Focus.inputMatchesCommand(command, cmd)` felt wrong, so this patch renames the `command` argument of `onFocusEvent()` to `input`, to better match what it really is. Signed-off-by: Gergely Nagy <algernon@keyboard.io>		2 years ago
..
src	Rename the `command` arg of `onFocusEvent` to `input`	2 years ago
README.md	Cleanups for typos and broken links across the documentation	4 years ago
library.properties	More library tweaking to comply with arduino requirements	4 years ago

README.md

FirmwareDump

This plugin provides a single Focus command: firmware.dump, which dumps the firmware's executable code. One might rightfully wonder what purpose this serves when the source code is available, but rest assured, there is one: in case one wants to temporarily replace their firmware, then put it back on, without having to carry the HEX file around, this command makes that possible: dump the contents, turn them into HEX, and it can be re-flashed at any point. We get a HEX file on-demand, and don't have to carry it around!

The intended primary user of this feature is Chrysalis.

Using the plugin

To use the plugin, include the header, and add it to your list of plugins:

#include <Kaleidoscope.h>
#include <Kaleidoscope-FocusSerial.h>
#include <Kaleidoscope-FirmwareDump.h>

KALEIDOSCOPE_INIT_PLUGINS(FocusSerial, FirmwareDump);

void setup () {
  Kaleidoscope.setup();
}

Focus commands

The plugin provides a single Focus command:

`firmware.dump`

Dumps the entire firmware (bootloader not included), even the unused parts.

Dependencies

[Kaleidoscope-FocusSerial][Kaleidoscope-FocusSerial.md]