aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorNicolas Munnich <[email protected]>2024-10-23 02:16:59 +0200
committerGitHub <[email protected]>2024-10-23 02:16:59 +0200
commit5487b108d5bbf6d8707fe9e013cd6b000bac1ee0 (patch)
tree7aadee4acb74aee19fa56237bb98a8dee67f3d21
parent55c67804eb4fac2c0cb6f04823ee97fec23d2235 (diff)
downloadzmk-5487b108d5bbf6d8707fe9e013cd6b000bac1ee0.tar.gz
zmk-5487b108d5bbf6d8707fe9e013cd6b000bac1ee0.zip
docs: fixing some more broken anchors (#2586)
-rw-r--r--docs/docs/config/kscan.md12
-rw-r--r--docs/docs/development/hardware-integration/physical-layouts.md2
2 files changed, 7 insertions, 7 deletions
diff --git a/docs/docs/config/kscan.md b/docs/docs/config/kscan.md
index dfe22bf49d..e3fa8969f4 100644
--- a/docs/docs/config/kscan.md
+++ b/docs/docs/config/kscan.md
@@ -27,10 +27,10 @@ If the debounce press/release values are set to any value other than `-1`, they
Applies to: [`/chosen` node](https://docs.zephyrproject.org/3.5.0/build/dts/intro-syntax-structure.html#aliases-and-chosen-nodes)
-| Property | Type | Description |
-| ---------------------- | ---- | ------------------------------------------------------------- |
-| `zmk,kscan` | path | The node for the keyboard scan driver to use |
-| `zmk,matrix-transform` | path | The node for the [matrix transform](#matrix-transform) to use |
+| Property | Type | Description |
+| ---------------------- | ---- | ---------------------------------------------------------------------- |
+| `zmk,kscan` | path | The node for the keyboard scan driver to use |
+| `zmk,matrix-transform` | path | The node for the [matrix transform](layout.md#matrix-transform) to use |
## Demux Driver
@@ -94,7 +94,7 @@ Assuming the switches connect each GPIO pin to the ground, the [GPIO flags](http
};
```
-A direct pin defined in the `input-gpios` property is considered a column when used in a [matrix transform](#matrix-transform); e.g. the 5th pin on the list can be referred to using `RC(0,4)`.
+A direct pin defined in the `input-gpios` property is considered a column when used in a [matrix transform](layout.md#matrix-transform); e.g. the 5th pin on the list can be referred to using `RC(0,4)`.
By default, a switch will drain current through the internal pull up/down resistor whenever it is pressed. This is not ideal for a toggle switch, where the switch may be left in the "pressed" state for a long time. Enabling `toggle-mode` will make the driver enable and disable the internal pull up/down resistor as needed when the switch is toggled to minimise power draw. For `toggle-mode` to work correctly each pole of the switch needs a dedicated GPIO pin.
@@ -200,7 +200,7 @@ Definition file: [zmk/app/module/dts/bindings/kscan/zmk,kscan-gpio-charlieplex.y
| `poll-period-ms` | int | Time between reads in milliseconds when no key is pressed and `interrupt-gpois` is not set. | 10 |
| `wakeup-source` | bool | Mark this kscan instance as able to wake the keyboard from deep sleep | n |
-Define the transform with a [matrix transform](#matrix-transform). The row is always the driven pin, and the column always the receiving pin (input to the controller).
+Define the transform with a [matrix transform](layout.md#matrix-transform). The row is always the driven pin, and the column always the receiving pin (input to the controller).
For example, in `RC(5,0)` power flows from the 6th pin in `gpios` to the 1st pin in `gpios`.
Exclude all positions where the row and column are the same as these pairs will never be triggered, since no pin can be both input and output at the same time.
diff --git a/docs/docs/development/hardware-integration/physical-layouts.md b/docs/docs/development/hardware-integration/physical-layouts.md
index 4dd58e8db4..7e36574c83 100644
--- a/docs/docs/development/hardware-integration/physical-layouts.md
+++ b/docs/docs/development/hardware-integration/physical-layouts.md
@@ -8,7 +8,7 @@ It contains:
- A [keyboard scan (kscan) driver](../../config/kscan.md)
- A [matrix transform](../../config/layout.md#matrix-transform)
-- (Optional) [Physical key positions](#physical-layout-positions)
+- (Optional) [Physical key positions](#optional-keys-property)
## Basic Physical Layout