https://github.com/ringtailsoftware/commy

A small serial monitor
https://github.com/ringtailsoftware/commy

serial serial-communication serialmonitor uart zig zig-package

Last synced: about 2 months ago
JSON representation

A small serial monitor

• Host: GitHub
• URL: https://github.com/ringtailsoftware/commy
• Owner: ringtailsoftware
• License: mit
• Created: 2024-12-13T16:31:33.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-13T19:25:43.000Z (about 2 months ago)
• Last Synced: 2024-12-13T20:18:02.896Z (about 2 months ago)
• Topics: serial, serial-communication, serialmonitor, uart, zig, zig-package
• Language: Zig
• Homepage:
• Size: 17.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-zig - ringtailsoftware/commy

README

        
# Commy, a barebones serial monitor

Commy is a small utility used to connect and monitor serial, UART or COM port devices.

Mac and Linux are supported.

Does (some of) the same things as [tio](https://github.com/tio/tio), [minicom](https://en.wikipedia.org/wiki/Minicom), [screen](https://www.gnu.org/software/screen/), [miniterm.py](https://github.com/pyserial/pyserial/blob/master/serial/tools/miniterm.py), [zcom](https://github.com/ZigEmbeddedGroup/zcom), [PuTTY](https://www.putty.org/), etc.

# Build from source

    zig build

    zig-out/bin/commy -h

# Typical use

List available serial ports

    commy -l

    /dev/cu.usbmodem1124101

    /dev/cu.usbmodem1124203

Connect to a port

    commy /dev/cu.usbmodem1124203 115200

The status bar at the top shows keyboard shortcuts. Press `ctrl-a` then `q`, `\` or `x` to quit.

Log data received from a device. Only received data will be logged, unless local echo is enabled.

    commy /dev/cu.usbmodem1124203 115200 -o log.txt

Enable local echo of sent data, used for devices which do not echo back characters they receive.

    commy /dev/cu.usbmodem1124203 115200 -e

# Why use Commy?

It tells the user how to quit.

# Help text

    Usage: commy [ARGS] [OPTIONS]

    Args:

        port                                          serial port file

        speed                                         baudrate

    Options:

        -l, --list                                    List available serial ports

        -e, --echo                                    Enable local echo

        -o, --output=                         Log to file

        -p, --parity=                         Parity

                                                        values: { none, even, odd, mark, space }

        -w, --wordsize=                     wordsize

                                                        values: { five, six, seven, eight }

        -s, --stop=                             stop

                                                        values: { one, two }

        -f, --flow=                             flow

                                                        values: { none, software, hardware }

        -h, --help                                    Print this help and exit

# Testing

If no serial device is available, commy can connect to a Linux serial terminal inside docker. From here, any standard linux terminal software can be used.

    cd linux-test

    ./lincommy.sh

This will build commy, then build a docker container and start it. Inside the container `socat` will create a virtual serial port and bind it to `bash`. commy will then connect to the virtual serial port. Quitting commy will close down the docker container.