benjamin

type BaseEvent struct {
	On Device
	At time.Time
}

type Button interface {
	Peripheral
	Drawable

	// Position on the key matrix.
	Position() image.Point
}

type ButtonPress struct {
	BaseEvent
	Button
}

type ButtonRelease struct {
	BaseEvent
	After time.Duration
	Button
}

type Device interface {
	Manufacturer() string
	Product() string
	Serial() string

	Open() error
	Close() error
	Reset() error

	// Clear all displays and buttons to black.
	Clear() error

	Events() <-chan Event

	Surface
}

type Display interface {
	Peripheral
	Drawable
}

type DisplayLongPress struct {
	BaseEvent
	Display
	Position image.Point
}

type DisplayPress struct {
	BaseEvent
	Display
	Position image.Point
}

type DisplaySwipe struct {
	BaseEvent
	Display
	From, To image.Point
}

type Drawable interface {
	Size() image.Point
	SetImage(image.Image) error
}

type Encoder interface {
	Peripheral

	// Display linked to the encoder, returns nil if the encoder has no display.
	Display() Display
}

type EncoderChange struct {
	BaseEvent
	Encoder
	Change int
	Bits   int
}

type EncoderPress struct {
	BaseEvent
	Encoder
}

type EncoderRelease struct {
	BaseEvent
	Encoder
	After time.Duration
}

type Error struct {
	BaseEvent
	Error error
}

type Event struct {
	// Type of event.
	Type EventType

	// Peripheral the event was generated with.
	Peripheral Peripheral

	// Data associated with the event.
	Data EventData
}

type EventData interface {
	// Device the event was on.
	Device() Device

	// Time of event.
	Time() time.Time

	// Stringer interface
	fmt.Stringer
}

type EventHandler interface {
	Handle(Event)
}

type EventHandlerFunc func(Event)

type EventType int

type Peripheral interface {
	// Surface the pheripheral is connected to.
	Surface() Surface

	// Index of the pheripheral.
	Index() int
}

type Route struct {
	Peripheral Peripheral
	EventHandler
}

type Router map[EventType][]Route

type Screen interface {
	Peripheral
	Drawable
}

type Surface interface {
	Display(int) Display
	Displays() int
	DisplayArea() Screen

	Encoder(int) Encoder
	Encoders() int

	Button(int) Button
	ButtonAt(image.Point) Button
	Buttons() int
	ButtonLayout() image.Point
	ButtonArea() Screen

	SetBrightness(float64) error
}

type USBDevice interface {
	DeviceInfo() hid.DeviceInfo
}