TELETYPE manpage

TELETYPE(1) General Commands Manual

NAME

teletype — Teleprinter command line tool for sending data to and receiving data from TTY (serial) ports simultaneously.

SYNOPSIS

teletype -l [ -q ] [ -d ]
teletype -p <port> { -L | -S -m <message> } [ -b <baud> ] [ --data-bits <dataBits> ] [ --stop-bits <stopBits> ] [ --parity <parity> ] [ -z ] [ --config <config> ] [ -q ] [ -d ]
teletype --config <config> { -L | -S -m <message> } [ -p <port> ] [ -b <baud> ] [ --data-bits <dataBits> ] [ --stop-bits <stopBits> ] [ --parity <parity> ] [ -z ] [ -q ] [ -d ]
teletype --init [ --config <config> ] [ -q ]
teletype -p <port> --clean [ -q ] [ -d ]
teletype -h | --sysinfo [ -q ]

DESCRIPTION

This manual page documents the teletype command: The teletype command listens --listen on a serial (TTY) port --port configured with a given baud --baud rate, number of data bits --data-bits and stop bits --stop-bits as well as a parity --parity for incoming data printing it out to the console using line breaks for the value 0 (“zero”) in case of ASCIIZ --asciiz being enabled or sends --send messages --message to the serial (TTY) port --port optionally being ASCIIZ --asciiz terminated or lists --list all serial (TTY) ports.

Depending on the executable’s flavor the command might also be named teletype-x.y.z.jar, teletype-bundle-x86_64-x.y.z.elf, teletype-bundle-x86_64-x.y.z.exe, teletype-installer-x86_64-x.y.z.msi, teletype-launcher-x.y.z.sh, teletype-launcher-x86_64-x.y.z.elf, teletype-launcher-x86_64-x.y.z.exe, teletype-native-x86_64-x.y.z.elf where x.y.z stands for the version of the teletype command. The according executable’s name will be referenced to in this manual as teletype.

OPTIONS

-b --baud <baud>: The baud rate to use for the TTY (COM) serial port.
--clean: Clean any temporoary (lock) files.
--config <config>: Specifies the resource (file) to use when loading the configuration.
-d --debug: Enables the debug mode with additional (developer readable) informational output.
--data-bits <dataBits>: The data bits to use for the TTY (COM) serial port (usually a value of 7 or 8).
-h --help: Shows this help.
--init: Initialize the configuration (from a template).
-l --list: List all detected TTY (COM) serial ports.
-L --listen: Listen for data from the COM (serial) port.
-m --message <message>: The message to be sent.
-p --port <port>: The COM (serial) port to operate on.
--parity <parity>: The parity to use for the TTY (COM) serial port: { AUTO, NONE, ODD, EVEN, MARK, SPACE }
-q --quiet: Enables the quiet mode without any informational output.
-S --send: Send data to the COM (serial) port.
--stop-bits <stopBits>: The stop bits to use for the TTY (COM) serial port: { AUTO, ONE, ONE_POINT_FIVE, TWO }
--sysinfo: Shows some system information for debugging purposes.
-z --asciiz: Terminate the message to be sent by the value 0 (“zero”), print line break upon an incoming 0 (“zero”).

EXAMPLES

List all available TTY (COM) ports:

  • teletype -l

Receive data from specific port:

  • teletype -p <port> -L

Send data to specific port:

  • teletype -p <port> -S -m <message>

Receive data from specific port using a given config:

  • teletype -L --config <config>

Send data to specific port using a given config:

  • teletype -S -m <message> --config <config>

Intialize default config file:

  • teletype --init

Intialize specific config file:

  • teletype --init --config <config>

Clean the port’s lock file:

  • teletype --clean -p <port>

To show the help text:

  • teletype -h

To print the system info:

  • teletype --sysinfo

FILES

The teletype.ini configuration file supports the following properties:

  • asciiz=Terminate the message to be sent by the value 0 (“zero”), print line break upon an incoming 0, e.g. false
  • stopBits=The stop bits to use for the TTY (COM) serial port, e.g. AUTO
  • parity=The parity to use for the TTY (COM) serial port, e.g. NONE
  • dataBits=The data bits to use for the TTY (COM) serial port, e.g. 8
  • baud=The baud rate to use for the TTY (COM) serial port, e.g. 9600

The teletype.ini configuration file must be located either in the current user’s working directory, the tty2mqtt executable’s folder or subfolder settings, etc or config or the user home’s ~/.config folder or in the /etc folder (in this precedence).

BUGS

See BitBucket issues: https://bitbucket.org/funcodez/funcodes-teletype

AUTHOR

Siegfried Steiner steiner@refcodes.org

SEE ALSO