This is the cl-k8055 Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:22:17 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-k8055Bindings to the k8055 DAQ hobby board.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/cl-k8055.git)
zlib
1.0.0
cffi (system).
cl-ppcre (system).
trivial-features (system).
documentation-utils (system).
package.lisp (file).
low-level.lisp (file).
wrapper.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-k8055/cl-k8055.asdcl-k8055/package.lispcl-k8055/low-level.lispcl-k8055/wrapper.lispcl-k8055/documentation.lispcl-k8055/low-level.lisppackage.lisp (file).
cl-k8055 (system).
*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).
*here* (special variable).
define-cfun (macro).
cl-k8055/wrapper.lisplow-level.lisp (file).
cl-k8055 (system).
*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).
*voltage-map* (special variable).
call-with-positive-return (function).
with-positive-return (macro).
cl-k8055/documentation.lispwrapper.lisp (file).
cl-k8055 (system).
Packages are listed by definition order.
cl-k8055k8055
org.shirakumo.k8055
common-lisp.
*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).
*voltage-map* (special variable).
call-with-positive-return (function).
with-positive-return (macro).
cl-k8055-cffiorg.shirakumo.k8055.cffi
cffi.
common-lisp.
*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).
*here* (special variable).
define-cfun (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The default maximum number of retries for a request to the board.
Pathname pointing to the static/ directory in the source tree.
See *HERE*
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].
Accessor to the analog inputs and outputs.
The values should be floats, truncated to the range [0,1].
See ANALOG
Accessor to the analog inputs and outputs.
The values should be voltage floats, truncated to the
respective input/output voltages.
See VOLTAGE
See ANALOGF
Set the output value of both analog channels to 0.
Turn off all digital channels.
Set the output value of an analog channel to 0.
Turn off a digital channel.
Close the opened device.
Attempt to connect to both devices.
Signals an error if it was unsuccessful.
Reads the value of a counter.
Sets the debounce time of a counter.
Accessor to the digital inputs and outputs.
The values should be booleans.
The channel must be an integer in [1,8].
Disconnect from the devices.
Open the devices at the specified addresses. Card-addresses should be a two-bit mask.
Set the output values of both analog channels.
Set the output value of an analog channel.
Read both analog channels at once.
Read the values of all digital channels.
Read all inputs on the board at once.
Read the value from an analog channel.
Read the value of a counter.
Read the value of a digital channel.
Resets a counter.
Reset a counter.
Return a two bit mask of the available devices on the system.
Set the output value of both analog channels to 255.
Turn on all digital channels.
Set all outpouts on the board at once.
Set the output value of an analog channel to 255.
Set the debouncing time of a counter to a specific value.
Change the current device address.
Turn on a digital channel.
Return the library version.
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*
Write all the digital outputs at once. Should be a bitmask.
Pathname pointing to the low-level.lisp file.
A map of voltages for the analog inputs/outputs.
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.
Convenience wrapper around CALL-WITH-POSITIVE-RETURN, ensuring that the body returns a positive value.
See CALL-WITH-POSITIVE-RETURN
Retries calling the function until it returns a positive value.
If MAX-ATTEMPTS is exceeded, an error is signalled.
See *DEFAULT-MAX-ATTEMPTS*
| Jump to: | (
A C D F M O R S V W |
|---|
| Jump to: | (
A C D F M O R S V W |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | C D F L P S W |
|---|
| Jump to: | C D F L P S W |
|---|