Skip to content

Commit

Permalink
docs: Fix columns names in kscan config
Browse files Browse the repository at this point in the history
  • Loading branch information
caksoylar committed Oct 8, 2024
1 parent 6e2d30d commit 16976db
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/docs/config/kscan.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

| Property | Type | Description | Default |
| -------- | ---- | --------------------------------------------- | ------- |
| `rows` | int | The number of rows in the composite matrix | |
| `cols` | 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 | |

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:

Expand Down Expand Up @@ -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 | |
| `events` | array | List of key events to simulate | |
| `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 |

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).
Expand Down

0 comments on commit 16976db

Please sign in to comment.