mirror of
https://github.com/tio/tio.git
synced 2026-05-01 14:57:59 +02:00
9476422922
Optional arguments, as parsed by the getopt_long mechanism, are inherently inconsistent with how you define required arguments. To avoid confusion we decide to avoid this inconsistency by replacing optional options with additional options with required argmuments.
188 lines
5.1 KiB
Markdown
188 lines
5.1 KiB
Markdown
# tio - a simple serial terminal I/O tool
|
|
|
|
[](https://circleci.com/gh/tio/tio/tree/master)
|
|
[](https://snapcraft.io/tio)
|
|
[](https://repology.org/project/tio/versions)
|
|
|
|
## 1. Introduction
|
|
|
|
tio is a simple serial terminal tool which features a straightforward
|
|
command-line interface to easily connect to TTY devices for basic I/O
|
|
operations.
|
|
|
|
<p align="center">
|
|
<img src="images/tio-demo.gif">
|
|
</p>
|
|
|
|
### 1.1 Motivation
|
|
|
|
To make a simpler serial terminal tool for talking with TTY devices with less
|
|
focus on classic terminal/modem features and more focus on the needs of
|
|
embedded developers and hackers.
|
|
|
|
## 2. Usage
|
|
|
|
### 2.1 Command-line
|
|
|
|
The command-line interface is straightforward as reflected in the output from
|
|
'tio --help':
|
|
```
|
|
Usage: tio [<options>] <tty-device|config>
|
|
|
|
Options:
|
|
-b, --baudrate <bps> Baud rate (default: 115200)
|
|
-d, --databits 5|6|7|8 Data bits (default: 8)
|
|
-f, --flow hard|soft|none Flow control (default: none)
|
|
-s, --stopbits 1|2 Stop bits (default: 1)
|
|
-p, --parity odd|even|none Parity (default: none)
|
|
-o, --output-delay <ms> Character output delay (default: 0)
|
|
-n, --no-autoconnect Disable automatic connect
|
|
-e, --local-echo Enable local echo
|
|
-t, --timestamp Enable line timestamp
|
|
--timestamp-format <format> Set timestamp format (default: 24hour)
|
|
-L, --list-devices List available serial devices
|
|
-l, --log Enable log to file
|
|
--log-filename <filename> Set log filename
|
|
-m, --map <flags> Map special characters
|
|
-c, --color <0..255> Colorize tio text
|
|
-S, --socket <socket> Listen on socket
|
|
-v, --version Display version
|
|
-h, --help Display help
|
|
|
|
Options may be set via configuration file.
|
|
|
|
In session, press ctrl-t q to quit.
|
|
|
|
See the man page for more details.
|
|
```
|
|
|
|
The only option which requires a bit of elaboration is perhaps the
|
|
`--no-autoconnect` option.
|
|
|
|
By default tio automatically connects to the provided device if present. If
|
|
the device is not present, it will wait for it to appear and then connect. If
|
|
the connection is lost (eg. device is unplugged), it will wait for the device
|
|
to reappear and then reconnect. However, if the `--no-autoconnect` option is
|
|
provided, tio will exit if the device is not present or an established
|
|
connection is lost.
|
|
|
|
Tio supports various in session key commands. Press ctrl-t ? to list the
|
|
available key commands.
|
|
|
|
Tio also features full bash autocompletion and configuration file support.
|
|
|
|
See the tio man page for more details.
|
|
|
|
### 2.2 Configuration file
|
|
|
|
Options can be set via a configuration file first found in the following
|
|
locations in the order listed:
|
|
- $XDG_CONFIG_HOME/tio/tiorc
|
|
- $HOME/.config/tio/tiorc
|
|
- $HOME/.tiorc
|
|
|
|
The configuration file supports sub-configurations by named sections which can
|
|
be activated via the command-line.
|
|
|
|
Example configuration file:
|
|
|
|
```
|
|
# Defaults
|
|
baudrate = 115200
|
|
databits = 8
|
|
parity = none
|
|
stopbits = 1
|
|
color = 46
|
|
|
|
[ftdi]
|
|
tty = /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0
|
|
baudrate = 9600
|
|
no-autoconnect = enable
|
|
color = 12
|
|
|
|
[usb devices]
|
|
pattern=usb([0-9]*)
|
|
tty = /dev/ttyUSB%s
|
|
log = enable
|
|
log-filename = usb.log
|
|
color = 13
|
|
```
|
|
|
|
To use a specific sub-configuration simply start tio like so:
|
|
```
|
|
$ tio ftdi
|
|
```
|
|
or
|
|
```
|
|
$ tio usb12
|
|
```
|
|
|
|
|
|
## 3. Installation
|
|
|
|
### 3.1 Installation using package manager
|
|
tio comes prepackaged for various GNU/Linux distributions. Please consult your package manager tool to find and install tio.
|
|
|
|
### 3.2 Installation using snap
|
|
|
|
Install latest stable version:
|
|
```
|
|
$ snap install tio
|
|
```
|
|
Install bleeding edge:
|
|
```
|
|
$ snap install tio --edge
|
|
```
|
|
|
|
### 3.3 Installation from source
|
|
|
|
The latest source releases can be found [here](https://github.com/tio/tio/releases).
|
|
|
|
Install steps:
|
|
```
|
|
$ meson build
|
|
$ meson compile -C build
|
|
$ meson install -C build
|
|
```
|
|
|
|
See meson\_options.txt for tio specific build options.
|
|
|
|
Note: Please do no try to install from source if you are not familiar with
|
|
how to build stuff using meson.
|
|
|
|
|
|
## 4. Contributing
|
|
|
|
tio is open source. If you want to help out with the project please feel free
|
|
to join in.
|
|
|
|
All contributions (bug reports, code, doc, ideas, etc.) are welcome.
|
|
|
|
Please use the github issue tracker and pull request features.
|
|
|
|
Also, if you find this free open source software useful please feel free to
|
|
consider making a donation of your choice:
|
|
|
|
[](https://www.paypal.me/lundmar)
|
|
|
|
|
|
## 5. Support
|
|
|
|
Submit bug reports via GitHub: https://github.com/tio/tio/issues
|
|
|
|
|
|
## 6. Website
|
|
|
|
Visit [tio.github.io](https://tio.github.io)
|
|
|
|
|
|
## 7. License
|
|
|
|
Tio is GPLv2+. See LICENSE file for more details.
|
|
|
|
|
|
## 8. Authors
|
|
|
|
Created by Martin Lund \<martin.lund@keep-it-simple.com>
|
|
|
|
See the AUTHORS file for full list of contributors.
|