Skip to main content
usb_ser_mon
==============

A serial monitor for USB Serial devices.

usb-ser-mon.py will automatically detect your connected USB Serial device and
print the output from it.

This is similar in functionality to the Arduino serial monitor, except that
usb-ser-mon.py deals with the device disconnects automtically, and will wait
for your device to reconnect.

If you have more than one USB device connected, you can use the -s
option to specify the serial number of the device you wish to connect to,
or use the -n command to specify the device vendor.

Currently, this program only works under linux.

It was tested with the following devices:
- Teensy 3.1
- STM32F4DISCOVERY board
- Prolific USB to Serial adapter

Installation
============
Download or checkout this repository. With a terminal opened in the project directory.
Install using pip:
```
pip install .
```

If you want to edit the files in this directory and use them, install in edit mode:
```
pip install -e .
```

Usage
=====

Use -l to list all of the connected devices.
```
./usb-ser-mon.py -l
````

will show you the currently connected devices, for example:
```
USB Serial Device with vendor 'Teensyduino' serial '21973' found @/dev/ttyACM1
USB Serial Device with vendor 'Prolific_Technology_Inc.' found @/dev/ttyUSB0
USB Serial Device with vendor 'STMicroelectronics' serial '00000000050C' found @/dev/ttyACM0
```

If you want to connect with the STM device (an STM32FDISCOVERY board in this situation), then you might do:
```
./usb-ser-mon.py -n Teensy
```

and then see:
```
USB Serial device with vendor 'Teensyduino' serial '21973' connected @/dev/ttyACM1

>>>
```

In the previous example the Teensy was already connected. If I unplug and replug the Teensy device then I'd see:
```
USB Serial device @ /dev/ttyACM1 disconnected.

Waiting for USB Serial Device with vendor 'Teensy' ...
USB Serial device with vendor 'Teensyduino' serial '21973' connected @/dev/ttyACM1
Done executing '/src/main.py'
Micro Python for Teensy 3.1
Type "help()" for more information.
>>>
```

You only need to use as many characters as are required to uniquely identify a
device, so I could use ```./usb-ser-mon.py -n STM``` to connect to the
Discovery board.

Use Control-X to exit from usb-ser-mon.py.

The ```mk-udev-rules-stm32.sh``` script will create the appropriate udev rules
for the STM32F4 series processors.

The ```mk-udev-rules-pyboard.sh``` script will create the appropriate udev rules
for the MicroPython pyboard.

The ```mk-udev-rules-teensy.sh``` script will create the appropriate udev rules
for the Teensy 3.1 board.

Metadata

Release files for usb_ser_mon 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for usb_ser_mon 0.0.1
File Size Uploaded Provenance
usb_ser_mon-0.0.1.tar.gz 11.3 kB Without provenance Details

Release files / usb_ser_mon-0.0.1.tar.gz

Download URL usb_ser_mon-0.0.1.tar.gz
Size 11.3 kB
Tags Source
SHA-256 checksum
How to use checksums
f1ed3f0bf28b057548cb1e67f6897ffc8b415aaafcf740512a64371c89a7a19a
BLAKE2b-256 checksum
How to use checksums
46203fe16b838b57386485a100fccfde8056fe0f03c66f220acda65f4f238694
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for usb_ser_mon 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page