Communicate with USB devices
Haskell Nix
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src Support GHC-8.4 Mar 31, 2018
.travis.yml Support GHC-8.4 Mar 31, 2018
Changelog Support GHC-8.4 Mar 31, 2018
LICENSE Support GHC-8.4 Mar 31, 2018
README.markdown Added hackage and travis-ci buttons to README Apr 5, 2016
default.nix Support GHC-8.4 Mar 31, 2018
usb.cabal Support GHC-8.4 Mar 31, 2018
usb.nix Support GHC-8.4 Mar 31, 2018

README.markdown

Hackage Build Status

This library enables you to communicate with USB devices from userspace. It is implemented as a high-level wrapper around bindings-libusb which is a low-level binding to the C library: libusb-1.*.

The USB transfer functions in this library have a simple synchronous interface (they block) but are implemented using the libusb asynchronous interface. They integrate with the GHC event manager making them efficient (no busy-loops) and interruptible (throwing an exception to the thread executing a transfer immediately cancels the transfer).

If the GHC event manager is not available (because you're either not using GHC or because you're on Windows) the library degrades gracefully to the libusb synchronous implementation.

The documentation assumes knowledge of how to operate USB devices from a software standpoint (descriptors, configurations, interfaces, endpoints, control/bulk/interrupt/isochronous transfers, etc). Full information can be found in the USB 2.0 Specification.

For an example how to use this library see either the usb-example or ls-usb package.

Also see the usb-safe package which wraps this package and provides some strong safety guarantees for working with USB devices.

Finally have a look at the usb-iteratee package which provides iteratee enumerators for enumerating bulk, interrupt and isochronous endpoints.

Besides the API documentation the following sources might be interesting: