diff options
Diffstat (limited to 'docs/config_options.md')
-rw-r--r-- | docs/config_options.md | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index 26fe8cea5..980195ac6 100644 --- a/docs/config_options.md +++ b/docs/config_options.md | |||
@@ -274,7 +274,7 @@ There are a few different ways to set handedness for split keyboards (listed in | |||
274 | ### Other Options | 274 | ### Other Options |
275 | 275 | ||
276 | * `#define USE_I2C` | 276 | * `#define USE_I2C` |
277 | * For using I2C instead of Serial (defaults to serial) | 277 | * For using I2C instead of Serial (default is serial; serial transport is supported on ARM -- I2C is AVR-only) |
278 | 278 | ||
279 | * `#define SOFT_SERIAL_PIN D0` | 279 | * `#define SOFT_SERIAL_PIN D0` |
280 | * When using serial, define this. `D0` or `D1`,`D2`,`D3`,`E6`. | 280 | * When using serial, define this. `D0` or `D1`,`D2`,`D3`,`E6`. |
@@ -303,7 +303,7 @@ There are a few different ways to set handedness for split keyboards (listed in | |||
303 | * `#define SPLIT_USB_DETECT` | 303 | * `#define SPLIT_USB_DETECT` |
304 | * Detect (with timeout) USB connection when delegating master/slave | 304 | * Detect (with timeout) USB connection when delegating master/slave |
305 | * Default behavior for ARM | 305 | * Default behavior for ARM |
306 | * Required for AVR Teensy | 306 | * Required for AVR Teensy (without hardware mods) |
307 | 307 | ||
308 | * `#define SPLIT_USB_TIMEOUT 2000` | 308 | * `#define SPLIT_USB_TIMEOUT 2000` |
309 | * Maximum timeout when detecting master/slave when using `SPLIT_USB_DETECT` | 309 | * Maximum timeout when detecting master/slave when using `SPLIT_USB_DETECT` |
@@ -311,6 +311,28 @@ There are a few different ways to set handedness for split keyboards (listed in | |||
311 | * `#define SPLIT_USB_TIMEOUT_POLL 10` | 311 | * `#define SPLIT_USB_TIMEOUT_POLL 10` |
312 | * Poll frequency when detecting master/slave when using `SPLIT_USB_DETECT` | 312 | * Poll frequency when detecting master/slave when using `SPLIT_USB_DETECT` |
313 | 313 | ||
314 | * `#define FORCED_SYNC_THROTTLE_MS 100` | ||
315 | * Deadline for synchronizing data from master to slave when using the QMK-provided split transport. | ||
316 | |||
317 | * `#define SPLIT_TRANSPORT_MIRROR` | ||
318 | * Mirrors the master-side matrix on the slave when using the QMK-provided split transport. | ||
319 | |||
320 | * `#define SPLIT_LAYER_STATE_ENABLE` | ||
321 | * Ensures the current layer state is available on the slave when using the QMK-provided split transport. | ||
322 | |||
323 | * `#define SPLIT_LED_STATE_ENABLE` | ||
324 | * Ensures the current host indicator state (caps/num/scroll) is available on the slave when using the QMK-provided split transport. | ||
325 | |||
326 | * `#define SPLIT_MODS_ENABLE` | ||
327 | * Ensures the current modifier state (normal, weak, and oneshot) is available on the slave when using the QMK-provided split transport. | ||
328 | |||
329 | * `#define SPLIT_WPM_ENABLE` | ||
330 | * Ensures the current WPM is available on the slave when using the QMK-provided split transport. | ||
331 | |||
332 | * `#define SPLIT_TRANSACTION_IDS_KB .....` | ||
333 | * `#define SPLIT_TRANSACTION_IDS_USER .....` | ||
334 | * Allows for custom data sync with the slave when using the QMK-provided split transport. See [custom data sync between sides](feature_split_keyboard.md#custom-data-sync) for more information. | ||
335 | |||
314 | # The `rules.mk` File | 336 | # The `rules.mk` File |
315 | 337 | ||
316 | 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. | 338 | 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. |