forked from cerc-io/plugeth
42 lines
2.4 KiB
Markdown
42 lines
2.4 KiB
Markdown
|
[![GoDoc][docimg]][docurl]
|
||
|
|
|
||
|
|
[docimg]: https://godoc.org/github.com/karalabe/hid?status.svg
|
||
|
|
[docurl]: https://godoc.org/github.com/karalabe/hid
|
||
|
|
|
||
|
|
# Gopher Interface Devices (USB HID)
|
||
|
|
|
||
|
|
The `hid` package is a cross platform library for accessing and communicating with USB Human Interface
|
||
|
|
Devices (HID). It is an alternative package to [`gousb`](https://github.com/karalabe/gousb) for use
|
||
|
|
cases where devices support this ligher mode of operation (e.g. input devices, hardware crypto wallets).
|
||
|
|
|
||
|
|
The package wraps [`hidapi`](https://github.com/signal11/hidapi) for accessing OS specific USB HID APIs
|
||
|
|
directly instead of using low level USB constructs, which might have permission issues on some platforms.
|
||
|
|
On Linux the package also wraps [`libusb`](https://github.com/libusb/libusb). Both of these dependencies
|
||
|
|
are vendored directly into the repository and wrapped using CGO, making the `hid` package self-contained
|
||
|
|
and go-gettable.
|
||
|
|
|
||
|
|
Supported platforms at the moment are Linux, macOS and Windows (exclude constraints are also specified
|
||
|
|
for Android and iOS to allow smoother vendoring into cross platform projects).
|
||
|
|
|
||
|
|
## Acknowledgements
|
||
|
|
|
||
|
|
Although the `hid` package is an implementation from scratch, it was heavily inspired by the existing
|
||
|
|
[`go.hid`](https://github.com/GeertJohan/go.hid) library, which seems abandoned since 2015; is incompatible
|
||
|
|
with Go 1.6+; and has various external dependencies. Given its inspirational roots, I thought it important
|
||
|
|
to give credit to the author of said package too.
|
||
|
|
|
||
|
|
Wide character support in the `hid` package is done via the [`gowchar`](https://github.com/orofarne/gowchar)
|
||
|
|
library, unmaintained since 2013; non buildable with a modern Go release and failing `go vet` checks. As
|
||
|
|
such, `gowchar` was also vendored in inline (copyright headers and origins preserved).
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
The components of `hid` are licensed as such:
|
||
|
|
|
||
|
|
* `hidapi` is released under the [3-clause BSD](https://github.com/signal11/hidapi/blob/master/LICENSE-bsd.txt) license.
|
||
|
|
* `libusb` is released under the [GNU GPL 2.1](https://github.com/libusb/libusb/blob/master/COPYING)license.
|
||
|
|
* `go.hid` is released under the [2-clause BSD](https://github.com/GeertJohan/go.hid/blob/master/LICENSE) license.
|
||
|
|
* `gowchar` is released under the [3-clause BSD](https://github.com/orofarne/gowchar/blob/master/LICENSE) license.
|
||
|
|
|
||
|
|
Given the above, `hid` is licensed under GNU GPL 2.1 or later on Linux and 3-clause BSD on other platforms.
|