usb

Documentation

Overview

Package usb provides utilities for searching for and working with usb based devices.

Index

• Variables
• type Description
  • func Search(filter SearchFilter, includeDevice func(vendorID, productID int) bool) []Description
• type Identifier
• type SearchFilter

Variables

var SysPaths = []string{"/sys/bus/usb-serial/devices", "/sys/bus/usb/drivers/cdc_acm"}

SysPaths are where we search for devices. This can be changed for tests.

Types

type Description

type Description struct {
	ID   Identifier
	Path string
}

Description describes a specific USB device.

func Search

func Search(filter SearchFilter, includeDevice func(vendorID, productID int) bool) []Description

Search uses linux device APIs to find all applicable USB devices.

type Identifier

type Identifier struct {
	Vendor  int
	Product int
}

Identifier identifies a specific USB device by the vendor who produced it and the product that it is. These should be unique across products.

type SearchFilter

type SearchFilter struct{}

SearchFilter does not do anything for linux.