Function

Summary

Writes a string to a serial port.

Package

serial-port

Signature

write-serial-port-string string serial-port &optional timeout-error-p &key start end => nwritten

Arguments

string

A string.

serial-port

A serial-port object.

timeout-error-p

A boolean.

start, end

Bounding index designators for string.

Values

result

The string string or nil.

Description

The function write-serial-port-string writes characters from the subsequence of string bounded by start and end to the serial port associated with serial-port.

The default values of start and end are 0 and nil (interpreted as the length of string) respectively.

If the characters are successfully written then string is returned.

A timeout will occur if the characters cannot be written before the write timeout (as specified by values given when the serial port was opened by open-serial-port).

When a timeout occurs, if timeout-error-p is non-nil, then an error of type serial-port-timeout is signaled, otherwise nil is returned. The default value of timeout-error-p is t.

See also

write-serial-port-char