Skip to content

Commit 663fd79

Browse files
committed
README: Document commandline arguments
1 parent 74db447 commit 663fd79

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,39 @@ cargo install cargo-wix
7070
cargo wix
7171
```
7272

73+
## Commandline Arguments
74+
You can start the app with commandline arguments to automatically select a serial port and its settings:
75+
76+
```text
77+
Usage: serial-monitor-rust [OPTIONS]
78+
79+
Positional arguments:
80+
device Serial port device to open on startup
81+
82+
Optional arguments:
83+
-b, --baudrate BAUDRATE Baudrate (default=9600)
84+
-d, --databits DATABITS Data bits (5, 6, 7, default=8)
85+
-f, --flow FLOW Flow conrol (hard, soft, default=none)
86+
-s, --stopbits STOPBITS Stop bits (default=1, 2)
87+
-p, --parity PARITY Parity (odd, even, default=none)
88+
-F, --file FILE Load data from a file instead of a serial port
89+
--column COLUMN-LABELS Column labels, can be specified multiple times for more columns
90+
--color COLUMN-COLORS Column colors (hex color without #), can be specified multiple times for more columns
91+
-h, --help
92+
```
93+
94+
Example usage:
95+
96+
```sh
97+
serial-monitor-rust /dev/ttyACM0 --baudrate 115200
98+
```
99+
100+
You can also preconfigure the column settings. The following example configures the name and color for two columns in the incoming data:
101+
102+
```sh
103+
serial-monitor-rust --column Raw --color '808080' --column Temperature --color 'ff8000' /dev/ttyACM0
104+
```
105+
73106
## Features:
74107

75108
- [X] Plotting and printing of data simultaneously

0 commit comments

Comments
 (0)