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

feat(docs): Add caution note about split peripheral sides to user setup

Browse source
This commit is contained in:
Cem Aksoylar 2022-08-12 14:22:18 -07:00 • committed by Pete Johanson
parent 77d60182bf
commit 080c47825f
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/docs/user-setup.md
View file

@ -196,6 +196,14 @@ Once this happens, copy the correct UF2 file (e.g. left or right if working on a
storage device. Once the flash is complete, the controller should automatically restart, and load your newly flashed firmware. It is storage device. Once the flash is complete, the controller should automatically restart, and load your newly flashed firmware. It is
recommended that you test your keyboard works over USB first to rule out hardware issues, before trying to connect to it wirelessly. recommended that you test your keyboard works over USB first to rule out hardware issues, before trying to connect to it wirelessly.
:::caution Split keyboards
For split keyboards, only the central half (typically the left side) will send keyboard outputs over USB or advertise to other devices
over bluetooth. Peripheral half will only send keystrokes to the central once they are paired and connected. For this reason it is
recommended to test the left half of a split keyboard first.
:::
## Wirelessly Connecting Your Keyboard ## Wirelessly Connecting Your Keyboard
ZMK will automatically advertise itself as connectable if it is not currently connected to a device. You should be able to see your keyboard from the bluetooth scanning view of your computer or phone / tablet. It is reported by some users that the connections with Android / iOS devices are generally smoother than with laptops, so if you have trouble connecting, you could try to connect from your phone or tablet first to eliminate any potential hardware issues with bluetooth receivers. ZMK will automatically advertise itself as connectable if it is not currently connected to a device. You should be able to see your keyboard from the bluetooth scanning view of your computer or phone / tablet. It is reported by some users that the connections with Android / iOS devices are generally smoother than with laptops, so if you have trouble connecting, you could try to connect from your phone or tablet first to eliminate any potential hardware issues with bluetooth receivers.