You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/docs/development/hardware-integration/dongle.mdx
+4-3
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ sidebar_label: Keyboard Dongle
6
6
importTabsfrom"@theme/Tabs";
7
7
importTabItemfrom"@theme/TabItem";
8
8
9
-
A bluetooth dongle can be added to any keyboard running ZMK. The result is a [split keyboard](../../features/split-keyboards.md) with the dongle as ["central"](../../features/split-keyboards.md#central-and-peripheral-roles). There are a number of advantages to adding a dongle, but also some disadvantages:
9
+
A bluetooth dongle can be added to any wireless keyboard running ZMK. The result is a [split keyboard](../../features/split-keyboards.md) with the dongle as ["central"](../../features/split-keyboards.md#central-and-peripheral-roles). There are a number of advantages to adding a dongle, but also some disadvantages:
10
10
11
11
Benefits:
12
12
@@ -15,7 +15,7 @@ Benefits:
15
15
16
16
Disadvantages:
17
17
18
-
- An extra [board](../../faq.md#what-is-a-board) is needed (any BLE-capable board will work).
18
+
- An extra [board](../../faq.md#what-is-a-board) is needed (any BLE-capable board that ZMK supports will work).
19
19
- The keyboard becomes unusable without the dongle.
20
20
21
21
Depending on how the dongle is used, there are some additional [latency considerations](../../features/split-keyboards.md#latency-considerations) to keep in mind.
@@ -283,7 +283,7 @@ Make sure that the `transform` property uses the same label as your matrix trans
283
283
Before flashing your new firmware, you need to flash `settings_reset`[firmware](../../troubleshooting/connection-issues.mdx#acquiring-a-reset-uf2) on all devices to ensure they can pair to each other.
284
284
:::
285
285
286
-
Add the appropriate lines to your `build.yml` file to build the firmware for your dongle. Also add some CMake arguments using `cmake-args` to the existing parts of your keyboard, turning them into peripherals for your dongle.
286
+
Add the appropriate lines to your `build.yml` file to build the firmware for your dongle. Also add some CMake arguments using `cmake-args` to the existing parts of your keyboard, turning them into peripherals for your dongle.[^2]
287
287
288
288
```yaml
289
289
include:
@@ -306,3 +306,4 @@ To use your dongled keyboard with [ZMK Studio](../../features/studio.md), apply
306
306
If you ever want to "undongle" your keyboard, simply remove these CMake arguments and flash the resulting firmware (after a `settings_reset`).
307
307
308
308
[^1]: If you have a custom dongle that uses an onboard MCU, then you will need to take a slightly different approach that isn't currently documented.
309
+
[^2]: If you are building locally, you can append these flags to the end of the [build command](../local-toolchain/build-flash.mdx#cmake-arguments).
0 commit comments