kofal.net/zmk
1
0
Fork 1
mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-22 14:05:17 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): Update config docs for review feedback

Browse Source
This commit is contained in:
Joel Spadin
2022-05-03 21:28:41 -05:00
committed by Dom H
parent 01ffea1b47
commit e0e0928f9c
5 changed files with 27 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/features/combos.md
View File

@@ -25,7 +25,7 @@ Combos configured in your `.keymap` file, but are separate from the `keymap` nod
- The name of the combo doesn't really matter, but convention is to start the node name with `combo_`.
- The `compatible` property should always be `"zmk,combos"` for combos.
- All the keys must be pressed within `timeout-ms` milliseconds to trigger the combo.
- All the keys in `key-positions` must be pressed within `timeout-ms` milliseconds to trigger the combo.
- `key-positions` is an array of key positions. See the info section below about how to figure out the positions on your board.
- `layers = <0 1...>` will allow limiting a combo to specific layers. This is an _optional_ parameter, when omitted it defaults to global scope.
- `bindings` is the behavior that is activated when the behavior is pressed.

10
docs/docs/features/debouncing.md
View File

@@ -19,14 +19,20 @@ socket or using some sharp tweezers to bend the contacts back together.
## Debounce Configuration
:::note
Currently only the `zmk,kscan-gpio-matrix` driver supports these options. The other drivers have not yet been updated to use the new debouncing code.
:::
### Global Options
You can set these options in your `.conf` file to control debouncing globally.
Values must be <= 127.
Values must be <= 16383.
- `CONFIG_ZMK_KSCAN_DEBOUNCE_PRESS_MS`: Debounce time for key press in milliseconds. Default = 5.
- `CONFIG_ZMK_KSCAN_DEBOUNCE_RELEASE_MS`: Debounce time for key release in milliseconds. Default = 5.
If one of these options is set, it overrides the matching per-driver option described below.
For example, this would shorten the debounce time for both press and release:
```ini
@@ -37,7 +43,7 @@ CONFIG_ZMK_KSCAN_DEBOUNCE_RELEASE_MS=3
### Per-driver Options
You can add these Devicetree properties to a kscan node to control debouncing for
that instance of the driver. Values must be <= 127.
that instance of the driver. Values must be <= 16383.
- `debounce-press-ms`: Debounce time for key press in milliseconds. Default = 5.
- `debounce-release-ms`: Debounce time for key release in milliseconds. Default = 5.

2
docs/docs/features/underglow.md
View File

@@ -145,7 +145,7 @@ Once you have your `led_strip` properly defined you need to add it to the root d
};
```
Finally you need to enable the `CONFIG_ZMK_RGB_UNDERGLOW` and `CONFIG*_STRIP` configuration values in the `.conf` file of your board (or set a default in the `Kconfig.defconfig`):
Finally you need to enable the `CONFIG_ZMK_RGB_UNDERGLOW` and `CONFIG_*_STRIP` configuration values in the `.conf` file of your board (or set a default in the `Kconfig.defconfig`):
```
CONFIG_ZMK_RGB_UNDERGLOW=y