History

Gergely Nagy 8ac4d9f5c1 A more efficient way to handle onFocusEvent commands In the past, we were using `Focus.handleHelp()` to see if we're handling a `help` command, and print the commands supported by the handler. We also used `strcmp_P` directly to compare (parts of) our input against command supported by the handler. This approach works, but had multiple major disadvantages: it duplicated strings between `handleHelp` and the `strcmp_P` calls, and it relied on fragile substring pointers to save space. To replace all that, this patch implements a different approach. Help handling is split between a check (`Focus.inputMatchesHelp()`) and a reply (`Focus.printHelp()`), the latter of which takes a list of `PSTR()` strings, rather than one single string. This allows us to reuse the same strings for comparing against the handler's input. The new approach no longer uses the fragile substring pointers, nor does it use `strcmp_P` directly, but goes through a wrapper (`Focus.inputMatchesCommand()`) instead. These changes lead to a more readable pattern. While we do use longer strings as a result, there is less duplication, and the new patterns also require less code, so we end up with saving space, at least on AVR devices. The old methods are still available and usable, but they're deprecated. Signed-off-by: Gergely Nagy <algernon@keyboard.io>		2 years ago
..
src	A more efficient way to handle onFocusEvent commands	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]