hid

README

go-hid

Working prototype to prove that you don't need cgo to work with HID devices. Currently, only Windows is supported.

Developed as part of go-ctaphid.

Status

• Windows
  • Enumerate
  • Open
    • Read
    • Write
• macOS
  • Enumerate
  • Open
    • Read
    • Write
• Linux
  • Enumerate
  • Open
    • Read
    • Write

Documentation

Index

• func Enumerate() iter.Seq2[*DeviceInfo, error]
• type Device
  • func OpenPath(path string) (*Device, error)
  • func (d *Device) Close() error
  • func (d *Device) Read(b []byte) (int, error)
  • func (d *Device) Write(b []byte) (int, error)
• type DeviceInfo

Functions

func Enumerate

func Enumerate() iter.Seq2[*DeviceInfo, error]

Types

type Device

type Device struct {
	// contains filtered or unexported fields
}

func OpenPath

func OpenPath(path string) (*Device, error)

func (*Device) Close

func (d *Device) Close() error

func (*Device) Read

func (d *Device) Read(b []byte) (int, error)

func (*Device) Write

func (d *Device) Write(b []byte) (int, error)

type DeviceInfo

type DeviceInfo struct {
	Path         string // Platform-Specific Device Path
	VendorID     uint16 // Device Vendor ID
	ProductID    uint16 // Device Product ID
	SerialNbr    string // Serial Number
	ReleaseNbr   uint16 // Device Version Number
	MfrStr       string // Manufacturer String
	ProductStr   string // Product String
	UsagePage    uint16 // Usage Page for Device/Interface
	Usage        uint16 // Usage for Device/Interface
	InterfaceNbr int    // USB Interface Number
}