alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5f5b715f8e'
${ noResults }
Kaleidoscope/plugins/Kaleidoscope-FirmwareDump
History
Michael Richters 403ea4a8ec
Remove unnecessary constructor definitions 		3 years ago
..
src Remove unnecessary constructor definitions 3 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]