zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Fix wakeup-source property location for composite kscan (#2861)

This commit is contained in:
Cem Aksoylar 2025-03-09 14:59:57 -07:00 committed by GitHub
parent eb170c930f
commit f5a838b4bd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docs/config/kscan.md
View File

@ -217,18 +217,20 @@ Applies to : `compatible = "zmk,kscan-composite"`
Definition file: [zmk/app/dts/bindings/zmk,kscan-composite.yaml](https://github.com/zmkfirmware/zmk/blob/main/app/dts/bindings/zmk,kscan-composite.yaml)
| Property | Type | Description | Default |
| --------- | ---- | --------------------------------------------- | ------- |
| --------------- | ---- | ----------------------------------------------------- | ------- |
| `rows` | int | The number of rows in the composite matrix | |
| `columns` | int | The number of columns in the composite matrix | |
| `wakeup-source` | bool | Mark this kscan instance as able to wake the keyboard | n |
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:
| Property | Type | Description | Default |
| --------------- | ------- | ------------------------------------------------------------------------------ | ------- |
| ------------ | ------- | ------------------------------------------------------------------------------ | ------- |
| `kscan` | phandle | Label of the kscan driver to include | |
| `row-offset` | int | Shifts row 0 of the included driver to a new row in the composite matrix | 0 |
| `col-offset` | int | Shifts column 0 of the included driver to a new column in the composite matrix | 0 |
| `wakeup-source` | bool | Mark this kscan instance as able to wake the keyboard | n |
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.
### Example Configuration