Skip to content

Commit

Permalink
chore(doc): one sentence per line
Browse files Browse the repository at this point in the history
  • Loading branch information
rfdonnelly committed Aug 15, 2024
1 parent 09b10e1 commit fd3e77c
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Vsp-router was created to connect two terminal emulators to the same physical RS
* macOS: Yes, tested on macOS Ventura 13.1
* Windows: Yes*, tested on Windows 10

*The Windows version does not support creation of virtual serial ports. A third-party tool like [com0com](https://com0com.sourceforge.net) can be used instead.
*The Windows version does not support creation of virtual serial ports.
A third-party tool like [com0com](https://com0com.sourceforge.net) can be used instead.

## Use Cases

Expand Down Expand Up @@ -85,10 +86,15 @@ Characters entered in terminal 2 will be sent to both terminals 0 and 1.
## Connection to a Virtual Serial Port

Virtual serial ports created by vsp-router behave a bit differently from physical serial ports:
* You can connect to them using any baud rate. You are not forced to use the same baud rate as the physical serial port you are multiplexing.
* When you don't read from them they accumulate data in a buffer. When this buffer becomes full new data will be discarded and a warning message will be shown in the logs. Any buffered data will get returned when you next read from them.

To avoid reading stale data accumulated in the buffer when you want to read from the virtual serial port it is recommended to flush its input buffer before you first read from it. This can be done using `tcflush(fd, TCIFLUSH)` (or equivalent on your platform) on the file descriptor of the virtual serial port.
* You can connect to them using any baud rate.
You are not forced to use the same baud rate as the physical serial port you are multiplexing.
* When you don't read from them they accumulate data in a buffer.
When this buffer becomes full new data will be discarded and a warning message will be shown in the logs.
Any buffered data will get returned when you next read from them.

To avoid reading stale data accumulated in the buffer when you want to read from the virtual serial port it is recommended to flush its input buffer before you first read from it.
This can be done using `tcflush(fd, TCIFLUSH)` (or equivalent on your platform) on the file descriptor of the virtual serial port.

## Comparison to TTYBUS

Expand Down

0 comments on commit fd3e77c

Please sign in to comment.