A serial monitor for USB Serial devices, written in rust.
serial-monitor is a command line program which will conect to, and allow you to interact with devices
which are connected to your host computer via USB serial adapters.
You can use the --list option to display all of the detected USB serial
adapters, and you can use the --vid, --pid, --port, --serial,
--manufacturer, or --product options to filter your list.
serial-monitor will open the first USB serial port which satifies the
filtering criteria.
Once, connected, you can use Control-X (or Control-Y if started with the -y option)
to exit from serial-monitor and return you to your prompt.
Clone this repository:
git clone https://github.com/dhylands/serial-monitor.git
cd serial-monitor
Install rust. Personally, I prefer to use rustup. I happned to be using 1.42.0.
You can then build and install serial-monitor using:
cargo install --path .
This will copy serial-monitor into ~/.cargo/bin
```bash $ serial-monitor --help serial-monitor 0.0.2
USAGE: serial-monitor [FLAGS] [OPTIONS]
FLAGS: -y Exit using Control-Y rather than Control-X -d, --debug Turn on debugging -f, --find Like list, but only prints the name of the port that was found. This is useful for using from scripts or makefiles -h, --help Prints help information -l, --list List USB Serial devices which are currently connected -V, --version Prints version information -v, --verbose Turn on verbose messages
OPTIONS:
-b, --baud
The --list (or -l) option will list all of the connected USB Serial Adapters, for example:
$ serial-monitor --list
USB Serial Device f055:9800 with manufacturer 'MicroPython' serial '336F338F3433' product 'Pyboard Virtual Comm Port in FS Mode' found @/dev/tty.usbmodem336F338F34332
USB Serial Device 0403:6001 with manufacturer 'FTDI' serial 'A700e6Lr' product 'FT232R USB UART' found @/dev/tty.usbserial-A700e6Lr
If you then wanted to connect to the MicroPython board, you might do: serial-monitor -m Micro or perhaps serial-monitor --vid f055.
You can experiment with filtering options by combining with the --list option which will only show you the USB Serial Adapters which
match the filter criteria.
Once you're connected you should see something like the following: ``` Connected to /dev/tty.usbmodem336F338F34332 Press Control-X to exit MicroPython v1.11-47-g1a51fc9dd on 2019-06-18; PYBv1.1 with STM32F405RG Type "help()" for more information.
```
To exit from serial-monitor use Control-X (or Control-Y if you started with the -y option). Using Control-X allows characters like Control-C and Control-D
to be passed on to the device on the serial port.
The --find option behaves very similary to the --list command, but it only displays the port name of the first port found.
For example, serial-monitor --list might show:
USB Serial Device 1d50:6018 with manufacturer 'Black Sphere Technologies' serial '7ABA4DC1' product 'Black Magic Probe' found @/dev/tty.usbmodem7ABA4DC11
USB Serial Device 1d50:6018 with manufacturer 'Black Sphere Technologies' serial '7ABA4DC1' product 'Black Magic Probe' found @/dev/tty.usbmodem7ABA4DC13
and the command serial-monitor --find --product 'Black Magic Probe' --port '*1' would show:
$ serial-monitor --find --product 'Black Magic Probe' --port '*1'
/dev/tty.usbmodem7ABA4DC11
This can be quite useful from within a script:
bash
GDB_PORT = $(serial-monitor --find --product 'Black Magic Probe' --port '*1')
arm-none-eabi-gdb -ex 'target extended-remote ${GDB_PORT}' -x gdbinit myprogram.elf
You can use the --vid, --pid, --port, --serial, --manufacturer, or --product options to filter the selection of the serial ports.
All of these options allow the use of * or ? wildcards. Note that you'll probably need to quote these to prevent your shell from expanding them.
* means to match 0 or more characters and ? means to match one character. If you don't specify any wildcards then it is assumed that there is a *
at the beginning and the end of the string. So --product FS will behave as if you had typed --product '*FS*'.