Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

docs: Fix columns names in kscan config

Browse Source
This commit is contained in:
Cem Aksoylar
2024-10-08 14:33:57 -07:00
parent 6e2d30d589
commit 16976db58c
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -216,10 +216,10 @@ 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) 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 | | Property | Type | Description | Default |
| -------- | ---- | --------------------------------------------- | ------- | | --------- | ---- | --------------------------------------------- | ------- |
| `rows` | int | The number of rows in the composite matrix | | | `rows` | int | The number of rows in the composite matrix | |
| `cols` | int | The number of columns in the composite matrix | | | `columns` | int | The number of columns in the composite matrix | |
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: 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:
@@ -331,7 +331,7 @@ Definition file: [zmk/app/dts/bindings/zmk,kscan-mock.yaml](https://github.com/z
| `event-period` | int | Milliseconds between each generated event | | | `event-period` | int | Milliseconds between each generated event | |
| `events` | array | List of key events to simulate | | | `events` | array | List of key events to simulate | |
| `rows` | int | The number of rows in the composite matrix | | | `rows` | int | The number of rows in the composite matrix | |
| `cols` | int | The number of columns in the composite matrix | | | `columns` | int | The number of columns in the composite matrix | |
| `exit-after` | bool | Exit the program after running all events | false | | `exit-after` | bool | Exit the program after running all events | false |
The `events` array should be defined using the macros from [app/module/include/dt-bindings/zmk/kscan_mock.h](https://github.com/zmkfirmware/zmk/blob/main/app/module/include/dt-bindings/zmk/kscan_mock.h). The `events` array should be defined using the macros from [app/module/include/dt-bindings/zmk/kscan_mock.h](https://github.com/zmkfirmware/zmk/blob/main/app/module/include/dt-bindings/zmk/kscan_mock.h).