README

Introduction

Travis Build Status AppVeyor Build Status GoDoc

The gousb package is an attempt at wrapping the libusb library into a Go-like binding in a fully self-contained, go-gettable package. Supported platforms include Linux, macOS and Windows as well as the mobile platforms Android and iOS.

This package is a fork of github.com/kylelemons/gousb, which at the moment seems to be unmaintained. The current fork is different from the upstream package as it contains code to embed libusb directly into the Go package (thus becoming fully self-cotnained and go-gettable), as well as it features a few contributions and bugfixes that never really got addressed in the upstream package, but which address important issues nonetheless.

Note, if @kylelemons decides to pick development of the upstream project up again, consider all commits made by me to this repo as ready contributions. I cannot vouch for other commits as the upstream repo needs a signed CLA for Google.

Installation

Example: lsusb

The gousb project provides a simple but useful example: lsusb. This binary will list the USB devices connected to your system and various interesting tidbits about them, their configurations, endpoints, etc. To install it, run the following command:

go get -v github.com/karalabe/gousb/lsusb

gousb

If you installed the lsusb example, both libraries below are already installed.

Installing the primary gousb package is really easy:

go get -v github.com/karalabe/gousb/usb

There is also a usbid package that will not be installed by default by this command, but which provides useful information including the human-readable vendor and product codes for detected hardware. It's not installed by default and not linked into the usb package by default because it adds ~400kb to the resulting binary. If you want both, they can be installed thus:

go get -v github.com/karalabe/gousb/usb{,id}

Documentation

The documentation can be viewed via local godoc or via the excellent godoc.org:

Expand ▾ Collapse ▴

Directories

Path Synopsis
lsusb lists attached USB devices.
lsusb lists attached USB devices.
rawread attempts to read from the specified USB device.
rawread attempts to read from the specified USB device.
Package usb provides a wrapper around libusb-1.0.
Package usb provides a wrapper around libusb-1.0.
Package usbid provides human-readable text output for the usb package.
Package usbid provides human-readable text output for the usb package.