kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

adds clarifing comments about microcontrollers setup

Browse source 
adds a nice picture
This commit is contained in:
rasmuskoit 2024-08-04 12:21:57 +03:00
parent 6e622eba37
commit 877d654f0d
No known key found for this signature in database
GPG key ID: 99709B876A0CD268
2 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/docs/assets/splits/mermaid-connection.svg Normal file
View file

File diff suppressed because one or more lines are too long
Side by side

After

Width:  |  Height:  |  Size: 9.3 KiB

8
docs/docs/features/splits.mdx
View file

@ -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: