Skip to content

ActuallyTaylor/cereal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cereal 🥣

cereal is a terminal based Serial Console. It was written as an alternative to using screen for interacting with serial devices on macOS.

sample

Installation

cereal is availabe via Homebrew.

brew tap actuallytaylor/formulae
brew update
brew install cereal-console

Features

  • Connect to serial devices (tty, cu, etc...).
    • If no device is provided to the command, you will be able to select from a list of connected serial ports.
  • Set a baud rate for the serial connection.
    • If no baud rate is provided, you can select from a set of commonly used baud rates. The default is 9600
  • Receive and display utf8 data from the serial connection.
  • Keystrokes are captured and sent back to the serial connection.
  • Exit with ctrl + c.
  • Set Connection Parity.
  • Set flow control options.
  • Set # of stop bits.

Command Line Usage

$ cereal -h
USAGE: cereal [--version] [--device <device>] [--baud-rate <baud-rate>] [--one] [--two] [--none] [--odd] [--even] [--rts_cts] [--dtr_dsr] [--dcd] [--cr] [--lf] [--crlf]

OPTIONS:
  -v, --version           Print version
  -d, --device <device>   Path to Serial Device.
  -b, --baud-rate <baud-rate>
                          Buad rate for serial connection
  --one/--two             # of Stop Bits for the serial connection. (default:
                          --one)
  --none/--odd/--even     Parity for the serial connection. (default: --none)
  --rts_cts/--dtr_dsr/--dcd
                          Flow Control options (multiple options allowed)
  --cr/--lf/--crlf        Change which line ending is sent when return / enter
                          is pressed. (default: --cr)
  -h, --help              Show help information.

TODO

  1. Add keybinds to toggle RTS & DTR pins.
  2. Add a view of the current state of the RTS, DTR, CTS, DSR, and DCD pins.

Credits

About

macOS Serial Console

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

No packages published

Languages