Skip to content

Commit e66f068

Browse files
committed
fix(docs): Minor soft-off docs tweaks from review.
1 parent 29c0cdb commit e66f068

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

docs/docs/behaviors/soft-off.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ sidebar_label: Soft Off
77

88
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.
99

10+
Refer to the [soft off config](../config/power.md#soft-off) for details on enabling soft off in order to use this behavior.
11+
1012
For more information, see the [Soft Off Feature](../features/soft-off.md) page.
1113

1214
### Behavior Binding

docs/docs/config/kscan.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Definition file: [zmk/app/module/dts/bindings/kscan/zmk,kscan-gpio-direct.yaml](
7373

7474
| Property | Type | Description | Default |
7575
| ------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------- | ------- |
76-
| `input-gpios` | GPIO array | Input GPIOs (one per key) | |
76+
| `input-gpios` | GPIO array | Input GPIOs (one per key). Can be either direct GPIO pin or `gpio-key` references. | |
7777
| `debounce-press-ms` | int | Debounce time for key press in milliseconds. Use 0 for eager debouncing. | 5 |
7878
| `debounce-release-ms` | int | Debounce time for key release in milliseconds. | 5 |
7979
| `debounce-scan-period-ms` | int | Time between reads in milliseconds when any key is pressed. | 1 |

docs/docs/features/soft-off.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ Once powered off, the keyboard will only wake up when:
1818
- You press the same button/sequence that you pressed to power off the keyboard, or
1919
- You press a reset button found on the keyboard.
2020

21+
## Config
22+
23+
Refer to the [soft off config](../config/power.md#soft-off) for details on enabling soft off.
24+
2125
## Soft Off With Existing Designs
2226

2327
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
104108
```
105109
soft_off_direct_scan: soft_off_direct_scan {
106110
compatible = "zmk,kscan-gpio-direct";
107-
input-keys = <&wakeup_key>;
111+
input-keys = <&on_off_key>;
108112
wakeup-source;
109113
};
110114
```
@@ -240,7 +244,7 @@ Next, we need to add another device which will be enabled only when the keyboard
240244
wakeup_source: wakeup_source {
241245
compatible = "zmk,gpio-key-wakeup-trigger";
242246
243-
trigger = <&wakeup_key>;
247+
trigger = <&on_off_key>;
244248
wakeup-source;
245249
};
246250
};

0 commit comments

Comments
 (0)