https://github.com/basvandijk/usb

Communicate with USB devices
https://github.com/basvandijk/usb

haskell usb

Last synced: 2 months ago
JSON representation

Communicate with USB devices

• Host: GitHub
• URL: https://github.com/basvandijk/usb
• Owner: basvandijk
• License: other
• Created: 2011-04-17T16:11:43.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2018-04-01T00:01:10.000Z (over 6 years ago)
• Last Synced: 2024-10-11T23:43:59.006Z (3 months ago)
• Topics: haskell, usb
• Language: Haskell
• Homepage:
• Size: 710 KB
• Stars: 27
• Watchers: 9
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown
  • Changelog: Changelog
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Hackage](https://img.shields.io/hackage/v/usb.svg)](https://hackage.haskell.org/package/usb)

[![Build Status](https://travis-ci.org/basvandijk/usb.svg)](https://travis-ci.org/basvandijk/usb)

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][USB-2.0-spec].

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:

* [The libusb 1.0 documentation](http://libusb.sourceforge.net/api-1.0/)

* [The USB 2.0 specification][USB-2.0-spec]

* [The `bindings-libusb` documentation][bindings-libusb]

* ["USB in a NutShell"](http://www.beyondlogic.org/usbnutshell/usb1.htm)

[bindings-libusb]: http://hackage.haskell.org/package/bindings-libusb

[usb-example]:     https://github.com/basvandijk/usb-example

[ls-usb]:          http://hackage.haskell.org/package/ls-usb

[usb-safe]:        http://hackage.haskell.org/package/usb-safe

[usb-iteratee]:    http://hackage.haskell.org/package/usb-iteratee

[libusb-1.*]:      http://libusb.org/wiki/libusb-1.0

[USB-2.0-spec]:    http://www.usb.org/developers/docs/