diff options
Diffstat (limited to 'docs/feature_split_keyboard.md')
| -rw-r--r-- | docs/feature_split_keyboard.md | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md index 27df46a82..c8ba18bee 100644 --- a/docs/feature_split_keyboard.md +++ b/docs/feature_split_keyboard.md | |||
| @@ -219,47 +219,52 @@ One communication attempt will be allowed everytime this amount of time has pass | |||
| 219 | 219 | ||
| 220 | Set to 0 to disable this throttling of communications while disconnected. This can save you a couple of bytes of firmware size. | 220 | Set to 0 to disable this throttling of communications while disconnected. This can save you a couple of bytes of firmware size. |
| 221 | 221 | ||
| 222 | |||
| 223 | ### Data Sync Options | ||
| 224 | |||
| 225 | The following sync options add overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. These can be enabled by adding the chosen option(s) to your `config.h` file. | ||
| 226 | |||
| 222 | ```c | 227 | ```c |
| 223 | #define SPLIT_TRANSPORT_MIRROR | 228 | #define SPLIT_TRANSPORT_MIRROR |
| 224 | ``` | 229 | ``` |
| 225 | 230 | ||
| 226 | This mirrors the master side matrix to the slave side for features that react or require knowledge of master side key presses on the slave side. The purpose of this feature is to support cosmetic use of key events (e.g. RGB reacting to keypresses). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. | 231 | This mirrors the master side matrix to the slave side for features that react or require knowledge of master side key presses on the slave side. The purpose of this feature is to support cosmetic use of key events (e.g. RGB reacting to keypresses). |
| 227 | 232 | ||
| 228 | ```c | 233 | ```c |
| 229 | #define SPLIT_LAYER_STATE_ENABLE | 234 | #define SPLIT_LAYER_STATE_ENABLE |
| 230 | ``` | 235 | ``` |
| 231 | 236 | ||
| 232 | This enables syncing of the layer state between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the currently active layer. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. | 237 | This enables syncing of the layer state between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the currently active layer. |
| 233 | 238 | ||
| 234 | ```c | 239 | ```c |
| 235 | #define SPLIT_LED_STATE_ENABLE | 240 | #define SPLIT_LED_STATE_ENABLE |
| 236 | ``` | 241 | ``` |
| 237 | 242 | ||
| 238 | This enables syncing of the Host LED status (caps lock, num lock, etc) between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the Host LED status. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. | 243 | This enables syncing of the Host LED status (caps lock, num lock, etc) between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the Host LED status. |
| 239 | 244 | ||
| 240 | ```c | 245 | ```c |
| 241 | #define SPLIT_MODS_ENABLE | 246 | #define SPLIT_MODS_ENABLE |
| 242 | ``` | 247 | ``` |
| 243 | 248 | ||
| 244 | This enables transmitting modifier state (normal, weak and oneshot) to the non primary side of the split keyboard. The purpose of this feature is to support cosmetic use of modifer state (e.g. displaying status on an OLED screen). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. | 249 | This enables transmitting modifier state (normal, weak and oneshot) to the non primary side of the split keyboard. The purpose of this feature is to support cosmetic use of modifer state (e.g. displaying status on an OLED screen). |
| 245 | 250 | ||
| 246 | ```c | 251 | ```c |
| 247 | #define SPLIT_WPM_ENABLE | 252 | #define SPLIT_WPM_ENABLE |
| 248 | ``` | 253 | ``` |
| 249 | 254 | ||
| 250 | This enables transmitting the current WPM to the slave side of the split keyboard. The purpose of this feature is to support cosmetic use of WPM (e.g. displaying the current value on an OLED screen). This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. | 255 | This enables transmitting the current WPM to the slave side of the split keyboard. The purpose of this feature is to support cosmetic use of WPM (e.g. displaying the current value on an OLED screen). |
| 251 | 256 | ||
| 252 | ```c | 257 | ```c |
| 253 | #define SPLIT_OLED_ENABLE | 258 | #define SPLIT_OLED_ENABLE |
| 254 | ``` | 259 | ``` |
| 255 | 260 | ||
| 256 | This enables transmitting the current OLED on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. | 261 | This enables transmitting the current OLED on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing. |
| 257 | 262 | ||
| 258 | ```c | 263 | ```c |
| 259 | #define SPLIT_ST7565_ENABLE | 264 | #define SPLIT_ST7565_ENABLE |
| 260 | ``` | 265 | ``` |
| 261 | 266 | ||
| 262 | This enables transmitting the current ST7565 on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing. This adds overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. | 267 | This enables transmitting the current ST7565 on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing. |
| 263 | 268 | ||
| 264 | ### Custom data sync between sides :id=custom-data-sync | 269 | ### Custom data sync between sides :id=custom-data-sync |
| 265 | 270 | ||