diff options
| author | Peter Johanson <[email protected]> | 2024-03-27 20:35:40 -0700 |
|---|---|---|
| committer | Pete Johanson <[email protected]> | 2024-03-27 20:59:26 -0700 |
| commit | e66f068fb5d53f3e6071359970021d04a338c176 (patch) | |
| tree | 4d5d78b50d310dab25eca62e53ef7225d2d83e73 | |
| parent | 29c0cdb3abce98708f5961e01d96eefc9efb7d42 (diff) | |
| download | zmk-e66f068fb5d53f3e6071359970021d04a338c176.tar.gz zmk-e66f068fb5d53f3e6071359970021d04a338c176.zip | |
fix(docs): Minor soft-off docs tweaks from review.
| -rw-r--r-- | docs/docs/behaviors/soft-off.md | 2 | ||||
| -rw-r--r-- | docs/docs/config/kscan.md | 2 | ||||
| -rw-r--r-- | docs/docs/features/soft-off.md | 8 |
3 files changed, 9 insertions, 3 deletions
diff --git a/docs/docs/behaviors/soft-off.md b/docs/docs/behaviors/soft-off.md index 0537400495..14b5f36aee 100644 --- a/docs/docs/behaviors/soft-off.md +++ b/docs/docs/behaviors/soft-off.md @@ -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 diff --git a/docs/docs/config/kscan.md b/docs/docs/config/kscan.md index 4a3954f9f0..3aa1b37875 100644 --- a/docs/docs/config/kscan.md +++ b/docs/docs/config/kscan.md @@ -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 | diff --git a/docs/docs/features/soft-off.md b/docs/docs/features/soft-off.md index b08e1643fc..bd631f1b42 100644 --- a/docs/docs/features/soft-off.md +++ b/docs/docs/features/soft-off.md @@ -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; }; }; |