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

docs: touchups on the soft off information for improved clarity. (#2647)

Browse Source
This commit is contained in:
Nicolas Munnich
2024-11-15 00:44:40 +01:00
committed by GitHub
parent e4339241ea
commit 58de2eb5e9
5 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/development/hardware-integration/includes/_gpio-key-matrix.md
View File

@@ -11,4 +11,4 @@ Here is an example for a keyboard with a GPIO pin that reads from the matrix:
};
```
Matrix inputs are triggered by pulling the specified pin high, typically by pressing some combination of switches which connects the matrix input to a matrix output.
MCU inputs are triggered by pulling the specified pin high, typically by pressing some combination of switches which connects the MCU input to an MCU output.

1
docs/docs/development/hardware-integration/includes/_gpio-key-wakeup.md
View File

@@ -12,3 +12,4 @@ Here is an example for a keyboard with a GPIO pin reused from a matrix kscan:
```
The GPIO settings should match those in the kscan, so the above would be set to `(GPIO_ACTIVE_LOW | GPIO_PULL_UP)` for a direct kscan.
The specified pin should be the MCU input pin of the switch used for waking from soft off (for a `col2row` matrix, the MCU input pins are the row pins).

1
docs/docs/development/hardware-integration/includes/_soft-off-behavior.md
View File

@@ -8,6 +8,7 @@ Behind the scenes, a hardware dedicated GPIO pin utilizes the [soft off behavior
hw_soft_off: hw_soft_off {
compatible = "zmk,behavior-soft-off";
#binding-cells = <0>;
split-peripheral-off-on-press; // Turn peripheral off immediately for reliability
hold-time-ms = <2000>; // Only turn off if the key is held for 2 seconds or longer.
};
};

1
docs/docs/development/hardware-integration/includes/_soft-off-waker.md
View File

@@ -14,3 +14,4 @@ We need to add another device which will be enabled only when the keyboard is go
```
The properties for the `gpio-key-wakeup-trigger` node can be found in the [appropriate configuration section](../../../config/power.md#gpio-key-wakeup-trigger).
In particular, note the `extra-gpios` property containing the MCU output pins of any keys used to wake the keyboard (for a `col2row` matrix, these are your columns).