You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,11 @@ Available at https://github.com/fasteddy516/SimplySerial
8
8
9
9
# Description
10
10
11
-
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 "COMx". It was, however, written specifically for
12
-
use within a "terminal" window in [Visual Studio Code](https://code.visualstudio.com/) to provide serial communications with devices running [CircuitPython](https://circuitpython.org/). Most of the testing and development of this application was done with this use case in mind.
11
+
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 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 "COMx". It was, however, written specifically for use within a "terminal" window in [Visual Studio Code](https://code.visualstudio.com/) to provide serial communications with devices running [CircuitPython](https://circuitpython.org/). Most of the testing and development of this application was done with this use case in mind.
13
12
14
13
# A Quick Note For CircuitPython Users
15
14
16
-
If your primary interest in SimplySerial is for programming CircuitPython devices in Visual Studio Code, _I encourage you to check out Joe DeVivo's excellent VSCode extension_ in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=joedevivo.vscode-circuitpython) or [On Github](https://github.com/joedevivo/vscode-circuitpython). His extension has tons of awesome features that go well beyond the basic 'serial terminal' functionality provided by SimplySerial. That being said, SimplySerial is still a handy little tool for quickly connecting to serial devices in a command prompt/powershell, for use in VSCode for non-CircuitPython devices, or for those who prefer its simplicity over the full-featured CircuitPython extension.
15
+
If your primary interest in SimplySerial is for programming CircuitPython devices in Visual Studio Code, _I encourage you to check out Joe DeVivo's excellent VSCode extension_ in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=joedevivo.vscode-circuitpython) or [On GitHub](https://github.com/joedevivo/vscode-circuitpython). His extension has tons of awesome features that go well beyond the basic 'serial terminal' functionality provided by SimplySerial. That being said, SimplySerial is still a handy little tool for quickly connecting to serial devices in a Command Prompt/PowerShell, for use in VSCode for non-CircuitPython devices, or for those who prefer its simplicity over the full-featured CircuitPython extension.
17
16
18
17
# Requirements
19
18
@@ -37,14 +36,14 @@ Download the [latest release](https://github.com/fasteddy516/SimplySerial/releas
37
36
38
37
**_The installer versions are unsigned, and may trigger a "Windows Defender SmartScreen" warning. To install you have to press "More Info" followed by "Run Anyway"._**
39
38
40
-
`SimplySerial_x.x.x_standalone.zip` is a standard compressed archive containing the SimplySerial executable and some documentation. You can unzip it whereever you like, and add that location to your `PATH` or not. **Advanced users may prefer this format/process.**
39
+
`SimplySerial_x.x.x_standalone.zip` is a standard compressed archive containing SimplySerial's program files and some documentation. You can unzip it wherever you like, and add that location to your `PATH` or not. **Advanced users may prefer this format/process.**
41
40
42
41
43
42
# Using SimplySerial
44
43
45
44
For CircuitPython users, type `ss` in a Command Prompt, PowerShell or VSCode Terminal Window and press `enter`. That's it!
46
45
47
-
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 there are no COM ports available, it will wait until one shows up, then connect to it.
46
+
By default, SimplySerial will attempt to identify and connect to a CircuitPython-capable board at 115200 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 at 9600 baud. If there are no COM ports available, it will wait until one shows up, then connect to it.
48
47
49
48
Once you're connected, you should see messages from the device on COMx appear on screen, and anything you type into Command Prompt/PowerShell will be sent to the device. CircuitPython users can access the REPL using `CTRL-C` and exit the REPL using `CTRL-D`.
50
49
@@ -54,6 +53,8 @@ If you have multiple COM ports, multiple CircuitPython devices connected, or nee
54
53
55
54
`-h, --help` displays a list of valid command-line arguments
56
55
56
+
`-v, --version` displays version and installation information
57
+
57
58
`-l, --list` displays a list of available COM ports
58
59
59
60
`-c, --com` sets the desired COM port (ex. `-c:1` for COM1, `--com:22` for COM22)
@@ -107,7 +108,7 @@ If you're directly editing the settings.json, the profile section will look like
107
108
108
109
# Contributing
109
110
110
-
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!
111
+
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!
0 commit comments