Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-k8055 Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:26:51 2020 GMT+0.
• Introduction | What cl-k8055 is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
Interface for the Velleman K8055 USB kit through the K8055 linux driver. The driver library is included for x86-64 and ARM.
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)
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cl-k8055 system |
Nicolas Hafner <shinmera@tymoon.eu>
Nicolas Hafner <shinmera@tymoon.eu>
(:git "https://github.com/shinmera/cl-k8055.git")
zlib
Bindings to the k8055 DAQ hobby board.
1.0.0
cl-k8055.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The cl-k8055.asd file | ||
• The cl-k8055/package.lisp file | ||
• The cl-k8055/low-level.lisp file | ||
• The cl-k8055/wrapper.lisp file | ||
• The cl-k8055/documentation.lisp file |
Next: The cl-k8055/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-k8055.asd
cl-k8055 (system)
Next: The cl-k8055/low-level․lisp file, Previous: The cl-k8055․asd file, Up: Lisp files [Contents][Index]
cl-k8055 (system)
package.lisp
Next: The cl-k8055/wrapper․lisp file, Previous: The cl-k8055/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-k8055 (system)
low-level.lisp
Next: The cl-k8055/documentation․lisp file, Previous: The cl-k8055/low-level․lisp file, Up: Lisp files [Contents][Index]
low-level.lisp (file)
cl-k8055 (system)
wrapper.lisp
Previous: The cl-k8055/wrapper․lisp file, Up: Lisp files [Contents][Index]
wrapper.lisp (file)
cl-k8055 (system)
documentation.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-k8055 package | ||
• The cl-k8055-cffi package |
Next: The cl-k8055-cffi package, Previous: Packages, Up: Packages [Contents][Index]
package.lisp (file)
common-lisp
Previous: The cl-k8055 package, Up: Packages [Contents][Index]
package.lisp (file)
org.shirakumo.k8055.cffi
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported functions |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
The default maximum number of retries for a request to the board.
wrapper.lisp (file)
Pathname pointing to the static/ directory in the source tree.
See *HERE*
low-level.lisp (file)
Previous: Exported special variables, Up: Exported definitions [Contents][Index]
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].
wrapper.lisp (file)
(setf analog) (function)
wrapper.lisp (file)
analog (function)
Accessor to the analog inputs and outputs.
The values should be floats, truncated to the range [0,1].
See ANALOG
wrapper.lisp (file)
(setf analogf) (function)
wrapper.lisp (file)
analogf (function)
Accessor to the analog inputs and outputs.
The values should be voltage floats, truncated to the
respective input/output voltages.
See VOLTAGE
See ANALOGF
wrapper.lisp (file)
(setf analogv) (function)
wrapper.lisp (file)
analogv (function)
Set the output value of both analog channels to 0.
low-level.lisp (file)
Turn off all digital channels.
low-level.lisp (file)
Set the output value of an analog channel to 0.
low-level.lisp (file)
Turn off a digital channel.
low-level.lisp (file)
Close the opened device.
low-level.lisp (file)
Attempt to connect to both devices.
Signals an error if it was unsuccessful.
wrapper.lisp (file)
Reads the value of a counter.
wrapper.lisp (file)
Sets the debounce time of a counter.
wrapper.lisp (file)
Accessor to the digital inputs and outputs.
The values should be booleans.
The channel must be an integer in [1,8].
wrapper.lisp (file)
(setf digital) (function)
wrapper.lisp (file)
digital (function)
Disconnect from the devices.
wrapper.lisp (file)
Open the devices at the specified addresses. Card-addresses should be a two-bit mask.
low-level.lisp (file)
Set the output values of both analog channels.
low-level.lisp (file)
Set the output value of an analog channel.
low-level.lisp (file)
Read both analog channels at once.
low-level.lisp (file)
Read the values of all digital channels.
low-level.lisp (file)
Read all inputs on the board at once.
low-level.lisp (file)
Read the value from an analog channel.
low-level.lisp (file)
Read the value of a counter.
low-level.lisp (file)
Read the value of a digital channel.
low-level.lisp (file)
Resets a counter.
wrapper.lisp (file)
Reset a counter.
low-level.lisp (file)
Return a two bit mask of the available devices on the system.
low-level.lisp (file)
Set the output value of both analog channels to 255.
low-level.lisp (file)
Turn on all digital channels.
low-level.lisp (file)
Set all outpouts on the board at once.
low-level.lisp (file)
Set the output value of an analog channel to 255.
low-level.lisp (file)
Set the debouncing time of a counter to a specific value.
low-level.lisp (file)
Change the current device address.
low-level.lisp (file)
Turn on a digital channel.
low-level.lisp (file)
Return the library version.
low-level.lisp (file)
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*
wrapper.lisp (file)
(setf voltage) (function)
wrapper.lisp (file)
voltage (function)
Write all the digital outputs at once. Should be a bitmask.
low-level.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal macros | ||
• Internal functions |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Pathname pointing to the low-level.lisp file.
low-level.lisp (file)
A map of voltages for the analog inputs/outputs.
wrapper.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
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.
low-level.lisp (file)
Convenience wrapper around CALL-WITH-POSITIVE-RETURN, ensuring that the body returns a positive value.
See CALL-WITH-POSITIVE-RETURN
wrapper.lisp (file)
Previous: Internal macros, Up: Internal definitions [Contents][Index]
Retries calling the function until it returns a positive value.
If MAX-ATTEMPTS is exceeded, an error is signalled.
See *DEFAULT-MAX-ATTEMPTS*
wrapper.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L |
---|
Jump to: | C F L |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
A C D F M O R S V W |
---|
Jump to: | (
A C D F M O R S V W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
S |
---|
Jump to: | *
S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C P S |
---|
Jump to: | C P S |
---|