summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPete Johanson <peter@peterjohanson.com>2020-08-19 21:02:03 -0400
committerGitHub <noreply@github.com>2020-08-19 21:02:03 -0400
commit3576738ab4b2645724750c6d7b089c1ec2e15bd6 (patch)
treef5a6bb02e918524ed1b6280119ab2d83514bc8e6 /docs
parentf2724ada383e4b65d5a1d03decee47e7c7c746f8 (diff)
parent02f541969cc74ec86fba3c3b01679f93fa86d698 (diff)
Merge pull request #103 from BrainWart/bond-clearing
feat(docs): create a bond clearing page
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/assets/bond-clearing/corne.jpgbin0 -> 147244 bytes
-rw-r--r--docs/docs/assets/bond-clearing/kyria.jpgbin0 -> 140236 bytes
-rw-r--r--docs/docs/bond-reset.md27
-rw-r--r--docs/sidebars.js2
4 files changed, 28 insertions, 1 deletions
diff --git a/docs/docs/assets/bond-clearing/corne.jpg b/docs/docs/assets/bond-clearing/corne.jpg
new file mode 100644
index 0000000..1e070a2
--- /dev/null
+++ b/docs/docs/assets/bond-clearing/corne.jpg
Binary files differ
diff --git a/docs/docs/assets/bond-clearing/kyria.jpg b/docs/docs/assets/bond-clearing/kyria.jpg
new file mode 100644
index 0000000..9fa22a0
--- /dev/null
+++ b/docs/docs/assets/bond-clearing/kyria.jpg
Binary files differ
diff --git a/docs/docs/bond-reset.md b/docs/docs/bond-reset.md
new file mode 100644
index 0000000..1d3732b
--- /dev/null
+++ b/docs/docs/bond-reset.md
@@ -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) \ No newline at end of file
diff --git a/docs/sidebars.js b/docs/sidebars.js
index be02a65..8c7c97f 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -1,6 +1,6 @@
module.exports = {
someSidebar: {
- "Getting Started": ["intro", "hardware", "faq", "user-setup"],
+ "Getting Started": ["intro", "hardware", "faq", "user-setup", "bond-reset"],
Features: [
"feature/keymaps",
"feature/displays",