https://github.com/yasuenag/simplecom
Simple serial terminal for Windows console
https://github.com/yasuenag/simplecom
serialport windows-terminal
Last synced: 6 months ago
JSON representation
Simple serial terminal for Windows console
- Host: GitHub
- URL: https://github.com/yasuenag/simplecom
- Owner: YaSuenag
- License: gpl-2.0
- Created: 2019-07-27T14:46:26.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-02T02:39:11.000Z (11 months ago)
- Last Synced: 2024-11-02T03:23:36.556Z (11 months ago)
- Topics: serialport, windows-terminal
- Language: C++
- Size: 211 KB
- Stars: 46
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
SimpleCom
[](https://securityscorecards.dev/viewer/?uri=github.com/YaSuenag/SimpleCom)
[](https://www.bestpractices.dev/projects/8152)
===================
Console app for serial connection.
# How to use
1. Conenct serial adaptor to your PC
2. Start `SimpleCom.exe`
3. Setup serial console
* If you start SimpleCom without any command line options, use dialog to configure
* `> SimpleCom.exe`
* You can configure serial port with command line, then dialog would not be shown
* `> SimpleCom.exe COM[N]`
* `COM[N]` is mandatory to specify serial port
4. Operate target device via the console
5. Press F1 to leave its serial session and to finish SimpleCom
## Command line options
| Option | Default | Description |
| :----- | :------ | :---------- |
| `--show-dialog` | false | Show setup dialog even if command line arguments are passed. |
| `--wait-serial-device [seconds]` | 0 (disable) | Wait specified seconds for serial devices are available. |
| `--utf8` | false | Use UTF-8 code page on SimpleCom console. |
| `--tty-resizer` | false | Use TTY resizer. See [README.md in TTY resizer](tty-resizer/README.md). |
| `--baud-rate [num]` | 115200 | Baud rate |
| `--byte-size [num]` | 8 | Byte size |
| `--parity [val]` | `none` | Set one of following values as a parity:
- none
- odd
- even
- mark
- space
| `--stop-bits [val]` | `1` | Set one of following values as a stop bits:
- 1
- 1.5
- 2
| `--flow-control [val]` | `none` | Set one of following values as a flow control:
- none
- hardware
- software
| `--auto-reconnect` | false | Reconnect to peripheral automatically when serial session is disconnected. |
| `--auto-reconnect-pause [num]` | 3 | Pause time in seconds before reconnecting to peripheral. |
| `--auto-reconnect-timeout [num]` | 120 | Reconnect timeout |
| `--log-file [logfile]` | <none> | Log serial communication to file |
| `--stdin-logging` | false | Enable stdin logging
⚠️Possible to be logged each chars duplicately due to echo back from the console when this option is set, and also secrets (e.g. passphrase) typed into the console will be logged even if it is not shown on the console. |
| `--help` | - | Show help message |
# How to build
Use [SimpleCom.sln](https://github.com/YaSuenag/SimpleCom/blob/master/SimpleCom.sln) on your Visual Studio.
I confirmed x64 build on VS 2019.
## Distribution package
You can get distribution package when you do release build.
* [dist](dist): ZIP archive
* [Installer](Installer): MSI installer
MSI installer installes SimpleCom.exe and README.md (and also custom action assembly). It will deploy JSON fragment for SimpleCom into `%ProgramData%` or `%LocalAppData%` (it depends on install user choice). So the use can use SimpleCom without any configuration (as following) on Windows Terminal.
# How to use on [Windows Terminal](https://github.com/microsoft/terminal)
You can use [fragments.json](fragments.json) to add SimpleCom to your Windows Terminal.
For example, run following commands to add SimpleCom for all users.
```
PS > mkdir "C:\ProgramData\Microsoft\Windows Terminal\Fragments\SimpleCom"
PS > cp C:\Path\To\fragment.json "C:\ProgramData\Microsoft\Windows Terminal\Fragments\SimpleCom"
```
Please see [Applications installed from the web](https://docs.microsoft.com/ja-jp/windows/terminal/json-fragment-extensions#applications-installed-from-the-web) in Microsoft Docs.
# Notes
* SimpleCom sends / receives VT100 escape sequences. So the serial device to connect via SimpleCom needs to support VT100 or compatible shell.
* F1 key is hooked by SimpleCom, so escase sequence of F1 (`ESC O P`) would not be propagated.
* SimpleCom supports ANSI chars only, so it would not work if multibyte chars (e.g. CJK chars) are given.
* Run [resize](https://linux.die.net/man/1/resize) provided by xterm if you want to align VT size of Linux box with your console window.
# License
GNU General Public License v2.0