From 3c48785c17caffa797256c9538153a9c266de71f Mon Sep 17 00:00:00 2001 From: zvecr Date: Fri, 26 Jul 2019 01:48:03 +0100 Subject: [PATCH] Add split USB detect docs --- docs/config_options.md | 8 ++++++++ docs/feature_split_keyboard.md | 10 ++++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/config_options.md b/docs/config_options.md index 01c0e3ee8ca3..1cfe916059e1 100644 --- 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 index 95aceab22386..41e229c7a7d2 100644 --- 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.