mirror/SimplySerial
1
0
Fork 0
mirror of https://github.com/fasteddy516/SimplySerial.git synced 2024-11-24 10:04:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
fasteddy516 2019-06-09 21:27:23 -04:00 committed by GitHub
parent 43c1f31975
commit e4a0c67d0e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,6 +1,6 @@
# SimplySerial
###### A simple serial terminal that runs as a Windows console application.
###### A serial terminal that runs as a Windows console application.
Written by [Edward Wright](mailto:fasteddy@thewrightspace.net) (fasteddy516).
@ -11,7 +11,7 @@
# Description
SimplySerial is a simple serial terminal that runs as a Windows console application. It provides a quick way to connect to - and communicate with - serial devices through the Windows Command Prompt or PowerShell.
SimplySerial is a basic serial terminal that runs as a Windows console application. It provides a quick way to connect to - and communicate with - serial devices through the Windows Command Prompt or PowerShell.
SimplySerial can be used directly from Command Prompt/PowerShell and should work with most
devices that appear in Device Manager as "COMxx". It was, however, written specifically for
@ -44,9 +44,9 @@
`-s, --stopbits` sets the number of stop bits to use (ex. `-s:1`, `--stopbits:1.5`)
`-q, --quiet` prevents any application messages (connection banner, error messages, etc.) from printing out to the console.
`-a, --autoconnect` sets the desired auto-(re)connect behaviour (ex. `a:NONE`, `--autoconnect:ANY`)
`-n, --nowait` prevents the system from waiting for user input ("press any key to exit", etc.)
`-q, --quiet` prevents any application messages (connection banner, error messages, etc.) from printing out to the console.
If you wanted to connect to a device on COM17 at 115200 baud, you would use the command `ss -c:17 -b:115200`, or if you really enjoy typing `ss --com:17 --baud:115200`.
@ -55,6 +55,17 @@ Once you're connected, you should see messages from the device on COMxx appear o
To disconnect and exit SimplySerial, press `CTRL-X` at any time.
# Auto-(re)connect functionality
SimplySerial's `autoconnect` option can be used to determine if and how to connect/reconnect to a device. These options function as follows:
`--autoconnect:ONE` is the default mode of operation. If a COM port was specified using the `--com` option, SimplySerial will attempt to connect to the specified port, otherwise it will connect to the first available COM port (giving preference to devices known to be CircuitPython-capable). In either case, the program will wait until the/a COM port is available, and connect to it when it is. If the device becomes unavailable at any point (because it was disconnected, etc.), SimplySerial will wait until that specific COM port becomes available again, regardless of any other COM ports that may or may not be available.
`--autoconnect:ANY` is similar to `ONE`, except that when the connected port becomes unavailable, SimplySerial will attempt to connect to any other available port. This option is useful if you only ever have one COM port available at a time, but can be problematic if you have multiple COM ports connected, or if you have a built-in COM port that is always available.
`--autoconnect:NONE` prevents SimplySerial from waiting for devices and automatically re-connecting.
# Using SimplySerial in Visual Studio Code (VSCode)
In a standard installation of VSCode, opening a "terminal" gets you a Command Prompt or PowerShell window embedded in the VSCode interface. SimplySerial works exactly the same within this embedded window as it does in a normal Command Prompt or PowerShell, which means if you fit the "easy use case scenario" mentioned above (`ss.exe` added to path, single COM port, 9600 baud, etc.), using SimplySerial within VSCode is as easy as opening a terminal window via the menu bar (`Terminal > New Terminal`) or shortcut key, typing `ss` and pressing enter.