Add Lua API tio.twrite's documentation and example

This commit is contained in:
yabu76 2026-02-22 16:40:57 +09:00
parent d5b4e7d881
commit a19bf0aa44
4 changed files with 44 additions and 6 deletions

View file

@ -469,9 +469,14 @@ Returns a string on success and nil on timeout. On timeout a partially read
line may be returned as a second return value.
.IP "\fBtio.write(string)"
Write string to serial device.
Write string to serial device without Input-editing, Output-mapping nor Output-delay.
Returns the tio table.
Returns the tio table on success or nil on error.
.IP "\fBtio.twrite(string)"
Write string to serial device with Input-editing, Output-mapping and Output-delay.
Returns tio table on success or nil on error.
.IP "\fBtio.send(file, protocol)"
Send file using x/y-modem protocol.

View file

@ -381,9 +381,14 @@ SCRIPT API
On success, returns the string that was read as second return value. Also emits a single timestamp to stdout and log file per options.timestamp and options.log.
write(string)
Write string to serial device.
Write string to serial device without Input-editing, Output-mapping nor Output-delay.
Returns number of bytes written on success or -1 on error.
Returns the tio table on success or nil on error.
twrite(string)
Write string to serial device with Input-editing, Output-mapping and Output-delay.
Returns the tio table on success or nil on error.
send(file, protocol)
Send file using x/y-modem protocol.