Maarrk/tio
1
0
Fork 0
mirror of https://github.com/tio/tio.git synced 2026-05-01 14:57:59 +02:00
Code Issues Projects Releases 1 Packages Wiki Activity Actions

Add new ways to manage serial devices

Browse source 
* Rename --list-devices to --list

 * Rename --no-autoconnect to --no-reconnect

 * Switch -l and -L options

   * -l now lists available serial devices

   * -L enables log to file

 * Add option --auto-connect <strategy>

   * Supported strategies:

     * "new" - Waits to connect first new appearing serial device

     * "latest" - Connects to latest registered serial device

     * "direct" - Connect directly to specified serial device (default)

 * Add options to exclude serial devices from auto connect strategy by
   pattern

   * Supported exclude options:

     * --exclude-devices <pattern>

       Example: '--exclude-devices "/dev/ttyUSB2,/dev/ttyS?"'

     * --exclude-drivers <pattern>

       Example: '--exclude-drivers "cdc_acm"'

     * --exclude-tids <pattern>

       Example: '--exclude-tids "yW07,bCC2"'

     * Patterns support '*' and '?'

 * Connect to same port/device combination via unique topology ID (TID)

   * Topology ID is a 4 digit base62 encoded hash of a device topology
     string coming from the Linux kernel. This means that whenever you
     plug in the same e.g. USB serial port device to the same USB hub
     port connected via the exact same hub topology all the way to your
     computer, you will get the same unique TID.

   * Useful for stable reconnections when serial device has no serial
     device by ID

   * For now, only tested on Linux.

 * Reworked and improved listing of serial devices to show serial devices:

   * By device

     * Including TID, uptime, driver, and description.

     * Sorted by uptime (newest device listed last)

   * By unique topology ID

   * By ID

   * By path

 * Add script interface 'list = tty_search()' for searching for serial
   devices.
This commit is contained in:
Martin Lund 2024-04-26 20:34:17 +02:00
parent ae76f8f58d
commit d19ba1c492
22 changed files with 1468 additions and 150 deletions
Download patch file Download diff file Expand all files Collapse all files

87
man/tio.1.txt
View file

@ -62,13 +62,37 @@ OPTIONS
The default pulse duration for each line is 100 ms.
-n, --no-autoconnect
-a, --auto-connect new|latest|direct
Disable automatic connect.
Automatically connect to serial device according to one of the following strategies:
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 disconnects), it will wait for the device to reappear and then reconnect.
new Automatically connect to first new appearing serial device.
However, if the --no-autoconnect option is provided, tio will exit if the device is not present or an established connection is lost.
latest Automatically connect to latest registered serial device.
direct Connect directly to specified TTY device.
All the listed strategies automatically reconnects according to strategy if device is not available or connection is lost.
Default value is "direct".
--exclude-devices <pattern>
Exclude devices by pattern ('*' and '?' supported).
--exclude-drivers <pattern>
Exclude drivers by pattern ('*' and '?' supported).
--exclude-tids <pattern>
Exclude topology IDs by pattern ('*' and '?' supported).
-n, --no-reconnect
Do not reconnect.
This means that tio will exit if it fails to connect to device or an established connection is lost.
-e, --local-echo
@ -92,11 +116,19 @@ OPTIONS
Default format is 24hour
-L, --list-devices
--timestamp-timeout <ms>
List available serial devices by ID.
Set timestamp timeout value in milliseconds.
-l, --log
This value only takes effect in hex output mode where timestamps are only printed after elapsed timeout time of no output activity from tty device.
Default value is 200.
-l, --list
List available serial devices.
-L, --log
Enable log to file.
@ -148,9 +180,15 @@ OPTIONS
If defining more than one flag, the flags must be comma separated.
--input-mode normal|hex
--input-mode normal|hex|line
Set input mode. In hex input mode bytes can be sent by typing the two-character hexadecimal representation of the 1 byte value, e.g.: to send 0xA you must type 0a or 0A.
Set input mode.
In normal mode input characters are sent immediately as they are typed.
In hex input mode bytes can be sent by typing the two-character hexadecimal representation of the 1 byte value, e.g.: to send 0xA you must type 0a or 0A.
In line input mode input characters are sent when you press enter. The only editing feature supported in this mode is backspace.
Default value is "normal".
@ -216,6 +254,10 @@ OPTIONS
Default value is "none".
--mute
Mute tio messages.
--script <string>
Run script from string.
@ -293,6 +335,10 @@ SCRIPT API
expect(string, timeout)
Expect string - waits for string to match or timeout before continueing. Supports regular expressions. Special characters must be escaped with '\\'. Timeout is in milliseconds, defaults to 0 meaning it will wait forever.
Returns 1 on successful match, 0 on timeout, or -1 on invalid regular expression.
On successful match it also returns the match string as second return value.
send(string)
Send string.
@ -301,6 +347,13 @@ SCRIPT API
Protocol can be any of XMODEM_1K, XMODEM_CRC, YMODEM.
tty_search()
Search for serial devices.
Returns a table of number indexed tables, one for each serial device found. Each of these tables contains the serial device information accessible via the following string indexed elements "path", "tid", "uptime", "driver", "description".
Returns nil if no serial devices are found.
exit(code)
Exit with exit code.
@ -369,7 +422,7 @@ CONFIGURATION FILE
line-pulse-duration Set line pulse duration
no-autoconnect Disable automatic connect
no-reconnect Do not reconnect
log Enable log to file
@ -387,13 +440,15 @@ CONFIGURATION FILE
timestamp-format Set timestamp format
timestamp-timeout Set timestamp timeout
map Map characters on input or output
color Colorize tio text using ANSI color code ranging from 0 to 255
input-mode Set input mode.
input-mode Set input mode
output-mode Set output mode.
output-mode Set output mode
socket Set socket to redirect I/O to
@ -405,11 +460,13 @@ CONFIGURATION FILE
alert Set alert action on connect/disconnect
mute Mute tio messages
script Run script from string
script-file Run script from file
script-run Run script on connect.
script-run Run script on connect
CONFIGURATION FILE EXAMPLES
To change the default configuration simply set options like so:
@ -530,6 +587,6 @@ WEBSITE
Visit https://tio.github.io
AUTHOR
Created by Martin Lund <martin.lund@keep-it-simple.com>.
Maintained by Martin Lund <martin.lund@keep-it-simple.com>.
tio 2.8 2023-09-19 tio(1)
tio 2.9 2024-04-14 tio(1)