diff options
| author | Pete Johanson <peter@peterjohanson.com> | 2020-08-21 11:30:40 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-21 11:30:40 -0400 |
| commit | c619fb9c58c8f2dbcc19d74e7502459b49633113 (patch) | |
| tree | e36950a4fa09259c007069f458376a910b80ead4 /docs | |
| parent | 1ff13676f7fbab5c0d69317be0d186709a7872c8 (diff) | |
| parent | 805ea770053269278fe0ed443b68f600021d82d1 (diff) | |
Merge pull request #116 from petejohanson/behaviors/reset-uf2-reset-node
Add `&bootloader` behavior, add reset docs.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/behavior/reset.md | 43 | ||||
| -rw-r--r-- | docs/sidebars.js | 1 |
2 files changed, 44 insertions, 0 deletions
diff --git a/docs/docs/behavior/reset.md b/docs/docs/behavior/reset.md new file mode 100644 index 0000000..8cf122b --- /dev/null +++ b/docs/docs/behavior/reset.md @@ -0,0 +1,43 @@ +--- +title: Reset Behaviors +sidebar_label: Reset +--- + +## Summary + +There are two available behaviors that can be used to trigger a reset of the keyboard. +The first is a soft reset, that will simply reset and re-run the currently flashed +firmware; the second when triggered will reset into the bootloader, allowing you to +flash a new firmware to the keyboard. + +## Reset + +The basic reset behavior will reset the keyboard and re-run the firmware flashed +to the device + +### Behavior Binding + +- Reference: `&reset` +- Parameters: None + +Example: + +``` +&reset +``` + +## Bootloader Reset + +The bootloader reset behavior will reset the keyboard and put it into bootloader mode, allowing +you to flash a new firmware. + +### Behavior Binding + +- Reference: `&bootloader` +- Parameters: None + +Example: + +``` +&bootloader +``` diff --git a/docs/sidebars.js b/docs/sidebars.js index 8c7c97f..51313fc 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -12,6 +12,7 @@ module.exports = { "behavior/layers", "behavior/misc", "behavior/mod-tap", + "behavior/reset", "behavior/lighting", ], Development: [ |