Skip to content

Commit f5a838b

Browse files
authored
docs: Fix wakeup-source property location for composite kscan (zmkfirmware#2861)
1 parent eb170c9 commit f5a838b

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

docs/docs/config/kscan.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -216,19 +216,21 @@ Applies to : `compatible = "zmk,kscan-composite"`
216216

217217
Definition file: [zmk/app/dts/bindings/zmk,kscan-composite.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/zmk,kscan-composite.yaml)
218218

219-
| Property | Type | Description | Default |
220-
| --------- | ---- | --------------------------------------------- | ------- |
221-
| `rows` | int | The number of rows in the composite matrix | |
222-
| `columns` | int | The number of columns in the composite matrix | |
219+
| Property | Type | Description | Default |
220+
| --------------- | ---- | ----------------------------------------------------- | ------- |
221+
| `rows` | int | The number of rows in the composite matrix | |
222+
| `columns` | int | The number of columns in the composite matrix | |
223+
| `wakeup-source` | bool | Mark this kscan instance as able to wake the keyboard | n |
223224

224225
The `zmk,kscan-composite` node should have one child node per keyboard scan driver that should be composited. Each child node can have the following properties:
225226

226-
| Property | Type | Description | Default |
227-
| --------------- | ------- | ------------------------------------------------------------------------------ | ------- |
228-
| `kscan` | phandle | Label of the kscan driver to include | |
229-
| `row-offset` | int | Shifts row 0 of the included driver to a new row in the composite matrix | 0 |
230-
| `col-offset` | int | Shifts column 0 of the included driver to a new column in the composite matrix | 0 |
231-
| `wakeup-source` | bool | Mark this kscan instance as able to wake the keyboard | n |
227+
| Property | Type | Description | Default |
228+
| ------------ | ------- | ------------------------------------------------------------------------------ | ------- |
229+
| `kscan` | phandle | Label of the kscan driver to include | |
230+
| `row-offset` | int | Shifts row 0 of the included driver to a new row in the composite matrix | 0 |
231+
| `col-offset` | int | Shifts column 0 of the included driver to a new column in the composite matrix | 0 |
232+
233+
If you want one of the composited kscans to be able to wake up the keyboard, make sure to set the `wakeup-source` property in its own definition, in addition to setting it for the composite kscan node itself as listed above.
232234

233235
### Example Configuration
234236

0 commit comments

Comments
 (0)