HIDAPI Bindings for Go

Package hid provides an idiomatic interface to HIDAPI, a simple library for communicating with USB and Bluetooth HID devices on Linux, Mac, and Windows.

See https://github.com/signal11/hidapi for details.

Documentation

Up-to-date documentation can be found on GoDoc, or by issuing the go doc command after installing the package:

$ go doc -all github.com/sstallion/go-hid

Installation

Package hid may be installed using one of two methods:

1. Via the go get command, which dynamically links against the system HIDAPI installation. This method requires HIDAPI be installed using a system package (eg. hidapi-devel) and headers are available. In practice, this works well for Linux and Mac, but can cause issues on Windows where HIDAPI is not commonly packaged:

   $ go get github.com/sstallion/go-hid
   

2. Use the provided Makefile to statically link against a vendored copy of HIDAPI (commit a6a622f). This method works for all supported OSes and is the suggested method if installing on Windows:

   $ go get -d github.com/sstallion/go-hid
   $ cd $GOPATH/src/github.com/sstallion/go-hid
   $ make all
   $ make install
   

Note: The prerequisites for HIDAPI must also be installed regardless of the method chosen above. See the HIDAPI README for details.

lshid

An example command named lshid is provided, which displays information about HID devices attached to the system. lshid may be installed by issuing:

$ go get github.com/sstallion/go-hid/cmd/lshid

Once installed, issue lshid -h to display usage.

Contributing

Pull requests are welcome! If a problem is encountered using this package, please file an issue on GitHub.

License

Source code in this repository is licensed under a Simplified BSD License. See LICENSE for more details.