Merge pull request #103 from BrainWart/bond-clearing

feat(docs): create a bond clearing page
This commit is contained in:
Pete Johanson 2020-08-19 21:02:03 -04:00 committed by GitHub
commit 3576738ab4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 28 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

27
docs/docs/bond-reset.md Normal file
View file

@ -0,0 +1,27 @@
---
id: bond-reset
title: Reset BLE Connections
sidebar_label: BLE Reset
---
Known as a 'bond reset', a special key combination, that is not related to the user defined key map, which
clears all wireless connection configurations. The keys must be held for 3 to 5 seconds after the device is
reset.
:::warning
Currently, ZMK only supports a single BLE host. If you remove the keyboard from the host's bluetooth devices
list, you will need to clear the bonds.
:::
### Split Keyboards
Split keyboards will need to be cleared on both halves. For best results try to reset them at the same time.
## Kyria
![Kyria bond-reset combo](assets/bond-clearing/kyria.jpg)
## Corne
![Corne bond-reset combo](assets/bond-clearing/corne.jpg)

View file

@ -1,6 +1,6 @@
module.exports = { module.exports = {
someSidebar: { someSidebar: {
"Getting Started": ["intro", "hardware", "faq", "user-setup"], "Getting Started": ["intro", "hardware", "faq", "user-setup", "bond-reset"],
Features: [ Features: [
"feature/keymaps", "feature/keymaps",
"feature/displays", "feature/displays",