The cserial-port Reference Manual

Table of Contents

The cserial-port Reference Manual

This is the cserial-port Reference Manual, version 0.0.3, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:47:24 2021 GMT+0.

1 Introduction

cserial-port

Common Lisp library for interacting with serial ports.

Usage

(with-serial (rs1 1)
  (write-serial-byte-vector
    (babel:string-to-octets "Hello")
    rs1))

;; Interacting with 2 serial ports.
(with-serial (rs2 2)
  (with-serial (rs1 1)

    (write-serial-byte-vector
      (babel:string-to-octets "こんにちは。")
      rs1)

    (let ((res (make-array 18 :element-type '(unsigned-byte 8))))
      (read-serial-sequence res rs2))))

;; Using a gray-stream interface
(with-serial (rs1 1)
  (let ((stream (make-serial-stream rs1)))
    ;; Allow to use write/read-sequence.
    (write-sequence
      ;; Sending 'Hi'
      (make-array 2 :element-type '(unsigned-byte 8) :initial-contents '(72 105))
      stream)))

;; Using a timeout
(with-serial (rs1 1)
  (handler-case
      (write-serial-byte-vector
        (babel:string-to-octets "Hello")
        rs1
        :timeout-ms 500)
    (timeout-error ()
      (error "The request timed out."))))

;; Using timeout with gray-stream interface
(with-serial (rs1 1)
  (let ((stream (make-serial-stream rs1)))
    (handler-case
        (with-timeout (500) ;; ms
         ...)
      (timeout-error ()
        (error "The request timed out

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cserial-port

Author

Masatoshi SANO <snmsts@gmail.com>

License

MIT

Description

library for serial communication inspired by lispworks’ serial-port

Version

0.0.3

Defsystem Dependency

cffi-grovel

Dependencies

• trivial-features
• trivial-gray-streams
• cffi
• cffi-grovel
• osicat

Source

cserial-port.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cserial-port/src

Parent

cserial-port (system)

Location

src/

Components

• package.lisp (file)
• interfaces.lisp (file)
• ffi-types.lisp (file)
• posix.lisp (file)
• main.lisp (file)
• gray.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 cserial-port.asd

Location

cserial-port.asd

Systems

cserial-port (system)

4.1.2 cserial-port/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cserial-port

4.1.3 cserial-port/src/interfaces.lisp

Parent

src (module)

Location

src/interfaces.lisp

Exported Definitions

timeout-error (condition)

Internal Definitions

• %baud-rate (generic function)
• %baud-rate (method)
• %close (generic function)
• %close (method)
• %data-bits (generic function)
• %data-bits (method)
• %default-name (generic function)
• %default-name (method)
• %input-available-p (generic function)
• %input-available-p (method)
• %open (generic function)
• %open (method)
• %parity (generic function)
• %parity (method)
• %read (generic function)
• %read (method)
• %set-invalid-fd (generic function)
• %set-invalid-fd (method)
• %stop-bits (generic function)
• %stop-bits (method)
• %valid-fd-p (generic function)
• %valid-fd-p (method)
• %write (generic function)
• %write (method)
• defgeneric% (macro)
• serial (class)
• serial-baud-rate (method)
• serial-data-bits (method)
• serial-encoding (method)
• serial-fd (method)
• serial-name (method)
• serial-parity (method)
• (setf serial-parity) (method)
• serial-stop-bits (method)
• (setf serial-stop-bits) (method)

4.1.4 cserial-port/src/ffi-types.lisp

Parent

src (module)

Location

src/ffi-types-unix.lisp

4.1.5 cserial-port/src/posix.lisp

Parent

src (module)

Location

src/posix.lisp

Internal Definitions

• %baud-rate (method)
• %close (method)
• %data-bits (method)
• %default-name (method)
• %open (method)
• %parity (method)
• %read (method)
• %set-invalid-fd (method)
• %valid-fd-p (method)
• %write (method)
• *serial-class* (special variable)
• cfsetispeed (function)
• cfsetospeed (function)
• off (function)
• posix-serial (class)
• serial-tty (method)
• tcdrain (function)
• tcflow (function)
• tcflush (function)
• tcgetattr (function)
• tcsendbreak (function)
• tcsetattr (function)
• tcsetpgrp (function)

4.1.6 cserial-port/src/main.lisp

Parent

src (module)

Location

src/main.lisp

Exported Definitions

• 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)

Internal Definitions

• *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)

4.1.7 cserial-port/src/gray.lisp

Parent

src (module)

Location

src/gray.lisp

Exported Definitions

• make-serial-stream (function)
• serial-stream (class)

Internal Definitions

stream-serial (method)

5 Packages

Packages are listed by definition order.

5.1 cserial-port

Source

package.lisp (file)

Use List

• trivial-gray-streams
• common-lisp

Exported Definitions

• 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)

Internal Definitions

• %baud-rate (generic function)
• %baud-rate (method)
• %baud-rate (method)
• %close (generic function)
• %close (method)
• %close (method)
• %data-bits (generic function)
• %data-bits (method)
• %data-bits (method)
• %default-name (generic function)
• %default-name (method)
• %default-name (method)
• %input-available-p (generic function)
• %input-available-p (method)
• %open (generic function)
• %open (method)
• %open (method)
• %parity (generic function)
• %parity (method)
• %parity (method)
• %read (generic function)
• %read (method)
• %read (method)
• %set-invalid-fd (generic function)
• %set-invalid-fd (method)
• %set-invalid-fd (method)
• %stop-bits (generic function)
• %stop-bits (method)
• %valid-fd-p (generic function)
• %valid-fd-p (method)
• %valid-fd-p (method)
• %write (generic function)
• %write (method)
• %write (method)
• *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)
• b0 (constant)
• b110 (constant)
• b115200 (constant)
• b1200 (constant)
• b134 (constant)
• b150 (constant)
• b1800 (constant)
• b19200 (constant)
• b200 (constant)
• b2400 (constant)
• b300 (constant)
• b38400 (constant)
• b4800 (constant)
• b50 (constant)
• b57600 (constant)
• b600 (constant)
• b75 (constant)
• b9600 (constant)
• brkint (constant)
• cfsetispeed (function)
• cfsetospeed (function)
• clocal (constant)
• cread (constant)
• cs5 (constant)
• cs6 (constant)
• cs7 (constant)
• cs8 (constant)
• csize (constant)
• cstopb (constant)
• defgeneric% (macro)
• echo (constant)
• echoe (constant)
• echok (constant)
• echonl (constant)
• hupcl (constant)
• icanon (constant)
• icrnl (constant)
• iexten (constant)
• ignbrk (constant)
• igncr (constant)
• ignpar (constant)
• inlcr (constant)
• inpck (constant)
• isig (constant)
• istrip (constant)
• ixany (constant)
• ixoff (constant)
• ixon (constant)
• nccs (constant)
• noflsh (constant)
• ocrnl (constant)
• off (function)
• ofill (constant)
• onlcr (constant)
• onlret (constant)
• onocr (constant)
• opost (constant)
• parenb (constant)
• parmrk (constant)
• parodd (constant)
• posix-serial (class)
• serial (class)
• serial-baud-rate (generic function)
• serial-baud-rate (method)
• serial-data-bits (generic function)
• serial-data-bits (method)
• serial-encoding (generic function)
• serial-encoding (method)
• serial-fd (generic function)
• serial-fd (method)
• serial-name (generic function)
• serial-name (method)
• serial-parity (generic function)
• serial-parity (method)
• (setf serial-parity) (method)
• (setf serial-parity) (generic function)
• serial-stop-bits (generic function)
• serial-stop-bits (method)
• (setf serial-stop-bits) (method)
• (setf serial-stop-bits) (generic function)
• serial-tty (generic function)
• serial-tty (method)
• size-of-cc-t (constant)
• size-of-pid-t (constant)
• size-of-speed-t (constant)
• size-of-tcflag-t (constant)
• size-of-termios (constant)
• stream-serial (generic function)
• stream-serial (method)
• tcdrain (function)
• tcflow (function)
• tcflush (function)
• tcgetattr (function)
• tcsadrain (constant)
• tcsaflush (constant)
• tcsanow (constant)
• tcsendbreak (function)
• tcsetattr (function)
• tcsetpgrp (function)
• termios-tclass (class)
• tostop (constant)
• veof (constant)
• veol (constant)
• verase (constant)
• vintr (constant)
• vkill (constant)
• vmin (constant)
• vquit (constant)
• vstart (constant)
• vstop (constant)
• vsusp (constant)
• vtime (constant)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Macros

Macro: with-serial (SERIAL NAME &rest PARAMS) &body BODY

Package

cserial-port

Source

main.lisp (file)

Macro: with-timeout (MS) &body BODY

Package

cserial-port

Source

main.lisp (file)

6.1.2 Functions

Function: close-serial SERIAL

Closes a serial port

Package

cserial-port

Source

main.lisp (file)

Function: get-serial-state SERIAL KEYS

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 .

Package

cserial-port

Source

main.lisp (file)

Function: make-serial-stream SERIAL

Package

cserial-port

Source

gray.lisp (file)

Function: open-serial &optional NAME &rest ARGS &key BAUD-RATE ENCODING DATA-BITS STOP-BITS PARITY CTS-FLOW-P DSR-FLOW-P DTR RTS READ-INTERVAL-TIMEOUT READ-TOTAL-BASE-TIMEOUT READ-TOTAL-BYTE-TIMEOUT WRITE-TOTAL-BASE-TIMEOUT WRITE-TOTAL-BYTE-TIMEOUT

Attempts to open the named serial port and return a serial object.

Package

cserial-port

Source

main.lisp (file)

Function: read-serial-byte SERIAL &key TIMEOUT-MS

Reads a byte from a serial port. will return byte.

Package

cserial-port

Source

main.lisp (file)

Function: read-serial-byte-vector BUF SERIAL &key TIMEOUT-MS START END

Reads a byte from a serial port. will return count-read-bytes or nil when timeout.

Package

cserial-port

Source

main.lisp (file)

Function: read-serial-char SERIAL &key TIMEOUT-MS

Reads a character from a serial port. will return a character.

Package

cserial-port

Source

main.lisp (file)

Function: read-serial-string STRING SERIAL &key TIMEOUT-MS START END

Reads a string from a serial port.

Package

cserial-port

Source

main.lisp (file)

Function: serial-input-available-p SERIAL

Checks whether a character is available on a serial port.

Package

cserial-port

Source

main.lisp (file)

Function: set-serial-state SERIAL &key DTR RTS BREAK

Changes various aspects of the state of a serial port.

Package

cserial-port

Source

main.lisp (file)

Function: wait-serial-state SERIAL KEYS &key TIMEOUT-MS

Waits for some aspect of the state of a serial port to change.

Package

cserial-port

Source

main.lisp (file)

Function: write-serial-byte BYTE SERIAL &key TIMEOUT-MS

Writes a byte to a serial port. will return written byte.

Package

cserial-port

Source

main.lisp (file)

Function: write-serial-byte-vector BYTES SERIAL &key TIMEOUT-MS START END

Writes bytes to a serial port. will return written-bytes count.

Package

cserial-port

Source

main.lisp (file)

Function: write-serial-char CHAR SERIAL &key TIMEOUT-MS

Writes a character to a serial port. will return written char.

Package

cserial-port

Source

main.lisp (file)

Function: write-serial-string STRING SERIAL &key TIMEOUT-MS START END

Writes a string to a serial port. will return written-bytes count.

Package

cserial-port

Source

main.lisp (file)

6.1.3 Conditions

Condition: timeout-error ()

An error signaled when the duration specified in the [with-timeout][] is exceeded.

Package

cserial-port

Source

interfaces.lisp (file)

Direct superclasses

error (condition)

6.1.4 Classes

Class: serial-stream ()

Package

cserial-port

Source

gray.lisp (file)

Direct superclasses

• fundamental-binary-stream (class)
• fundamental-output-stream (class)
• fundamental-input-stream (class)
• trivial-gray-stream-mixin (class)

Direct methods

• stream-finish-output (method)
• stream-write-sequence (method)
• stream-write-byte (method)
• stream-read-sequence (method)
• stream-read-byte (method)
• stream-element-type (method)
• stream-serial (method)

Direct slots

Slot: serial

Initargs

:serial

Readers

stream-serial (generic function)

6.2 Internal definitions

6.2.1 Constants

Constant: b0

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b110

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b115200

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b1200

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b134

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b150

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b1800

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b19200

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b200

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b2400

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b300

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b38400

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b4800

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b50

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b57600

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b600

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b75

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: b9600

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: brkint

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: clocal

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: cread

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: cs5

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: cs6

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: cs7

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: cs8

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: csize

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: cstopb

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: echo

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: echoe

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: echok

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: echonl

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: hupcl

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: icanon

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: icrnl

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: iexten

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: ignbrk

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: igncr

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: ignpar

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: inlcr

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: inpck

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: isig

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: istrip

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: ixany

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: ixoff

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: ixon

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: nccs

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: noflsh

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: ocrnl

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: ofill

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: onlcr

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: onlret

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: onocr

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: opost

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: parenb

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: parmrk

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: parodd

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: size-of-cc-t

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: size-of-pid-t

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: size-of-speed-t

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: size-of-tcflag-t

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: size-of-termios

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: tcsadrain

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: tcsaflush

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: tcsanow

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: tostop

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: veof

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: veol

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: verase

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: vintr

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: vkill

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: vmin

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: vquit

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: vstart

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: vstop

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: vsusp

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Constant: vtime

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

6.2.2 Special variables

Special Variable: *default-baud-rate*

Package

cserial-port

Source

main.lisp (file)

Special Variable: *default-data-bits*

Package

cserial-port

Source

main.lisp (file)

Special Variable: *default-encoding*

Package

cserial-port

Source

main.lisp (file)

Special Variable: *default-name*

Package

cserial-port

Source

main.lisp (file)

Special Variable: *default-parity*

Package

cserial-port

Source

main.lisp (file)

Special Variable: *default-stop-bits*

Package

cserial-port

Source

main.lisp (file)

Special Variable: *default-timeout-ms*

Package

cserial-port

Source

main.lisp (file)

Special Variable: *serial-class*

Package

cserial-port

Source

posix.lisp (file)

6.2.3 Macros

Macro: defgeneric% FNAME PARAMS &key EXPORT DOC

Package

cserial-port

Source

interfaces.lisp (file)

6.2.4 Functions

Function: cfsetispeed TERMIOS-P SPEED

Package

cserial-port

Source

posix.lisp (file)

Function: cfsetospeed TERMIOS-P SPEED

Package

cserial-port

Source

posix.lisp (file)

Function: off FLAG &rest PATTERNS

Package

cserial-port

Source

posix.lisp (file)

Function: tcdrain FD

Package

cserial-port

Source

posix.lisp (file)

Function: tcflow FD ACTION

Package

cserial-port

Source

posix.lisp (file)

Function: tcflush FD QUEUE_SELECTOR

Package

cserial-port

Source

posix.lisp (file)

Function: tcgetattr FD TERMIOS-P

Package

cserial-port

Source

posix.lisp (file)

Function: tcsendbreak FD DURATION

Package

cserial-port

Source

posix.lisp (file)

Function: tcsetattr FD OPTIONAL-ACTIONS TERMIOS-P

Package

cserial-port

Source

posix.lisp (file)

Function: tcsetpgrp FD PGRP

Package

cserial-port

Source

posix.lisp (file)

6.2.5 Generic functions

Generic Function: %baud-rate CLASS &optional BAUD-RATE

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %baud-rate (S posix-serial) &optional BAUD-RATE

Source

posix.lisp (file)

Method: %baud-rate CLASS &optional BAUD-RATE

Generic Function: %close CLASS

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %close (S posix-serial)

Source

posix.lisp (file)

Method: %close CLASS

Generic Function: %data-bits CLASS &optional DATA-BITS

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %data-bits (S posix-serial) &optional DATA-BITS

Source

posix.lisp (file)

Method: %data-bits CLASS &optional DATA-BITS

Generic Function: %default-name CLASS &optional NUMBER

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %default-name (S (eql posix-serial)) &optional NUMBER

Source

posix.lisp (file)

Method: %default-name CLASS &optional NUMBER

Generic Function: %input-available-p CLASS

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %input-available-p CLASS

Generic Function: %open CLASS &key NAME

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %open (S posix-serial) &key NAME

Source

posix.lisp (file)

Method: %open CLASS &key

Generic Function: %parity CLASS &optional PARITY

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %parity (S posix-serial) &optional PARITY

Source

posix.lisp (file)

Method: %parity CLASS &optional PARITY

Generic Function: %read CLASS BUFFER BUFFER-SIZE TIMEOUT-MS

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %read (S posix-serial) BUFFER BUFFER-SIZE TIMEOUT-MS

Source

posix.lisp (file)

Method: %read CLASS BUFFER BUFFER-SIZE TIMEOUT-MS

Generic Function: %set-invalid-fd CLASS

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %set-invalid-fd (S posix-serial)

Source

posix.lisp (file)

Method: %set-invalid-fd CLASS

Generic Function: %stop-bits CLASS &optional STOP-BITS

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %stop-bits CLASS &optional STOP-BITS

Generic Function: %valid-fd-p CLASS

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %valid-fd-p (S posix-serial)

Source

posix.lisp (file)

Method: %valid-fd-p CLASS

Generic Function: %write CLASS BUFFER WRITE-SIZE TIMEOUT-MS

Package

cserial-port

Source

interfaces.lisp (file)

Methods

Method: %write (S posix-serial) BUFFER WRITE-SIZE TIMEOUT-MS

Source

posix.lisp (file)

Method: %write CLASS BUFFER WRITE-SIZE TIMEOUT-MS

Generic Function: serial-baud-rate OBJECT

Package

cserial-port

Methods

Method: serial-baud-rate (SERIAL serial)

baud-rate

Source

interfaces.lisp (file)

Generic Function: serial-data-bits OBJECT

Package

cserial-port

Methods

Method: serial-data-bits (SERIAL serial)

Number of data-bits.

Source

interfaces.lisp (file)

Generic Function: serial-encoding OBJECT

Package

cserial-port

Methods

Method: serial-encoding (SERIAL serial)

encoding

Source

interfaces.lisp (file)

Generic Function: serial-fd OBJECT

Package

cserial-port

Methods

Method: serial-fd (SERIAL serial)

opend handle

Source

interfaces.lisp (file)

Generic Function: serial-name OBJECT

Package

cserial-port

Methods

Method: serial-name (SERIAL serial)

Device name

Source

interfaces.lisp (file)

Generic Function: serial-parity OBJECT

Generic Function: (setf serial-parity) NEW-VALUE OBJECT

Package

cserial-port

Methods

Method: serial-parity (SERIAL serial)

Method: (setf serial-parity) NEW-VALUE (SERIAL serial)

Parity checking.

Source

interfaces.lisp (file)

Generic Function: serial-stop-bits OBJECT

Generic Function: (setf serial-stop-bits) NEW-VALUE OBJECT

Package

cserial-port

Methods

Method: serial-stop-bits (SERIAL serial)

Method: (setf serial-stop-bits) NEW-VALUE (SERIAL serial)

Number of stop-bits

Source

interfaces.lisp (file)

Generic Function: serial-tty OBJECT

Package

cserial-port

Methods

Method: serial-tty (POSIX-SERIAL posix-serial)

tty

Source

posix.lisp (file)

Generic Function: stream-serial OBJECT

Package

cserial-port

Methods

Method: stream-serial (SERIAL-STREAM serial-stream)

automatically generated reader method

Source

gray.lisp (file)

6.2.6 Classes

Class: posix-serial ()

Package

cserial-port

Source

posix.lisp (file)

Direct superclasses

serial (class)

Direct methods

• %read (method)
• %write (method)
• %open (method)
• %close (method)
• %set-invalid-fd (method)
• %valid-fd-p (method)
• %parity (method)
• %data-bits (method)
• %baud-rate (method)
• serial-tty (method)

Direct slots

Slot: tty

tty

Initargs

:tty

Readers

serial-tty (generic function)

Class: serial ()

Package

cserial-port

Source

interfaces.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

posix-serial (class)

Direct methods

• serial-parity (method)
• serial-parity (method)
• serial-stop-bits (method)
• serial-stop-bits (method)
• serial-data-bits (method)
• serial-baud-rate (method)
• serial-encoding (method)
• serial-fd (method)
• serial-name (method)

Direct slots

Slot: name

Device name

Initargs

:name

Readers

serial-name (generic function)

Slot: fd

opend handle

Initargs

:fd

Readers

serial-fd (generic function)

Slot: encoding

encoding

Initargs

:encoding

Readers

serial-encoding (generic function)

Slot: baud-rate

baud-rate

Initargs

:baud-rate

Readers

serial-baud-rate (generic function)

Slot: data-bits

Number of data-bits.

Initargs

:data-bits

Readers

serial-data-bits (generic function)

Slot: stop-bits

Number of stop-bits

Initargs

:stop-bits

Readers

serial-stop-bits (generic function)

Writers

(setf serial-stop-bits) (generic function)

Slot: parity

Parity checking.

Initargs

:parity

Readers

serial-parity (generic function)

Writers

(setf serial-parity) (generic function)

Class: termios-tclass ()

Package

cserial-port

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cserial-port-20200427-git/src/ffi-types-unix.processed-grovel-file

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables