Add split USB detect docs

qmk · Jul 26, 2019 · 3c48785 · 3c48785
1 parent d676815
commit 3c48785
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/config_options.md b/docs/config_options.md
@@ -261,6 +261,14 @@ There are a few different ways to set handedness for split keyboards (listed in
     * 4: about 26kbps
     * 5: about 20kbps
 
+* `#define SPLIT_USB_DETECT`
+  * Detect (with timeout) USB connection when delegating master/slave
+  * Default behavior for ARM
+  * Required for AVR Teensy
+
+* `#define SPLIT_USB_TIMEOUT 2500`
+  * Maximum timeout when detecting master/slave when using `SPLIT_USB_DETECT`
+
 # The `rules.mk` File
 
 This is a [make](https://www.gnu.org/software/make/manual/make.html) file that is included by the top-level `Makefile`. It is used to set some information about the MCU that we will be compiling for as well as enabling and disabling certain features.

diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md
@@ -176,6 +176,16 @@ This sets how many LEDs are directly connected to each controller.  The first nu
 ?> This setting implies that `RGBLIGHT_SPLIT` is enabled, and will forcibly enable it, if it's not.
 
 
+```c
+#define SPLIT_USB_DETECT
+```
+This option changes the startup behavior to detect a USB connection with a timeout when delegating master/slave. This is the default behavior for ARM, and required for AVR Teensy (due to hardware limitations).
+
+```c
+#define SPLIT_USB_TIMEOUT 2500
+```
+This sets the maximum timeout when detecting master/slave when using `SPLIT_USB_DETECT`.
+
 ## Additional Resources
 
 Nicinabox has a [very nice and detailed guide](https://github.com/nicinabox/lets-split-guide) for the Let's Split keyboard, that covers most everything you need to know, including troubleshooting information.