#serial-port #serial #listing #watching #tool #cli-tool

app wolffserial

Simple cli tool for listing and watching serial ports

3 unstable releases

0.2.1 Jul 7, 2022
0.1.2 Jul 2, 2022
0.1.1 Jul 2, 2022

#9 in #watching

MIT license

9KB
120 lines

wolffserial-rs

GitHub Build_Win GitHub Build_Ubuntu License GitHub code size in bytes GitHub repo size Lines of code GitHub tag (latest by date)

a lil helper program for reading from a serial port and listing available serial ports

building and developing

windows

as long as you have cargo on the path you should be able to build with cargo build or run with cargo run

linux

you may need to install libudev-dev and pkg-config to build the package properly on ubuntu this would most likely be done with:

# apt install libudev-dev pkg-config

running the binary

the binary needs to be run from a terminal with a subcommand to tell it what to do. the available options and commands can be displayed by running with the help subcommand or --help flag and this can be used to see help for a specific command as well (such as ./wolffserial help watch to see the help for the watch subcommand)

below is an example output from running ./wolffserial help and from this you can see the functions of the subcommands

Recieve input from a serial device 
Reads data from a serial port and echoes it to stdout

USAGE:
    wolffserial [SUBCOMMAND]

FLAGS:
    -h, --help    Prints help information

SUBCOMMANDS:
    help     Prints this message or the help of the given subcommand(s)
    list     Lists available devices
    watch    Watch a specific device

todo

  • rebrand with generalised utility
  • timeout to retry on disconnect
  • add initial example tests

Dependencies

~3–4MB
~72K SLoC