Skip to content

Commit

Permalink
docs: Fix wakeup-source property location for composite kscan
Browse files Browse the repository at this point in the history
  • Loading branch information
@caksoylar
caksoylar committed Mar 9, 2025
1 parent eb170c9 commit eb0a53f
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions docs/docs/config/kscan.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -216,19 +216,21 @@ 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 | |
| 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 |
| 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 |

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

Expand Down

0 comments on commit eb0a53f

Please sign in to comment.