kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(docs): Minor soft-off docs tweaks from review.

Browse source
This commit is contained in:
Peter Johanson 2024-03-27 20:35:40 -07:00 • committed by Pete Johanson
parent 29c0cdb3ab
commit e66f068fb5
3 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/behaviors/soft-off.md
View file

@ -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

2
docs/docs/config/kscan.md
View file

@ -73,7 +73,7 @@ Definition file: [zmk/app/module/dts/bindings/kscan/zmk,kscan-gpio-direct.yaml](
| Property | Type | Description | Default |
| ------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------- | ------- |
| `input-gpios` | GPIO array | Input GPIOs (one per key) | |
| `input-gpios` | GPIO array | Input GPIOs (one per key). Can be either direct GPIO pin or `gpio-key` references. | |
| `debounce-press-ms` | int | Debounce time for key press in milliseconds. Use 0 for eager debouncing. | 5 |
| `debounce-release-ms` | int | Debounce time for key release in milliseconds. | 5 |
| `debounce-scan-period-ms` | int | Time between reads in milliseconds when any key is pressed. | 1 |

8
docs/docs/features/soft-off.md
View file

@ -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.
@ -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;
};
```
@ -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;
};
};