Skip to content

Commit 9e88c12

Browse files
committed
Docs: Update flow control
1 parent 141e508 commit 9e88c12

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

docs/at_commands.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,9 @@ A table of the subset of the common Radio Link Parameters is available [here](im
169169

170170
* **Echo** - By default, the radio will not echo the incoming serial. This is helpful at times if a user is typing data directly into a terminal. During AT configuration echo is turned on regardless of this setting.
171171

172-
* **FlowControl** - If flow control is enabled, the radio will not print data if CTS is low (the host is telling the radio to hold its horses). If flow control is enabled, the radio will pull RTS low if its serial buffer is full (the radio is telling the host to hold its horses). CTS and RTS pins are only exposed on the UART connector but apply to both USB and serial data streams. By default, flow control is turned off. Internal pull-ups are used so RTS and CTS can be left floating if not used.
172+
![Flow control on the SAMD21](img/SAMD21%20Flow%20control.png)
173+
174+
* **FlowControl** - If flow control is enabled, LoRaSerial will send data when its CTS pin is driven low (the host system is telling the radio to transmit). If flow control is enabled, LoRaSerial will drive its RTS low if its serial buffer is full (the radio is telling the host system to hold its horses). CTS and RTS pins are only exposed on the UART connector but if flow control is enabled, the UART flow control pins will apply to both USB and serial data streams. Internal pull-ups are used so if flow control is enabled, RTS and CTS must not be left floating. By default, flow control is turned off.
173175

174176
* **InvertCts** - By default, InvertCts is false and CTS is high when data is allowed to flow. Enable InvertCts to do the opposite.
175177

docs/hardware_overview.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,13 @@ The pinout is as follows:
5353

5454
#### Flow Control
5555

56-
Hardware flow control applies to both the UART connection and the USB connector but in slightly different ways.
56+
![Flow control on the SAMD21](img/SAMD21%20Flow%20control.png)
5757

58-
If Flow Control is enabled, the UART will use standard CTS and RTS pins to control the flow. If LoRaSerial is running low on serial buffer space, and Flow Control is enabled, it will pull RTS low to indicate to the host to refrain from sending data to LoRaSerial.
58+
If flow control is enabled, LoRaSerial will send data when its CTS pin is driven low (the host system is telling the radio to transmit). If flow control is enabled, LoRaSerial will drive its RTS low if its serial buffer is full (the radio is telling the host system to hold its horses). CTS and RTS pins are only exposed on the UART connector but if flow control is enabled, the UART flow control pins will apply to both USB and serial data streams. Internal pull-ups are used so if flow control is enabled, RTS and CTS must not be left floating. By default, flow control is turned off.
5959

60-
The USB connection uses a concept called backpressure. It is not affected by the [FlowControl setting](http://docs.sparkfun.com/SparkFun_LoRaSerial/at_commands/#serial-commands) and cannot be disabled. If LoRaSerial is not able to read the incoming data fast enough, the USB driver will indicate to the host’s operating system that the data has not been consumed. Depending on the application, data will either be paused or lost.
60+
Hardware flow control applies to both the UART connection and the USB connector but in slightly different ways.
6161

62+
The USB connection uses a concept called backpressure. It is not affected by the [FlowControl setting](http://docs.sparkfun.com/SparkFun_LoRaSerial/at_commands/#serial-commands) and cannot be disabled. If LoRaSerial is not able to read the incoming data fast enough, the USB driver will indicate to the host’s operating system that the data has not been consumed. Depending on the application, data will either be paused or lost.
6263

6364
![STRSVR Buffering Serial Data](img/RTKLIB%20STRSVR%20Buffering%20Data.png)
6465

docs/img/SAMD21 Flow control.png

13.2 KB
Loading

0 commit comments

Comments
 (0)