usb

Documentation

Index

• type Communication
  • func NewCommunication(device io.ReadWriteCloser, usbWriteReportSize, usbReadReportSize int, ...) *Communication
  • func (communication *Communication) Close()
  • func (communication *Communication) ReadFrame() ([]byte, error)
  • func (communication *Communication) SendBootloader(msg []byte) ([]byte, error)
  • func (communication *Communication) SendEncrypt(msg, password string) (map[string]interface{}, error)
  • func (communication *Communication) SendFrame(msg string) error
  • func (communication *Communication) SendPlain(msg string) (map[string]interface{}, error)
• type CommunicationErr
• type DeviceInfo
  • func DeviceInfos() []DeviceInfo
• type Manager
  • func NewManager(channelConfigDir string, bitbox02ConfigDir string, ...) *Manager
  • func (manager *Manager) Start()

Types

type Communication

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

Communication encodes JSON messages to/from a bitbox. The serialized messages are sent/received as USB packets, following the ISO 7816-4 standard.

func NewCommunication

func NewCommunication(
	device io.ReadWriteCloser,
	usbWriteReportSize,
	usbReadReportSize int,
	usbCMD byte,
	hmac bool) *Communication

NewCommunication creates a new Communication.

func (*Communication) Close

func (communication *Communication) Close()

Close closes the underlying device.

func (*Communication) ReadFrame

func (communication *Communication) ReadFrame() ([]byte, error)

ReadFrame reads one usb message.

func (*Communication) SendBootloader

func (communication *Communication) SendBootloader(msg []byte) ([]byte, error)

SendBootloader sends a message in the format the bootloader expects and fetches the response.

func (*Communication) SendEncrypt

func (communication *Communication) SendEncrypt(msg, password string) (map[string]interface{}, error)

SendEncrypt sends an encrypted message. The response is json-deserialized into a map. If the response contains an error field, it is returned as a DBBErr.

func (*Communication) SendFrame

func (communication *Communication) SendFrame(msg string) error

SendFrame sends one usb message.

func (*Communication) SendPlain

func (communication *Communication) SendPlain(msg string) (map[string]interface{}, error)

SendPlain sends an unecrypted message. The response is json-deserialized into a map.

type CommunicationErr

type CommunicationErr error

CommunicationErr is returned if there was an error with the device IO.

type DeviceInfo

type DeviceInfo interface {
	VendorID() int
	ProductID() int
	UsagePage() int
	Interface() int
	Serial() string
	Product() string
	Identifier() string
	Open() (io.ReadWriteCloser, error)
}

DeviceInfo contains the usb descriptor info and a way to open the device for reading and writing.

func DeviceInfos

func DeviceInfos() []DeviceInfo

DeviceInfos returns a slice of all recognized devices.

type Manager

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

Manager listens for devices and notifies when a device has been inserted or removed.

func NewManager

func NewManager(
	channelConfigDir string,
	bitbox02ConfigDir string,
	deviceInfos func() []DeviceInfo,
	onRegister func(device.Interface) error,
	onUnregister func(string),
	onlyOne bool,
) *Manager

NewManager creates a new Manager. onRegister is called when a device has been inserted. onUnregister is called when the device has been removed.

The channelConfigDir argument is passed to each device during initialization, before onRegister is called.

func (*Manager) Start

func (manager *Manager) Start()

Start listens for inserted/removed devices forever.