Function

Summary

Reads a string from a serial port.

Package

serial-port

Signature

read-serial-port-string string serial-port &optional timeout-error-p &key start end => nread

Arguments

string

A string.

serial-port

A serial-port object.

timeout-error-p

A boolean.

start, end

Bounding index designators for string.

Values

nread

An integer.

Description

The function read-serial-port-string reads characters from the serial port associated with serial-port and places them in string, bounded by start and end.

The default values of start and end are 0 and nil (interpreted as the length of string) respectively. The number of characters requested is the difference between end and start.

If the number of characters actually read, nread, is less than the number requested, then if timeout-error-p is non-nil an error of type serial-port-timeout is signaled.

If nread is the number of characters requested, or if timeout-error-p is nil, nread is returned.

The default value of timeout-error-p is t.

See also

read-serial-port-char