Skip to content
This repository

Communicate with USB devices

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 System
Octocat-spinner-32 Event.hs
Octocat-spinner-32 LICENSE
Octocat-spinner-32 NEWS
Octocat-spinner-32 Poll.hsc
Octocat-spinner-32 README.markdown
Octocat-spinner-32 Setup.hs
Octocat-spinner-32 SystemEventManager.hs
Octocat-spinner-32 Timeval.hs
Octocat-spinner-32 Utils.hs
Octocat-spinner-32 usb.cabal
README.markdown

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:

Something went wrong with that request. Please try again.