The cl-k8055 Reference Manual

Table of Contents

The cl-k8055 Reference Manual

This is the cl-k8055 Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 12:21:32 2020 GMT+0.

1 Introduction

About cl-k8055d

Interface for the Velleman K8055 USB kit through the K8055 linux driver. The driver library is included for x86-64 and ARM.

How To

First you will need to install the udev rules into your system in order to be able to connect to and use the Velleman device from a standard user account without administrator privileges. To do so, copy the velleman.rules file to /etc/udev/rules.d/. You may need to restart your system in order for the rules to take effect.

Connect to the board/s.

(k8055:connect)

Read out or set some values to the inputs/outputs.

;; Inputs
(k8055:digital 0)
(k8055:analog 0)
(k8055:analogf 0)
(k8055:analogv 0)
;; Outputs
(setf (k8055:digital 1) T)
(setf (k8055:analog 0) 120)
(setf (k8055:analogf 0) 0.25)
(setf (k8055:analogv 0) 5.0)
;; Counters
(k8055:counter 0)
(k8055:reset-counter 0)

If the voltage mapping that is provided by default (4.7V for outputs, 10V for inputs) is not correct, you can adjust it with the voltage accessor.

Once you're done, you should probably disconnect again.

(k8055:disconnect)

2 Systems

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

2.1 cl-k8055

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://Shinmera.github.io/cl-k8055/

Source Control

(:git "https://github.com/shinmera/cl-k8055.git")

Bug Tracker

https://github.com/Shinmera/cl-k8055/issues

License

zlib

Description

Bindings to the k8055 DAQ hobby board.

Version

1.0.0

Dependencies

• cffi
• cl-ppcre
• trivial-features
• documentation-utils

Source

cl-k8055.asd (file)

Components

• package.lisp (file)
• low-level.lisp (file)
• wrapper.lisp (file)
• documentation.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-k8055.asd

Location

cl-k8055.asd

Systems

cl-k8055 (system)

3.1.2 cl-k8055/package.lisp

Parent

cl-k8055 (system)

Location

package.lisp

Packages

• cl-k8055
• cl-k8055-cffi

3.1.3 cl-k8055/low-level.lisp

Dependency

package.lisp (file)

Parent

cl-k8055 (system)

Location

low-level.lisp

Exported Definitions

• *static* (special variable)
• clear-all-analog (function)
• clear-all-digital (function)
• clear-analog-channel (function)
• clear-digital-channel (function)
• close-device (function)
• open-device (function)
• output-all-analog (function)
• output-analog-channel (function)
• read-all-analog (function)
• read-all-digital (function)
• read-all-values (function)
• read-analog-channel (function)
• read-counter (function)
• read-digital-channel (function)
• reset-counter (function)
• search-devices (function)
• set-all-analog (function)
• set-all-digital (function)
• set-all-values (function)
• set-analog-channel (function)
• set-counter-debounce-time (function)
• set-current-device (function)
• set-digital-channel (function)
• version (function)
• write-all-digital (function)

Internal Definitions

• *here* (special variable)
• define-cfun (macro)

3.1.4 cl-k8055/wrapper.lisp

Dependency

low-level.lisp (file)

Parent

cl-k8055 (system)

Location

wrapper.lisp

Exported Definitions

• *default-max-attempts* (special variable)
• analog (function)
• (setf analog) (function)
• analogf (function)
• (setf analogf) (function)
• analogv (function)
• (setf analogv) (function)
• connect (function)
• counter (function)
• (setf counter-debounce-time) (function)
• digital (function)
• (setf digital) (function)
• disconnect (function)
• reset-counter (function)
• voltage (function)
• (setf voltage) (function)

Internal Definitions

• *voltage-map* (special variable)
• call-with-positive-return (function)
• with-positive-return (macro)

3.1.5 cl-k8055/documentation.lisp

Dependency

wrapper.lisp (file)

Parent

cl-k8055 (system)

Location

documentation.lisp

4 Packages

Packages are listed by definition order.

4.1 cl-k8055

Source

package.lisp (file)

Nicknames

• org.shirakumo.k8055
• k8055

Use List

common-lisp

Exported Definitions

• *default-max-attempts* (special variable)
• analog (function)
• (setf analog) (function)
• analogf (function)
• (setf analogf) (function)
• analogv (function)
• (setf analogv) (function)
• connect (function)
• counter (function)
• (setf counter-debounce-time) (function)
• digital (function)
• (setf digital) (function)
• disconnect (function)
• reset-counter (function)
• voltage (function)
• (setf voltage) (function)

Internal Definitions

• *voltage-map* (special variable)
• call-with-positive-return (function)
• with-positive-return (macro)

4.2 cl-k8055-cffi

Source

package.lisp (file)

Nickname

org.shirakumo.k8055.cffi

Use List

• cffi
• common-lisp

Exported Definitions

• *static* (special variable)
• clear-all-analog (function)
• clear-all-digital (function)
• clear-analog-channel (function)
• clear-digital-channel (function)
• close-device (function)
• open-device (function)
• output-all-analog (function)
• output-analog-channel (function)
• read-all-analog (function)
• read-all-digital (function)
• read-all-values (function)
• read-analog-channel (function)
• read-counter (function)
• read-digital-channel (function)
• reset-counter (function)
• search-devices (function)
• set-all-analog (function)
• set-all-digital (function)
• set-all-values (function)
• set-analog-channel (function)
• set-counter-debounce-time (function)
• set-current-device (function)
• set-digital-channel (function)
• version (function)
• write-all-digital (function)

Internal Definitions

• *here* (special variable)
• define-cfun (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *default-max-attempts*

The default maximum number of retries for a request to the board.

Package

cl-k8055

Source

wrapper.lisp (file)

Special Variable: *static*

Pathname pointing to the static/ directory in the source tree.

See *HERE*

Package

cl-k8055-cffi

Source

low-level.lisp (file)

5.1.2 Functions

Function: analog CHANNEL

Accessor to the analog inputs and outputs.

The values should be integers, which will be truncated to the range [0,255].
The channel must be an integer in [1,2].

Package

cl-k8055

Source

wrapper.lisp (file)

Writer

(setf analog) (function)

Function: (setf analog) VALUE CHANNEL

Package

cl-k8055

Source

wrapper.lisp (file)

Reader

analog (function)

Function: analogf CHANNEL

Accessor to the analog inputs and outputs.

The values should be floats, truncated to the range [0,1].

See ANALOG

Package

cl-k8055

Source

wrapper.lisp (file)

Writer

(setf analogf) (function)

Function: (setf analogf) VALUE CHANNEL

Package

cl-k8055

Source

wrapper.lisp (file)

Reader

analogf (function)

Function: analogv CHANNEL

Accessor to the analog inputs and outputs.

The values should be voltage floats, truncated to the respective input/output voltages.

See VOLTAGE
See ANALOGF

Package

cl-k8055

Source

wrapper.lisp (file)

Writer

(setf analogv) (function)

Function: (setf analogv) VALUE CHANNEL

Package

cl-k8055

Source

wrapper.lisp (file)

Reader

analogv (function)

Function: clear-all-analog ()

Set the output value of both analog channels to 0.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: clear-all-digital ()

Turn off all digital channels.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: clear-analog-channel CHANNEL

Set the output value of an analog channel to 0.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: clear-digital-channel CHANNEL

Turn off a digital channel.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: close-device ()

Close the opened device.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: connect ()

Attempt to connect to both devices.

Signals an error if it was unsuccessful.

Package

cl-k8055

Source

wrapper.lisp (file)

Function: counter COUNTER

Reads the value of a counter.

Package

cl-k8055

Source

wrapper.lisp (file)

Function: (setf counter-debounce-time) VALUE COUNTER

Sets the debounce time of a counter.

Package

cl-k8055

Source

wrapper.lisp (file)

Function: digital CHANNEL

Accessor to the digital inputs and outputs.

The values should be booleans.
The channel must be an integer in [1,8].

Package

cl-k8055

Source

wrapper.lisp (file)

Writer

(setf digital) (function)

Function: (setf digital) VALUE CHANNEL

Package

cl-k8055

Source

wrapper.lisp (file)

Reader

digital (function)

Function: disconnect ()

Disconnect from the devices.

Package

cl-k8055

Source

wrapper.lisp (file)

Function: open-device CARD-ADDRESS

Open the devices at the specified addresses. Card-addresses should be a two-bit mask.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: output-all-analog DATA1 DATA2

Set the output values of both analog channels.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: output-analog-channel CHANNEL DATA

Set the output value of an analog channel.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: read-all-analog DATA1 DATA2

Read both analog channels at once.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: read-all-digital ()

Read the values of all digital channels.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: read-all-values DATA1 DATA2 DATA3 DATA4 DATA5

Read all inputs on the board at once.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: read-analog-channel CHANNEL

Read the value from an analog channel.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: read-counter COUNTER-NR

Read the value of a counter.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: read-digital-channel CHANNEL

Read the value of a digital channel.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: reset-counter COUNTER

Resets a counter.

Package

cl-k8055

Source

wrapper.lisp (file)

Function: reset-counter COUNTER-NR

Reset a counter.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: search-devices ()

Return a two bit mask of the available devices on the system.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: set-all-analog ()

Set the output value of both analog channels to 255.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: set-all-digital ()

Turn on all digital channels.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: set-all-values DIGITAL ANALOG1 ANALOG2

Set all outpouts on the board at once.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: set-analog-channel CHANNEL

Set the output value of an analog channel to 255.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: set-counter-debounce-time COUNTER-NR DEBOUNCE-TIME

Set the debouncing time of a counter to a specific value.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: set-current-device LNG-CARD-ADDRESS

Change the current device address.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: set-digital-channel CHANNEL

Turn on a digital channel.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: version ()

Return the library version.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Function: voltage DIRECTION CHANNEL

Accessor to the voltage maps for the analog ouputs and inputs.

Direction should be one of :IN :OUT, and the value a
float designating the upper-bound voltage number.

See *VOLTAGE-MAP*

Package

cl-k8055

Source

wrapper.lisp (file)

Writer

(setf voltage) (function)

Function: (setf voltage) VALUE DIRECTION CHANNEL

Package

cl-k8055

Source

wrapper.lisp (file)

Reader

voltage (function)

Function: write-all-digital DATA

Write all the digital outputs at once. Should be a bitmask.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *here*

Pathname pointing to the low-level.lisp file.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Special Variable: *voltage-map*

A map of voltages for the analog inputs/outputs.

Package

cl-k8055

Source

wrapper.lisp (file)

5.2.2 Macros

Macro: define-cfun NAME RETURN &body ARGS

Convenience wrapper for our C function definitions.

Sets the proper library, converts the name automatically, and sets the convention to :stdcall as required by the lib.

Package

cl-k8055-cffi

Source

low-level.lisp (file)

Macro: with-positive-return (&optional MAX-ATTEMPTS) &body BODY

Convenience wrapper around CALL-WITH-POSITIVE-RETURN, ensuring that the body returns a positive value.

See CALL-WITH-POSITIVE-RETURN

Package

cl-k8055

Source

wrapper.lisp (file)

5.2.3 Functions

Function: call-with-positive-return FUNCTION &optional MAX-ATTEMPTS

Retries calling the function until it returns a positive value.

If MAX-ATTEMPTS is exceeded, an error is signalled.

See *DEFAULT-MAX-ATTEMPTS*

Package

cl-k8055

Source

wrapper.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types