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

Update README

Browse Source
This commit is contained in:
Edward Wright 2023-02-16 11:57:28 -05:00
parent 185e541b12
commit e86ca7e7ef
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -66,11 +66,19 @@ If you have multiple COM ports, multiple CircuitPython devices connected, or nee
`-a, --autoconnect` sets the desired auto-(re)connect behaviour (ex. `a:NONE`, `--autoconnect:ANY`)
`-l, --log` Logs all output to the specified file. (ex. `-l:ss.log`, `-log:"C:\Users\My Name\my log.txt"`)
`-l, --log` logs all output to the specified file (ex. `-l:ss.log`, `-log:"C:\Users\My Name\my log.txt"`)
`--logmode` Instructs SimplySerial to either `APPEND` to an existing log file, or `OVERWRITE` an existing log file. In either case, if the specified log file does not exist, it will be created. If neither option is specified, `OVERWRITE` is assumed. (ex. `--logmode:APPEND`)
`--logmode` instructs SimplySerial to either `APPEND` to an existing log file, or `OVERWRITE` an existing log file. In either case, if the specified log file does not exist, it will be created. If neither option is specified, `OVERWRITE` is assumed. (ex. `--logmode:APPEND`)
`-q, --quiet` prevents any application messages (connection banner, error messages, etc.) from printing out to the console.
`-q, --quiet` prevents any application messages (connection banner, error messages, etc.) from printing out to the console
`-f, --forcenewline` replaces carriage returns with linefeeds in received data
`-e, --encoding` sets the encoding to use when outputting to the terminal and log files. Defaults to `UTF8`, can also be set to `ASCII` (the default in SimplySerial versions prior to 0.8.0) or `RAW`. In `RAW` mode, all non-printable characters are displayed as `[xx]` where `xx` is the hexadecimal byte value of the character.
`-noc --noclear` don't clear the terminal screen on connection
`-nos --nostatus` block status/title updates generated by virtual terminal sequences (such as the CircuitPython status bar introduced in CP version 8.0.0)
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`.