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

updated help message and readme

Browse Source
This commit is contained in:
Edward Wright 2019-06-05 23:54:32 -04:00
parent 06658e80c1
commit ddac7fe7c1
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -28,10 +28,12 @@
# Using SimplySerial
By default, SimplySerial will attempt to connect to the first available serial (COM) port at 9600 baud, no parity, 8 data bits and 1 stop bit. If you added the `ss.exe` location to your `PATH`, only have one active COM port on your machine, and that COM port happens to be a device running CircuitPython (or anything that uses those particular port settings), entering the `ss` command while in Command Prompt or PowerShell should be all you have to do to connect. If you have multiple COM ports, or need to use different communications settings, you will need to use the appropriate command-line arguments listed below.
By default, SimplySerial will attempt to identify and connect to a CircuitPython-capable board at 9600 baud, no parity, 8 data bits and 1 stop bit. If no known boards are detected, it will default to the first available serial (COM) port. If you added the `ss.exe` location to your `PATH`, only have one active CircuitPython board (or COM port) on your machine, and that board/port is a device running CircuitPython (or anything that uses those particular port settings), entering the `ss` command while in Command Prompt or PowerShell should be all you have to do to connect. If you have multiple COM ports, or need to use different communications settings, you will need to use the appropriate command-line arguments listed below.
`-h, --help` displays a list of valid command-line arguments
`-l, --list` displays a list of available COM ports
`-c, --com` sets the desired COM port (ex. `-c:1` for COM1, `--com:22` for COM22)
`-b, --baud` sets the baud rate (ex. `-b:9600`, `--baud:115200`)
@ -64,3 +66,7 @@ To disconnect and exit SimplySerial, press `CTRL-X` at any time.
If you have questions, problems, feature requests, etc. please post them to the [Issues section on Github](https://github.com/fasteddy516/SimplySerial/issues). If you would like to contribute, please let me know. I have already put some "enhancement requests" in the Github Issues section with some ideas for improvements, most of which were either beyond my limited C#/Windows programming knowledge, or required more time than I had available!
# Acknowledgements
The code used to obtain extra details about connected serial devices (VID, PID, etc.) is a modified version of examples posted by Kamil Górski (freakone) at http://blog.gorski.pm/serial-port-details-in-c-sharp and https://github.com/freakone/serial-reader. Some modifications were made based on this stackoverflow thread: https://stackoverflow.com/questions/11458835/finding-information-about-all-serial-devices-connected-through-usb-in-c-sharp.

6
SimplySerial/SimplySerial.cs
View File

@ -340,10 +340,12 @@ namespace SimplySerial
Console.WriteLine(" [-stopbits:VALUE][-quiet][-nowait]\n");
Console.WriteLine("Barebones serial terminal for IoT device programming in general, and working with");
Console.WriteLine("CircuitPython devices specifically! With no command-line arguments specified,");
Console.WriteLine("SimplySerial will attempt to connect to the first available serial (COM) port at");
Console.WriteLine("9600 baud, no parity, 8 data bits and 1 stop bit.\n");
Console.WriteLine("SimplySerial will attempt to identify and connect to a CircuitPython-capable board");
Console.WriteLine("at 9600 baud, no parity, 8 data bits and 1 stop bit. If no known boards are");
Console.WriteLine("detected, it will default to the first available serial (COM) port.\n");
Console.WriteLine("Optional arguments:");
Console.WriteLine(" -help Display this help message");
Console.WriteLine(" -list Display a list of available serial (COM) ports");
Console.WriteLine(" -com:PORT COM port number (i.e. 1 for COM1, 22 for COM22, etc.)");
Console.WriteLine(" -baud:RATE 1200 | 2400 | 4800 | 7200 | 9600 | 14400 | 19200 | 38400 |");
Console.WriteLine(" 57600 | 115200");