From ddac7fe7c1c6d1ec13df8ae61d7c2379e60383b4 Mon Sep 17 00:00:00 2001 From: Edward Wright Date: Wed, 5 Jun 2019 23:54:32 -0400 Subject: [PATCH] updated help message and readme --- README.md | 10 ++++++++-- SimplySerial/SimplySerial.cs | 6 ++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 54fa659..a47911b 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,11 @@ # 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 + `-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) @@ -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. \ No newline at end of file diff --git a/SimplySerial/SimplySerial.cs b/SimplySerial/SimplySerial.cs index 64c7e86..37aa21c 100644 --- a/SimplySerial/SimplySerial.cs +++ b/SimplySerial/SimplySerial.cs @@ -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");