forked from kofal.net/zmk
feat(behaviors): Add &bootloader behavior.
* Allow reset behavior to have a type property. * Add `bootloader` node that triggers DFU UF2 bootloader mode using the AdaFruit nrf52 bootloader.
This commit is contained in:
43
docs/docs/behavior/reset.md
Normal file
43
docs/docs/behavior/reset.md
Normal file
@@ -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
|
||||
```
|
||||
@@ -12,6 +12,7 @@ module.exports = {
|
||||
"behavior/layers",
|
||||
"behavior/misc",
|
||||
"behavior/mod-tap",
|
||||
"behavior/reset",
|
||||
"behavior/lighting",
|
||||
],
|
||||
Development: [
|
||||
|
||||
Reference in New Issue
Block a user