diff --git a/docs/docs/development/hardware-integration/dongle.mdx b/docs/docs/development/hardware-integration/dongle.mdx index 603eb4d55..765dbeb04 100644 --- a/docs/docs/development/hardware-integration/dongle.mdx +++ b/docs/docs/development/hardware-integration/dongle.mdx @@ -146,6 +146,7 @@ If your keyboard is not Studio-ready or you have no interest in using ZMK Studio diff --git a/docs/docs/development/hardware-integration/new-shield.mdx b/docs/docs/development/hardware-integration/new-shield.mdx index 59a049ccc..1e6bef2a8 100644 --- a/docs/docs/development/hardware-integration/new-shield.mdx +++ b/docs/docs/development/hardware-integration/new-shield.mdx @@ -10,6 +10,7 @@ import Metadata from "@site/src/data/hardware-metadata.json"; export const SplitTabs = (props) => ( ( export const SplitInvisTabs = (props) => ( + If you are not planning to add support for [ZMK Studio](../../features/studio.md), you can add a `zmk,physical-layout`-compatible node for each physical layout your keyboard supports: diff --git a/docs/docs/development/hardware-integration/pinctrl.mdx b/docs/docs/development/hardware-integration/pinctrl.mdx index 0f06ae589..62ad9f185 100644 --- a/docs/docs/development/hardware-integration/pinctrl.mdx +++ b/docs/docs/development/hardware-integration/pinctrl.mdx @@ -110,10 +110,12 @@ All of your configuration will happen by adjusting the `pinctrl` node. Changes a Within said node, you will configure one or more child nodes for the buses. You will want to define the child nodes according to the instructions in the `pinctrl.yaml` file. The child nodes that you define should be named appropriately. The common naming schema is `usageNumber_state`. For example, `uart0_default`. -Child nodes are (generally, there are[exceptions](https://docs.zephyrproject.org/3.5.0/hardware/pinctrl/index.html#pin-configuration)) expected to contain one or more subnodes typically named "groupX". These are for grouping together pins that should be assigned the same state, such as enabling an internal pull-up. +Child nodes are (generally, there are [exceptions](https://docs.zephyrproject.org/3.5.0/hardware/pinctrl/index.html#pin-configuration)) expected to contain one or more subnodes typically named "groupX". These are for grouping together pins that should be assigned the same state, such as enabling an internal pull-up. Below are some examples of SPI child nodes for the nRF52840 and the RP2040. Further examples are contained within the comments of the respecting `pinctrl.yaml` files. ( + The exact method of reusing a key switch to wake from the soft off state differs depending on whether said key switch is part of a direct GPIO kscan or part of a matrix kscan. - + @@ -34,7 +34,7 @@ Advanced methods of adding [soft off](../../features/low-power-states.md#soft-of ## Hardware Changes - + Add a direct push button between a GPIO pin and ground. This button will act as an on/off switch. @@ -57,7 +57,7 @@ Advanced methods of adding [soft off](../../features/low-power-states.md#soft-of Several items work together to make both triggering soft off properly, and setting up the device to _wake_ from soft off work as expected. - + @@ -78,7 +78,12 @@ For this approach, you will need to make sure that the [soft off behavior](../.. Zephyr's basic [GPIO Key](https://docs.zephyrproject.org/3.5.0/build/dts/api/bindings/input/gpio-keys.html) concept is used to configure the soft off GPIO pin. {/* secrettabs hides this tab selector. GPIO key changes its "orientation" between simple pin and matrix integrated. */} - + @@ -94,7 +99,12 @@ GPIO keys are defined using child nodes under the `gpio-keys` compatible node. E - The `gpios` property should be a [phandle-array](https://docs.zephyrproject.org/3.5.0/build/dts/phandles.html#zero-or-more-nodes-with-metadata-phandle-array-type) with a fully defined GPIO pin and with the correct pull up/down and active high/low flags set. - + @@ -102,7 +112,12 @@ GPIO keys are defined using child nodes under the `gpio-keys` compatible node. E - + @@ -111,7 +126,7 @@ GPIO keys are defined using child nodes under the `gpio-keys` compatible node. E - + You also need to update the `zmk,kscan` chosen value to point to the new kscan instance: @@ -130,7 +145,7 @@ GPIO keys are defined using child nodes under the `gpio-keys` compatible node. E - + diff --git a/docs/docs/development/local-toolchain/build-flash.mdx b/docs/docs/development/local-toolchain/build-flash.mdx index c7a09d050..7b86a618d 100644 --- a/docs/docs/development/local-toolchain/build-flash.mdx +++ b/docs/docs/development/local-toolchain/build-flash.mdx @@ -25,7 +25,7 @@ Building a particular keyboard is done using the command. Its usage slightly changes depending on if your build is for a keyboard with an onboard MCU or one that uses an MCU board add-on. - ( ( export const OsNoteTabs = (props) => ( ( export const EnvTabs = (props) => ( ( export const WinTermTabs = (props) => ( - + 1. Use `apt` to install Python `venv` package: @@ -201,7 +205,7 @@ pip install -r zephyr/scripts/requirements-base.txt - + 1. Install `west`: @@ -282,7 +286,7 @@ This step pulls down quite a bit of tooling, be patient! west zephyr-export ``` - + 4. Install the additional dependencies found in Zephyr's `requirements-base.txt`: diff --git a/docs/docs/development/usb-logging.mdx b/docs/docs/development/usb-logging.mdx index b7c3d2338..4a9cdba34 100644 --- a/docs/docs/development/usb-logging.mdx +++ b/docs/docs/development/usb-logging.mdx @@ -50,6 +50,7 @@ boot, before you can connect to view the logs. After flashing the updated ZMK image, the board should expose a USB CDC ACM device that you can connect to and view the logs. ( ( export const PinTabs = (props) => ( diff --git a/docs/src/components/interconnect-tabs.tsx b/docs/src/components/interconnect-tabs.tsx index b18c4491f..cfe764b3d 100644 --- a/docs/src/components/interconnect-tabs.tsx +++ b/docs/src/components/interconnect-tabs.tsx @@ -59,7 +59,11 @@ function InterconnectTabs({ items, gpio }: InterconnectTabsProps) { .sort((a, b) => a.id.localeCompare(b.id)); return ( - + {grouped.map((items) => mapInterconnect(items, gpio))} );