Skip to content

Commit

Permalink
fix(docs): Minor soft-off docs tweaks from review.
Browse files Browse the repository at this point in the history
  • Loading branch information
petejohanson committed Mar 28, 2024
1 parent 89f564d commit e414937
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/docs/behaviors/soft-off.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ sidebar_label: Soft Off

The soft off behavior is used to force the keyboard into an off state. Depending on the specific keyboard hardware, the keyboard can be turned back on again either with a dedicated on/off button that is available, or using the reset button found on the device.

Refer to the [soft off config](../config/power.md#soft-off) for details on enabling soft off in order to use this behavior.

For more information, see the [Soft Off Feature](../features/soft-off.md) page.

### Behavior Binding
Expand Down
8 changes: 6 additions & 2 deletions docs/docs/features/soft-off.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ Once powered off, the keyboard will only wake up when:
- You press the same button/sequence that you pressed to power off the keyboard, or
- You press a reset button found on the keyboard.

## Config

Refer to the [soft off config](../config/power.md#soft-off) for details on enabling soft off.

## Soft Off With Existing Designs

For existing designs, using soft off is as simple as placing the [Soft Off Behavior](../behaviors/soft-off.md) in your keymap and then invoking it.
Expand Down Expand Up @@ -104,7 +108,7 @@ With a simple direct pin setup, the The [direct kscan](../config/kscan.md) drive
```
soft_off_direct_scan: soft_off_direct_scan {
compatible = "zmk,kscan-gpio-direct";
input-keys = <&wakeup_key>;
input-keys = <&on_off_key>;
wakeup-source;
};
```
Expand Down Expand Up @@ -240,7 +244,7 @@ Next, we need to add another device which will be enabled only when the keyboard
wakeup_source: wakeup_source {
compatible = "zmk,gpio-key-wakeup-trigger";
trigger = <&wakeup_key>;
trigger = <&on_off_key>;
wakeup-source;
};
};
Expand Down

0 comments on commit e414937

Please sign in to comment.