aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_split_keyboard.md16
-rw-r--r--docs/serial_driver.md6
2 files changed, 19 insertions, 3 deletions
diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md
index a84d38460..27df46a82 100644
--- a/docs/feature_split_keyboard.md
+++ b/docs/feature_split_keyboard.md
@@ -204,6 +204,22 @@ If you're having issues with serial communication, you can change this value, as
204This sets the maximum number of milliseconds before forcing a synchronization of data from master to slave. Under normal circumstances this sync occurs whenever the data _changes_, for safety a data transfer occurs after this number of milliseconds if no change has been detected since the last sync. 204This sets the maximum number of milliseconds before forcing a synchronization of data from master to slave. Under normal circumstances this sync occurs whenever the data _changes_, for safety a data transfer occurs after this number of milliseconds if no change has been detected since the last sync.
205 205
206```c 206```c
207#define SPLIT_MAX_CONNECTION_ERRORS 10
208```
209This sets the maximum number of failed communication attempts (one per scan cycle) from the master part before it assumes that no slave part is connected. This makes it possible to use a master part without the slave part connected.
210
211Set to 0 to disable the disconnection check altogether.
212
213```c
214#define SPLIT_CONNECTION_CHECK_TIMEOUT 500
215```
216How long (in milliseconds) the master part should block all connection attempts to the slave after the communication has been flagged as disconnected (see `SPLIT_MAX_CONNECTION_ERRORS` above).
217
218One communication attempt will be allowed everytime this amount of time has passed since the last attempt. If that attempt succeeds, the communication is seen as working again.
219
220Set to 0 to disable this throttling of communications while disconnected. This can save you a couple of bytes of firmware size.
221
222```c
207#define SPLIT_TRANSPORT_MIRROR 223#define SPLIT_TRANSPORT_MIRROR
208``` 224```
209 225
diff --git a/docs/serial_driver.md b/docs/serial_driver.md
index ed989b0a1..3e89deffa 100644
--- a/docs/serial_driver.md
+++ b/docs/serial_driver.md
@@ -63,7 +63,7 @@ Configure the hardware via your config.h:
63 // 5: about 19200 baud 63 // 5: about 19200 baud
64#define SERIAL_USART_DRIVER SD1 // USART driver of TX pin. default: SD1 64#define SERIAL_USART_DRIVER SD1 // USART driver of TX pin. default: SD1
65#define SERIAL_USART_TX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7 65#define SERIAL_USART_TX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7
66#define SERIAL_USART_TIMEOUT 100 // USART driver timeout. default 100 66#define SERIAL_USART_TIMEOUT 20 // USART driver timeout. default 20
67``` 67```
68 68
69You must also enable the ChibiOS `SERIAL` feature: 69You must also enable the ChibiOS `SERIAL` feature:
@@ -105,10 +105,10 @@ Next configure the hardware via your config.h:
105 // 3: 57600 baud 105 // 3: 57600 baud
106 // 4: 38400 baud 106 // 4: 38400 baud
107 // 5: 19200 baud 107 // 5: 19200 baud
108#define SERIAL_USART_DRIVER SD1 // USART driver of TX and RX pin. default: SD1 108#define SERIAL_USART_DRIVER SD1 // USART driver of TX and RX pin. default: SD1
109#define SERIAL_USART_TX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7 109#define SERIAL_USART_TX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7
110#define SERIAL_USART_RX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7 110#define SERIAL_USART_RX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7
111#define SERIAL_USART_TIMEOUT 100 // USART driver timeout. default 100 111#define SERIAL_USART_TIMEOUT 20 // USART driver timeout. default 20
112``` 112```
113 113
114You must also enable the ChibiOS `SERIAL` feature: 114You must also enable the ChibiOS `SERIAL` feature: