From 877d654f0dafafb4397b8ba47e4f6e9867320796 Mon Sep 17 00:00:00 2001 From: rasmuskoit Date: Sun, 4 Aug 2024 12:21:57 +0300 Subject: [PATCH] adds clarifing comments about microcontrollers setup adds a nice picture --- docs/docs/assets/splits/mermaid-connection.svg | 1 + docs/docs/features/splits.mdx | 8 ++++++++ 2 files changed, 9 insertions(+) create mode 100644 docs/docs/assets/splits/mermaid-connection.svg diff --git a/docs/docs/assets/splits/mermaid-connection.svg b/docs/docs/assets/splits/mermaid-connection.svg new file mode 100644 index 00000000..877ddb64 --- /dev/null +++ b/docs/docs/assets/splits/mermaid-connection.svg @@ -0,0 +1 @@ +
USB/BLE
BLE
BLE
Computer/Host Device
Dongle/Central
Left Half/Peripheral
Right Half/Peripheral
 \ No newline at end of file diff --git a/docs/docs/features/splits.mdx b/docs/docs/features/splits.mdx index 12bb7dcd..a4bc68cc 100644 --- a/docs/docs/features/splits.mdx +++ b/docs/docs/features/splits.mdx @@ -11,10 +11,16 @@ Using this setup does have one drawback: the central half of the keyboard usuall This is because the central half is responsible for maintaining the connection with the peripheral half and the host device. To solve this problem, a third microcontroller can be used as the new central or as more widely known a dongle. +For example, if you are using nice!nano v2 as your keyboard halves, you can use any other microcontroller as the dongle. +Meaning that the dongle does not have to be the same microcontroller as the keyboard halves, but it can be. + The dongle will act as a central device and communicate with the keyboard halves which will both act as peripherals. Dongles are usually connected to the host device using USB. This way the central half of the keyboard can be powered by the host device, and the peripheral halves can be powered by their own batteries. This setup allows both halves of the keyboard to have a longer battery life. + +![Mermaid Connection](../assets/splits/mermaid-connection.svg) + {/* Here is an example diagram of a split keyboard with a dongle: ```mermaid @@ -140,6 +146,8 @@ In most common cases the dongle will not have any keys, in that case we can inst After writing the configuration files, you can modify the `build.yml` file to include the dongle configuration. +Please keep in mind that the dongle does not have to be the same microcontroller as the keyboard halves. + ```yaml --- include: