diff options
Diffstat (limited to 'docs/config_options.md')
-rw-r--r-- | docs/config_options.md | 29 |
1 files changed, 27 insertions, 2 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index d0f0b316e..980195ac6 100644 --- a/docs/config_options.md +++ b/docs/config_options.md | |||
@@ -51,8 +51,10 @@ This is a C header file that is one of the first things included, and will persi | |||
51 | * the number of columns in your keyboard's matrix | 51 | * the number of columns in your keyboard's matrix |
52 | * `#define MATRIX_ROW_PINS { D0, D5, B5, B6 }` | 52 | * `#define MATRIX_ROW_PINS { D0, D5, B5, B6 }` |
53 | * pins of the rows, from top to bottom | 53 | * pins of the rows, from top to bottom |
54 | * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md?id=low-level-matrix-overrides) for more information. | ||
54 | * `#define MATRIX_COL_PINS { F1, F0, B0, C7, F4, F5, F6, F7, D4, D6, B4, D7 }` | 55 | * `#define MATRIX_COL_PINS { F1, F0, B0, C7, F4, F5, F6, F7, D4, D6, B4, D7 }` |
55 | * pins of the columns, from left to right | 56 | * pins of the columns, from left to right |
57 | * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md?id=low-level-matrix-overrides) for more information. | ||
56 | * `#define MATRIX_IO_DELAY 30` | 58 | * `#define MATRIX_IO_DELAY 30` |
57 | * the delay in microseconds when between changing matrix pin state and reading values | 59 | * the delay in microseconds when between changing matrix pin state and reading values |
58 | * `#define UNUSED_PINS { D1, D2, D3, B1, B2, B3 }` | 60 | * `#define UNUSED_PINS { D1, D2, D3, B1, B2, B3 }` |
@@ -272,7 +274,7 @@ There are a few different ways to set handedness for split keyboards (listed in | |||
272 | ### Other Options | 274 | ### Other Options |
273 | 275 | ||
274 | * `#define USE_I2C` | 276 | * `#define USE_I2C` |
275 | * 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) |
276 | 278 | ||
277 | * `#define SOFT_SERIAL_PIN D0` | 279 | * `#define SOFT_SERIAL_PIN D0` |
278 | * When using serial, define this. `D0` or `D1`,`D2`,`D3`,`E6`. | 280 | * When using serial, define this. `D0` or `D1`,`D2`,`D3`,`E6`. |
@@ -280,6 +282,7 @@ There are a few different ways to set handedness for split keyboards (listed in | |||
280 | * `#define MATRIX_ROW_PINS_RIGHT { <row pins> }` | 282 | * `#define MATRIX_ROW_PINS_RIGHT { <row pins> }` |
281 | * `#define MATRIX_COL_PINS_RIGHT { <col pins> }` | 283 | * `#define MATRIX_COL_PINS_RIGHT { <col pins> }` |
282 | * If you want to specify a different pinout for the right half than the left half, you can define `MATRIX_ROW_PINS_RIGHT`/`MATRIX_COL_PINS_RIGHT`. Currently, the size of `MATRIX_ROW_PINS` must be the same as `MATRIX_ROW_PINS_RIGHT` and likewise for the definition of columns. | 284 | * If you want to specify a different pinout for the right half than the left half, you can define `MATRIX_ROW_PINS_RIGHT`/`MATRIX_COL_PINS_RIGHT`. Currently, the size of `MATRIX_ROW_PINS` must be the same as `MATRIX_ROW_PINS_RIGHT` and likewise for the definition of columns. |
285 | * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md?id=low-level-matrix-overrides) for more information. | ||
283 | 286 | ||
284 | * `#define DIRECT_PINS_RIGHT { { F1, F0, B0, C7 }, { F4, F5, F6, F7 } }` | 287 | * `#define DIRECT_PINS_RIGHT { { F1, F0, B0, C7 }, { F4, F5, F6, F7 } }` |
285 | * If you want to specify a different direct pinout for the right half than the left half, you can define `DIRECT_PINS_RIGHT`. Currently, the size of `DIRECT_PINS` must be the same as `DIRECT_PINS_RIGHT`. | 288 | * If you want to specify a different direct pinout for the right half than the left half, you can define `DIRECT_PINS_RIGHT`. Currently, the size of `DIRECT_PINS` must be the same as `DIRECT_PINS_RIGHT`. |
@@ -300,7 +303,7 @@ There are a few different ways to set handedness for split keyboards (listed in | |||
300 | * `#define SPLIT_USB_DETECT` | 303 | * `#define SPLIT_USB_DETECT` |
301 | * Detect (with timeout) USB connection when delegating master/slave | 304 | * Detect (with timeout) USB connection when delegating master/slave |
302 | * Default behavior for ARM | 305 | * Default behavior for ARM |
303 | * Required for AVR Teensy | 306 | * Required for AVR Teensy (without hardware mods) |
304 | 307 | ||
305 | * `#define SPLIT_USB_TIMEOUT 2000` | 308 | * `#define SPLIT_USB_TIMEOUT 2000` |
306 | * Maximum timeout when detecting master/slave when using `SPLIT_USB_DETECT` | 309 | * Maximum timeout when detecting master/slave when using `SPLIT_USB_DETECT` |
@@ -308,6 +311,28 @@ There are a few different ways to set handedness for split keyboards (listed in | |||
308 | * `#define SPLIT_USB_TIMEOUT_POLL 10` | 311 | * `#define SPLIT_USB_TIMEOUT_POLL 10` |
309 | * Poll frequency when detecting master/slave when using `SPLIT_USB_DETECT` | 312 | * Poll frequency when detecting master/slave when using `SPLIT_USB_DETECT` |
310 | 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 | |||
311 | # The `rules.mk` File | 336 | # The `rules.mk` File |
312 | 337 | ||
313 | 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. |