usb

package
v1.10.7-0...-a4f7b57 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 1, 2021 License: GPL-3.0 Imports: 9 Imported by: 0

Documentation

Overview

Package usb provide interfaces for generic USB devices.

Index

Constants

This section is empty.

Variables

View Source
var ErrDeviceClosed = errors.New("usb: device closed")

ErrDeviceClosed is returned for operations where the device closed before or during the execution.

View Source
var ErrUnsupportedPlatform = errors.New("usb: unsupported platform")

ErrUnsupportedPlatform is returned for all operations where the underlying operating system is not supported by the library.

Functions

func Supported

func Supported() bool

Supported returns whether this platform is supported by the USB library or not. The goal of this method is to allow programatically handling platforms that do not support USB and not having to fall back to build constraints.

Types

type Device

type Device interface {
	// Close releases the USB device handle.
	Close() error

	// Write sends a binary blob to a USB device. For HID devices write uses reports,
	// for low level USB write uses interrupt transfers.
	Write(b []byte) (int, error)

	// Read retrieves a binary blob from a USB device. For HID devices read uses
	// reports, for low level USB read uses interrupt transfers.
	Read(b []byte) (int, error)
}

Device is a generic USB device interface. It may either be backed by a USB HID device or a low level raw (libusb) device.

type DeviceInfo

type DeviceInfo struct {
	Path         string // Platform-specific device path
	VendorID     uint16 // Device Vendor ID
	ProductID    uint16 // Device Product ID
	Release      uint16 // Device Release Number in binary-coded decimal, also known as Device Version Number
	Serial       string // Serial Number
	Manufacturer string // Manufacturer String
	Product      string // Product string
	UsagePage    uint16 // Usage Page for this Device/Interface (Windows/Mac only)
	Usage        uint16 // Usage for this Device/Interface (Windows/Mac only)

	// The USB interface which this logical device
	// represents. Valid on both Linux implementations
	// in all cases, and valid on the Windows implementation
	// only if the device contains more than one interface.
	Interface int
	// contains filtered or unexported fields
}

DeviceInfo contains all the information we know about a USB device. In case of HID devices, that might be a lot more extensive (empty fields for raw USB).

func Enumerate

func Enumerate(vendorID uint16, productID uint16) ([]DeviceInfo, error)

Enumerate returns a list of all the USB devices attached to the system which match the vendor and product id:

  • If the vendor id is set to 0 then any vendor matches.
  • If the product id is set to 0 then any product matches.
  • If the vendor and product id are both 0, all devices are returned.

For any device that is HID capable, the enumeration will return an interface to the HID endpoints. For pure raw USB access, please use EnumerateRaw.

func EnumerateHid

func EnumerateHid(vendorID uint16, productID uint16) ([]DeviceInfo, error)

EnumerateHid returns a list of all the HID devices attached to the system which match the vendor and product id:

  • If the vendor id is set to 0 then any vendor matches.
  • If the product id is set to 0 then any product matches.
  • If the vendor and product id are both 0, all devices are returned.

func EnumerateRaw

func EnumerateRaw(vendorID uint16, productID uint16) ([]DeviceInfo, error)

EnumerateRaw returns a list of all the USB devices attached to the system which match the vendor and product id:

  • If the vendor id is set to 0 then any vendor matches.
  • If the product id is set to 0 then any product matches.
  • If the vendor and product id are both 0, all devices are returned.

func (DeviceInfo) Open

func (info DeviceInfo) Open() (Device, error)

Open connects to a previsouly discovered USB device.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL