https://github.com/TeMPOraL/cl-wiringpi2

CFFI bindings to WiringPi 2 for Common Lisp.
https://github.com/TeMPOraL/cl-wiringpi2

common-lisp raspberry-pi wiringpi

Last synced: 3 months ago
JSON representation

CFFI bindings to WiringPi 2 for Common Lisp.

• Host: GitHub
• URL: https://github.com/TeMPOraL/cl-wiringpi2
• Owner: TeMPOraL
• License: mit
• Created: 2016-04-16T18:54:12.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-11-05T21:30:09.000Z (about 8 years ago)
• Last Synced: 2024-10-13T10:38:17.844Z (4 months ago)
• Topics: common-lisp, raspberry-pi, wiringpi
• Language: Common Lisp
• Homepage:
• Size: 25.4 KB
• Stars: 12
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
#+title: CL-WIRINGPI2 - CFFI bindings to WiringPi 2.

A set of lispified bindings to [[http://wiringpi.com/][Wiring Pi 2]] - a popular library for controlling GPIOs

on Raspberry Pi.

The project intention is to provide a Lisp-friendly version of Wiring Pi 2. That means

the library's primary API does not correspond 1 to 1 with Wiring Pi 2. Changes have been made

to make it follow the Lisp style of things.

Note that the [[https://common-lisp.net/project/cffi/][CFFI]] bindings themselves have been separated to another

package (cl-wiringpi2-ffi); you can use them instead if you prefer the

original flavour of the library.

* Installation

The simplest way is via QuickLisp. Clone the repo somewhere, and then symlink that folder

in ~/quicklisp/local-projects/. Inside your Lisp run =(ql:register-local-projects)=.

cl-wiringpi2 should now show on the list outputed by =(ql:list-local-projects)=.

Then, just execute =(ql:quickload :cl-wiringpi2)= and you're good to go.

Note that for most functions, Wiring Pi 2 requires to run with superuser privileges. It means

your Lisp image will have to be started as such. For example, I run my CCL with:

#+BEGIN_SRC sh

  sudo -E /path/to/ccl/armcl

#+END_SRC

-E ensures that the environmental variables of your user are retained, so you don't have

to set up separate init file and QuickLisp for the root user.

* Status

See the package.lisp file in the main folder for the list of exported symbols.

Those are the functions that currently should work.

At the moment the bindings are only to the main Wiring Pi 2 functions, i.e. those

contained in the wiringPi.h header.

* Documentation

Currently the documentation is available in docstrings of functions in the source files.

Consult the [[http://wiringpi.com/reference/][Wiring Pi 2 official documentation]]; most available functions match the originals by name

(albeit a bit lispified).

There is an API reference autogenerated by [[https://bitbucket.org/eeeickythump/clod][CLOD]] in [[file:docs/][docs/]] folder.

- [[file:docs/cl-wiringpi2.org][cl-wiringpi2]]

- [[file:docs/cl-wiringpi2-ffi.org][cl-wiringpi2-ffi]]

- [[file:docs/cl-wiringpi2-examples.org][cl-wiringpi2-examples]]

* Examples

Examples are contained in cl-wiringpi2-examples system / package.

A simple blink example is available. More to come.

To run blink, connect an LED and a 330Ω resistor to the GPIO 0 (physical pin: 11),

like on [[http://wiringpi.com/examples/blink/][this image]], and execute:

#+BEGIN_SRC lisp

  (wpi2-examples:blink)

#+END_SRC

* Testing

The library hasn't been tested very much. The bindings are pretty straightforward though, so there shouldn't be surprises.

Present API seems to work, but please report any issues.

* Support

Bug reports and pull requests always welcome :).

* Credits

I did take a quick peek at the [[https://github.com/jl2/wpi][bindings to Wiring Pi by Jeremiah LaRocco]].