This is the cserial-port Reference Manual, version 0.0.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 05:13:23 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cserial-portlibrary for serial communication inspired by lispworks’ serial-port
Masatoshi SANO <snmsts@gmail.com>
MIT
0.0.3
trivial-features (system).
cffi-grovel (system)., for feature (:not :os-windows)
trivial-features (system).
trivial-gray-streams (system).
cffi (system).
cffi-grovel (system)., for feature (:not :os-windows)
osicat (system)., for feature (:not :os-windows)
src (module).
Modules are listed depth-first from the system components tree.
cserial-port/srccserial-port (system).
package.lisp (file).
interfaces.lisp (file).
ffi-types.lisp (file).
posix.lisp (file).
win32.lisp (file).
main.lisp (file).
gray.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cserial-port/cserial-port.asdcserial-port/src/package.lispcserial-port/src/interfaces.lispcserial-port/src/ffi-types.lispcserial-port/src/posix.lispcserial-port/src/win32.lispcserial-port/src/main.lispcserial-port/src/gray.lispcserial-port/src/interfaces.lispsrc (module).
timeout-error (condition).
%baud-rate (generic function).
%close (generic function).
%data-bits (generic function).
%default-name (generic function).
%get-serial-state (generic function).
%input-available-p (generic function).
%open (generic function).
%parity (generic function).
%read (generic function).
%set-invalid-fd (generic function).
%set-serial-state (generic function).
%stop-bits (generic function).
%valid-fd-p (generic function).
%write (generic function).
defgeneric% (macro).
serial (class).
serial-baud-rate (reader method).
serial-data-bits (reader method).
serial-encoding (reader method).
serial-fd (reader method).
serial-name (reader method).
serial-parity (reader method).
(setf serial-parity) (writer method).
serial-stop-bits (reader method).
(setf serial-stop-bits) (writer method).
cserial-port/src/posix.lisp(:not :os-windows)
src (module).
%baud-rate (method).
%close (method).
%data-bits (method).
%default-name (method).
%get-serial-state (method).
%input-available-p (method).
%open (method).
%parity (method).
%read (method).
%set-invalid-fd (method).
%set-serial-state (method).
%stop-bits (method).
%valid-fd-p (method).
%write (method).
*serial-class* (special variable).
cfsetispeed (function).
cfsetospeed (function).
ioctl (function).
off (function).
posix-serial (class).
serial-tty (reader method).
tcdrain (function).
tcflow (function).
tcflush (function).
tcgetattr (function).
tcsendbreak (function).
tcsetattr (function).
tcsetpgrp (function).
cserial-port/src/main.lispsrc (module).
close-serial (function).
get-serial-state (function).
open-serial (function).
read-serial-byte (function).
read-serial-byte-vector (function).
read-serial-char (function).
read-serial-string (function).
serial-input-available-p (function).
set-serial-state (function).
wait-serial-state (function).
with-serial (macro).
with-timeout (macro).
write-serial-byte (function).
write-serial-byte-vector (function).
write-serial-char (function).
write-serial-string (function).
*default-baud-rate* (special variable).
*default-data-bits* (special variable).
*default-encoding* (special variable).
*default-name* (special variable).
*default-parity* (special variable).
*default-stop-bits* (special variable).
*default-timeout-ms* (special variable).
cserial-port/src/gray.lispsrc (module).
make-serial-stream (function).
serial-stream (class).
stream-element-type (method).
stream-listen (method).
stream-read-byte (method).
stream-read-sequence (method).
stream-write-byte (method).
stream-write-sequence (method).
stream-serial (reader method).
Packages are listed by definition order.
cserial-portcommon-lisp.
trivial-gray-streams.
close-serial (function).
get-serial-state (function).
make-serial-stream (function).
open-serial (function).
read-serial-byte (function).
read-serial-byte-vector (function).
read-serial-char (function).
read-serial-string (function).
serial-input-available-p (function).
serial-stream (class).
set-serial-state (function).
timeout-error (condition).
wait-serial-state (function).
with-serial (macro).
with-timeout (macro).
write-serial-byte (function).
write-serial-byte-vector (function).
write-serial-char (function).
write-serial-string (function).
%baud-rate (generic function).
%close (generic function).
%data-bits (generic function).
%default-name (generic function).
%get-serial-state (generic function).
%input-available-p (generic function).
%open (generic function).
%parity (generic function).
%read (generic function).
%set-invalid-fd (generic function).
%set-serial-state (generic function).
%stop-bits (generic function).
%valid-fd-p (generic function).
%write (generic function).
*default-baud-rate* (special variable).
*default-data-bits* (special variable).
*default-encoding* (special variable).
*default-name* (special variable).
*default-parity* (special variable).
*default-stop-bits* (special variable).
*default-timeout-ms* (special variable).
*serial-class* (special variable).
cfsetispeed (function).
cfsetospeed (function).
defgeneric% (macro).
ioctl (function).
off (function).
posix-serial (class).
serial (class).
serial-baud-rate (generic reader).
serial-data-bits (generic reader).
serial-encoding (generic reader).
serial-fd (generic reader).
serial-name (generic reader).
serial-parity (generic reader).
(setf serial-parity) (generic writer).
serial-stop-bits (generic reader).
(setf serial-stop-bits) (generic writer).
serial-tty (generic reader).
stream-serial (generic reader).
tcdrain (function).
tcflow (function).
tcflush (function).
tcgetattr (function).
tcsendbreak (function).
tcsetattr (function).
tcsetpgrp (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Closes a serial port
The function get-serial-state queries various aspects of the state of the serial port associated with serial .
The argument keys should be a list of one or more of the keywords :dsr and :cts . These cause get-serial-state to check the DSR and CTS lines respectively.
The result state is a list giving the state of each line in the same order as they appear in the argument keys .
Attempts to open the named serial port and return a serial object.
Reads a byte from a serial port. will return byte.
Reads a byte from a serial port. will return count-read-bytes or nil when timeout.
Reads a character from a serial port. will return a character.
Reads a string from a serial port.
Checks whether a character is available on a serial port.
Changes various aspects of the state of a serial port.
Waits for some aspect of the state of a serial port to change.
Writes a byte to a serial port. will return written byte.
Writes bytes to a serial port. will return written-bytes count.
Writes a character to a serial port. will return written char.
Writes a string to a serial port. will return written-bytes count.
serial-stream)) ¶serial-stream)) ¶sb-gray.
serial-stream)) ¶sb-gray.
serial-stream) sequence start end &key) ¶trivial-gray-streams.
serial-stream) byte) ¶sb-gray.
serial-stream) sequence start end &key) ¶trivial-gray-streams.
An error signaled when the duration specified in the [with-timeout][] is exceeded.
error.
posix-serial) &optional baud-rate) ¶posix-serial)) ¶posix-serial) &optional data-bits) ¶posix-serial) keys) ¶posix-serial)) ¶posix-serial) &key name) ¶posix-serial) &optional parity) ¶posix-serial) buffer buffer-size timeout-ms) ¶posix-serial)) ¶posix-serial) &key dtr rts break) ¶posix-serial) &optional stop-bits) ¶posix-serial)) ¶posix-serial) buffer write-size timeout-ms) ¶posix-serial)) ¶tty
tty.
serial-stream)) ¶automatically generated reader method
Device name
:name
This slot is read-only.
encoding
:encoding
This slot is read-only.
baud-rate
:baud-rate
This slot is read-only.
Number of data-bits.
:data-bits
This slot is read-only.
Number of stop-bits
:stop-bits
Parity checking.
:parity
| Jump to: | %
(
C D F G I M O R S T W |
|---|
| Jump to: | %
(
C D F G I M O R S T W |
|---|
| Jump to: | *
B C D E F N P S T |
|---|
| Jump to: | *
B C D E F N P S T |
|---|
| Jump to: | C F G I M P S T W |
|---|
| Jump to: | C F G I M P S T W |
|---|