summaryrefslogtreecommitdiff
path: root/docs/feature_bluetooth.md
diff options
context:
space:
mode:
authorCallum Oakley2017-08-19 10:34:45 +0100
committerCallum Oakley2017-08-19 10:34:45 +0100
commita6845036e25c4f4d936dcd12cd0ddedd2894b30e (patch)
treeb23b4e8d9d757aa3c0d42be561572533ae0d126c /docs/feature_bluetooth.md
parent84a8aabe5bf8807595f98de44d18f6a31b892edf (diff)
parent7277f09bbadcce120f819132dec8ff7172caacc4 (diff)
Merge branch 'master' of https://github.com/qmk/qmk_firmware
Diffstat (limited to 'docs/feature_bluetooth.md')
-rw-r--r--docs/feature_bluetooth.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/feature_bluetooth.md b/docs/feature_bluetooth.md
new file mode 100644
index 000000000..79a54208e
--- /dev/null
+++ b/docs/feature_bluetooth.md
@@ -0,0 +1,17 @@
+# Bluetooth
+
+## Bluetooth functionality
+
+This requires [some hardware changes](https://www.reddit.com/r/MechanicalKeyboards/comments/3psx0q/the_planck_keyboard_with_bluetooth_guide_and/?ref=search_posts), but can be enabled via the Makefile. The firmware will still output characters via USB, so be aware of this when charging via a computer. It would make sense to have a switch on the Bluefruit to turn it off at will.
+
+<!-- FIXME: Document bluetooth support more completely. -->
+
+## Bluetooth Keycodes
+
+This is used when multiple keyboard outputs can be selected. Currently this only allows for switching between USB and Bluetooth on keyboards that support both.
+
+|Name|Description|
+|----|-----------|
+|`OUT_AUTO`|auto mode|
+|`OUT_USB`|usb only|
+|`OUT_BT`|bluetooth|