gopi

type AppConfig struct {
	Modules  []*Module
	AppArgs  []string
	AppFlags *Flags
	Params   map[AppParam]interface{}
	Debug    bool
	Verbose  bool
}

type AppInstance struct {
	AppFlags   *Flags
	Logger     Logger
	Hardware   Hardware
	Display    Display
	Graphics   SurfaceManager
	Sprites    SpriteManager
	Input      InputManager
	Fonts      FontManager
	Layout     Layout
	Timer      Timer
	GPIO       GPIO
	I2C        I2C
	SPI        SPI
	PWM        PWM
	LIRC       LIRC
	ClientPool RPCClientPool

	// background tasks implementation
	tasks.Tasks
	// contains filtered or unexported fields
}

type AppParam uint

type BackgroundTask func(app *AppInstance, done <-chan struct{}) error

type BackgroundTask2 func(app *AppInstance, start chan<- struct{}, stop <-chan struct{}) error

type Bitmap interface {
	Type() SurfaceFlags
	Size() Size

	// Bitmap operations
	ClearToColor(Color) error
	FillRectToColor(Color, Point, Size) error
	PaintPixel(Color, Point) error
	PaintImage(image.Image, Point, Size) error
}

type Color struct {
	R, G, B, A float32
}

type Config interface {
	// Opens the driver from configuration, or returns error
	Open(Logger) (Driver, error)
}

type Display interface {
	Driver

	// Return display number
	Display() uint

	// Return name of the display
	Name() string

	// Return display size for nominated display number, or (0,0) if display
	// does not exist
	Size() (uint32, uint32)

	// Return the PPI (pixels-per-inch) for the display, or return zero if unknown
	PixelsPerInch() uint32
}

type Driver interface {
	// Close closes the driver and frees the underlying resources
	Close() error
}

type Event interface {
	// Source of the event
	Source() Driver

	// Name of the event
	Name() string
}

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

type FontFace interface {

	// Get Face Name (from the filename)
	Name() string

	// Get Face Index
	Index() uint

	// Get Number of faces within the file
	NumFaces() uint

	// Number of glyphs for the face
	NumGlyphs() uint

	// Return name of font family
	Family() string

	// Return style name of font face
	Style() string

	// Return properties for face
	Flags() FontFlags
}

type FontFlags uint16

type FontManager interface {
	Driver

	// Open a font face - first face at index 0 is loaded
	OpenFace(path string) (FontFace, error)

	// Open a font face - indexed within file of several faces
	OpenFaceAtIndex(path string, index uint) (FontFace, error)

	// Open font faces at path, checking to see if individual files should
	// be opened through a callback function
	OpenFacesAtPath(path string, callback func(manager FontManager, path string, info os.FileInfo) bool) error

	// Destroy a font face
	DestroyFace(FontFace) error

	// Return an array of font families which are loaded
	Families() []string

	// Return open face for filepath
	FaceForPath(path string) FontFace

	// Return faces in a family and/or with a particular set of attributes
	Faces(family string, flags FontFlags) []FontFace
}

type GPIO interface {
	// Enforces general driver and event publisher
	Driver
	Publisher

	// Return number of physical pins, or 0 if if cannot be returned
	// or nothing is known about physical pins
	NumberOfPhysicalPins() uint

	// Return array of available logical pins or nil if nothing is
	// known about pins
	Pins() []GPIOPin

	// Return logical pin for physical pin number. Returns
	// GPIO_PIN_NONE where there is no logical pin at that position
	// or we don't now about the physical pins
	PhysicalPin(uint) GPIOPin

	// Return physical pin number for logical pin. Returns 0 where there
	// is no physical pin for this logical pin, or we don't know anything
	// about the layout
	PhysicalPinForPin(GPIOPin) uint

	// Read pin state
	ReadPin(GPIOPin) GPIOState

	// Write pin state
	WritePin(GPIOPin, GPIOState)

	// Get pin mode
	GetPinMode(GPIOPin) GPIOMode

	// Set pin mode
	SetPinMode(GPIOPin, GPIOMode)

	// Set pull mode to pull down or pull up - will
	// return ErrNotImplemented if not supported
	SetPullMode(GPIOPin, GPIOPull) error

	// Start watching for rising and/or falling edge,
	// or stop watching when GPIO_EDGE_NONE is passed.
	// Will return ErrNotImplemented if not supported
	Watch(GPIOPin, GPIOEdge) error
}

type GPIOEdge uint8

type GPIOEvent interface {
	Event

	// Pin returns the pin on which the event occurred
	Pin() GPIOPin

	// Edge returns whether the pin value is rising or falling
	// or will return NONE if not defined
	Edge() GPIOEdge
}

type GPIOMode uint8

type GPIOPin uint8

type GPIOPull uint8

type GPIOState uint8

type Hardware interface {
	Driver

	// Return name of the hardware platform
	Name() string

	// Return unique serial number of this hardware
	SerialNumber() string

	// Return the number of possible displays for this hardware
	NumberOfDisplays() uint

	// Return host uptime
	UptimeHost() time.Duration

	// Return load averages
	LoadAverage() (float64, float64, float64)
}

type I2C interface {
	Driver

	// Set current slave address
	SetSlave(uint8) error

	// Get current slave address
	GetSlave() uint8

	// Return true if a slave was detected at a particular address
	DetectSlave(uint8) (bool, error)

	// Read Byte (8-bits), Word (16-bits) & Block ([]byte) from registers
	ReadUint8(reg uint8) (uint8, error)
	ReadInt8(reg uint8) (int8, error)
	ReadUint16(reg uint8) (uint16, error)
	ReadInt16(reg uint8) (int16, error)
	ReadBlock(reg, length uint8) ([]byte, error)

	// Write Byte (8-bits) & Word (16-bits) to registers
	WriteUint8(reg, value uint8) error
	WriteInt8(reg uint8, value int8) error
	WriteUint16(reg uint8, value uint16) error
	WriteInt16(reg uint8, value int16) error
}

type InputDevice interface {
	Driver
	Publisher

	// Name of the input device
	Name() string

	// Type of device
	Type() InputDeviceType

	// Bus interface
	Bus() InputDeviceBus

	// Position of cursor (for mouse, joystick and touchscreen devices)
	Position() Point

	// Set absolute current cursor position
	SetPosition(Point)

	// Get key states (caps lock, shift, scroll lock, num lock, etc)
	KeyState() KeyState

	// Set key state (or states) to on or off. Will return error
	// for key states which are not modifiable
	SetKeyState(flags KeyState, state bool) error

	// Returns true if device matches conditions
	Matches(string, InputDeviceType, InputDeviceBus) bool
}

type InputDeviceBus uint16

type InputDeviceType uint8

type InputEvent interface {
	Event

	// Timestamp of event
	Timestamp() time.Duration

	// Type of device which has created the event
	DeviceType() InputDeviceType

	// Event type
	EventType() InputEventType

	// Key or mouse button press or release
	KeyCode() KeyCode

	// Modifier key state (caps lock, shift, alt, etc)
	KeyState() KeyState

	// Key scancode
	ScanCode() uint32

	// Absolute cursor position
	Position() Point

	// Relative change in position
	Relative() Point

	// Multi-touch slot identifier
	Slot() uint
}

type InputEventType uint16

type InputManager interface {
	Driver
	Publisher

	// Open Devices by name, type and bus and return a list
	// of newly opened devices
	OpenDevicesByName(name string, flags InputDeviceType, bus InputDeviceBus) ([]InputDevice, error)

	// Close Device
	CloseDevice(device InputDevice) error

	// Return a list of open devices
	GetOpenDevices() []InputDevice

	// Add a device to managed input devices
	AddDevice(device InputDevice) error
}

type KeyCode uint16

type KeyState uint16

type LIRC interface {
	Driver
	Publisher

	// Get receive and send modes
	RcvMode() LIRCMode
	SendMode() LIRCMode
	SetRcvMode(mode LIRCMode) error
	SetSendMode(mode LIRCMode) error

	// Receive parameters
	GetRcvResolution() (uint32, error)
	SetRcvTimeout(micros uint32) error
	SetRcvTimeoutReports(enable bool) error
	SetRcvCarrierHz(value uint32) error
	SetRcvCarrierRangeHz(min uint32, max uint32) error

	// Send parameters
	SetSendCarrierHz(value uint32) error
	SetSendDutyCycle(value uint32) error

	// Send Pulse Mode, values are in milliseconds
	PulseSend(values []uint32) error
}

type LIRCEvent interface {
	Event

	// The type of message
	Type() LIRCType

	// The value
	Value() uint32
}

type LIRCMode uint32

type LIRCType uint32

type Layout interface {
	Driver

	// Return default view direction
	Direction() LayoutDirection

	// Create a root view with a particular tag and view class,
	// returns a nil object if the view could not be created
	// due to invalid class or pre-existing tag
	NewRootView(tag uint, class string) View

	// Return the root view for a particular tag, returns
	// a nil object if the view could not be found
	RootViewForTag(tag uint) View
}

type LayoutDirection uint

type Logger interface {
	Driver

	// Output logging messages
	Fatal(format string, v ...interface{}) error
	Error(format string, v ...interface{}) error
	Warn(format string, v ...interface{})
	Info(format string, v ...interface{})
	Debug(format string, v ...interface{})
	Debug2(format string, v ...interface{})

	// Return IsDebug flag
	IsDebug() bool
}

type MainTask func(app *AppInstance, done chan<- struct{}) error

type Metric interface {
	// Return the metric rate (store values over a period)
	Rate() MetricRate

	// Return the metric type (the units used for the metric)
	Type() MetricType

	// Return the name of the metric
	Name() string

	// Return the unit for the metric (°C for example)
	Unit() string

	// Return the last metric value as a uint
	UintValue() uint

	// Return the last metric value as a float64
	FloatValue() float64
}

type MetricRate uint

type MetricType uint

type Metrics interface {
	Driver

	// Uptimes for host and for application
	UptimeHost() time.Duration
	UptimeApp() time.Duration

	// Load Average (1, 5 and 15 minutes)
	LoadAverage() (float64, float64, float64)

	// Return metric channel which records uint values
	NewMetricUint(MetricType, MetricRate, string) (chan<- uint, error)

	// Return metric channel which records float64 values
	NewMetricFloat64(MetricType, MetricRate, string) (chan<- float64, error)

	// Return all metrics of a particular type, or METRIC_TYPE_NONE
	// for all metrics
	Metrics(MetricType) []Metric
}

type Module struct {
	Name     string
	Type     ModuleType
	Config   ModuleConfigFunc
	New      ModuleNewFunc
	Run      ModuleRunFunc
	Requires []string
	// contains filtered or unexported fields
}

type ModuleConfigFunc func(*AppConfig)

type ModuleNewFunc func(*AppInstance) (Driver, error)

type ModuleRunFunc func(*AppInstance, Driver) error

type ModuleType uint

type PWM interface {
	Driver

	// Return array of pins which are enabled for PWM
	Pins() []GPIOPin

	// Period
	Period(GPIOPin) (time.Duration, error)
	SetPeriod(time.Duration, ...GPIOPin) error

	// Duty Cycle between 0.0 and 1.0 (0.0 is always off, 1.0 is always on)
	DutyCycle(GPIOPin) (float32, error)
	SetDutyCycle(float32, ...GPIOPin) error
}

type Point struct {
	X, Y float32
}

type Publisher interface {
	// Subscribe to events emitted. Returns channel on which events
	// are emitted or nil if this driver does not implement events
	Subscribe() <-chan Event

	// Unsubscribe from events emitted
	Unsubscribe(<-chan Event)
}

type RPCClient interface {
	// Return connection for the client
	Conn() RPCClientConn
}

type RPCClientConn interface {
	Driver

	// Mutex lock for the connection
	Lock()
	Unlock()

	// Properties
	Addr() string
	Connected() bool
	Timeout() time.Duration
	Services() ([]string, error)
}

type RPCClientPool interface {
	Driver
	Publisher

	// Connect and disconnect
	Connect(service RPCServiceRecord, flags RPCFlag) (RPCClientConn, error)
	ConnectAddr(addr string, flags RPCFlag) (RPCClientConn, error)
	Disconnect(RPCClientConn) error

	// Register clients and create new ones given a stub name
	RegisterClient(string, RPCNewClientFunc) error
	NewClient(string, RPCClientConn) RPCClient
	NewClientEx(string, []RPCServiceRecord, RPCFlag) (RPCClient, error)

	// Lookup service records by parameter - returns records
	// which match either name or addr up to max number of records
	// Can wait for new records and block until cancelled
	Lookup(ctx context.Context, name, addr string, max int) ([]RPCServiceRecord, error)
}

type RPCEvent interface {
	Event

	// Type of RPC Event
	Type() RPCEventType

	// Service Record
	ServiceRecord() RPCServiceRecord
}

type RPCEventType uint

type RPCFlag uint

type RPCNewClientFunc func(RPCClientConn) RPCClient

type RPCServer interface {
	Driver
	Publisher

	// Starts an RPC server in currently running thread.
	// The method will not return until Stop is called
	// which needs to be done in a different thread
	Start() error

	// Stop RPC server. If halt is true then it immediately
	// ends the server without waiting for current requests to
	// be served
	Stop(halt bool) error

	// Return address the server is bound to, or nil if
	// the server is not running
	Addr() net.Addr

	// Return service record, or nil when the service record
	// cannot be generated. The service should be of the format
	// _<service>._tcp and the subtype can only be alphanumeric
	Service(service, subtype, name string, text ...string) RPCServiceRecord
}

type RPCService interface {
	Driver

	// CancelRequests is called by the server to gracefully end any
	// on-going streaming requests, but before the service is shutdown
	CancelRequests() error
}

type RPCServiceDiscovery interface {
	Driver
	Publisher

	// Register a service record on the network, and cache it
	Register(RPCServiceRecord) error

	// Lookup service instances by name
	Lookup(ctx context.Context, service string) ([]RPCServiceRecord, error)

	// Return list of service names
	EnumerateServices(ctx context.Context) ([]string, error)

	// Return all cached service instances for a service name
	ServiceInstances(service string) []RPCServiceRecord
}

type RPCServiceRecord interface {
	Name() string
	Subtype() string
	Service() string
	Port() uint
	Text() []string
	Host() string
	IP4() []net.IP
	IP6() []net.IP
	TTL() time.Duration
}

type SPI interface {
	Driver

	// Get SPI mode
	Mode() SPIMode
	// Get SPI speed
	MaxSpeedHz() uint32
	// Get Bits Per Word
	BitsPerWord() uint8
	// Set SPI mode
	SetMode(SPIMode) error
	// Set SPI speed
	SetMaxSpeedHz(uint32) error
	// Set Bits Per Word
	SetBitsPerWord(uint8) error

	// Read/Write
	Transfer(send []byte) ([]byte, error)

	// Read
	Read(len uint32) ([]byte, error)

	// Write
	Write(send []byte) error
}

type SPIMode uint8

type Size struct {
	W, H float32
}

type Sprite interface {
	Bitmap

	Name() string
	Hotspot() Point
}

type SpriteManager interface {
	Driver

	// Open one or more sprites from a stream and return them
	OpenSprites(io.Reader) ([]Sprite, error)

	// Open sprites from path, checking to see if individual files should
	// be opened through a callback function
	OpenSpritesAtPath(path string, callback func(manager SpriteManager, path string, info os.FileInfo) bool) error

	// Return loaded sprites, or a specific sprite
	Sprites(name string) []Sprite
}

type Surface interface {
	Type() SurfaceFlags
	Size() Size
	Origin() Point
	Opacity() float32
	Layer() uint16
}

type SurfaceFlags uint16

type SurfaceManager interface {
	Driver
	SurfaceManagerSurfaceMethods
	SurfaceManagerBitmapMethods

	// Return the display associated with the surface manager
	Display() Display

	// Return the name of the surface manager. It's basically the
	// GPU driver
	Name() string

	// Return capabilities for the GPU
	Types() []SurfaceFlags
}

type SurfaceManagerBitmapMethods interface {
	// Create and destroy bitmaps
	CreateBitmap(SurfaceFlags, Size) (Bitmap, error)
	CreateSnapshot(SurfaceFlags) (Bitmap, error)
	DestroyBitmap(Bitmap) error
}

type SurfaceManagerCallback func(graphics SurfaceManager, userInfo interface{}) error

type SurfaceManagerSurfaceMethods interface {
	// Perform all surface operations (create, destroy, move, set, paint) within the 'Do' method
	// to ensure atomic updates to the display. When Do returns, the display is updated and any error
	// from the callback is returned
	Do(SurfaceManagerCallback, interface{}) error

	// Create & destroy surfaces
	CreateSurface(flags SurfaceFlags, opacity float32, layer uint16, origin Point, size Size) (Surface, error)
	CreateSurfaceWithBitmap(bitmap Bitmap, flags SurfaceFlags, opacity float32, layer uint16, origin Point, size Size) (Surface, error)
	CreateBackground(flags SurfaceFlags, opacity float32) (Surface, error)
	CreateCursor(cursor Sprite, flags SurfaceFlags, origin Point) (Surface, error)
	DestroySurface(Surface) error

	// Change surface properties (size, position, etc)
	SetOrigin(Surface, Point) error
	MoveOriginBy(Surface, Point) error
	SetSize(Surface, Size) error
	SetLayer(Surface, uint16) error
	SetOpacity(Surface, float32) error
	SetBitmap(Bitmap) error
}

type Timer interface {
	Driver
	Publisher

	// Schedule a timeout (one shot)
	NewTimeout(duration time.Duration, userInfo interface{}) error

	// Schedule an interval, which can fire immediately
	NewInterval(duration time.Duration, userInfo interface{}, immediately bool) error

	// Schedule a backoff timer with maximum backoff duration
	NewBackoff(duration time.Duration, max_duration time.Duration, userInfo interface{}) error
}

type TimerEvent interface {
	Event

	// Provide the timestamp for the event
	Timestamp() time.Time

	// The user info for the event
	UserInfo() interface{}

	// The number of fires for the timer event
	Counter() uint

	// Cancel the timer which fired this event
	Cancel()
}

type VG interface {
	Driver
}

type VGFillRule uint16

type VGPaint interface {
	// Set color
	SetColor(color Color) error

	// Set fill rule
	SetFillRule(style VGFillRule) error

	// Set stroke width
	SetStrokeWidth(width float32) error

	// Set miter limit
	SetMiterLimit(value float32) error

	// Set stroke path endpoint styles (for joins and cap). Use
	// NONE as a value for no change
	SetStrokeStyle(VGStrokeJoinStyle, VGStrokeCapStyle) error

	// Set stroke dash pattern, call with no arguments to reset
	SetStrokeDash(...float32) error
}

type VGPath interface {
	// Draw the path with both stroke and fill
	Draw(stroke, fill VGPaint) error

	// Stroke the path
	Stroke(stroke VGPaint) error

	// Fill the path
	Fill(fill VGPaint) error

	// Reset to empty path
	Clear() error

	// Close Path
	Close() error

	// Move To
	MoveTo(Point) error

	// Line To
	LineTo(...Point) error

	// Quad To
	QuadTo(p1, p2 Point) error

	// Cubic To
	CubicTo(p1, p2, p3 Point) error

	// Append a line to the path
	Line(start, end Point) error

	// Append a rectangle to the path
	Rect(origin Point, size Size) error

	// Append an ellipse to the path
	Ellipse(origin Point, diameter Size) error

	// Append a circle to the path
	Circle(origin Point, diameter float32) error
}

type VGStrokeCapStyle uint16

type VGStrokeJoinStyle uint16

type View interface {
	// Require ability to marshall XML
	xml.Marshaler

	// Return tag for this view
	Tag() uint

	// Return class for this view
	Class() string

	// Return positioning
	Positioning() ViewPositioning

	// Get Style Attributes
	Display() ViewDisplay
	Overflow() ViewOverflow
	Direction() ViewDirection
	Wrap() ViewWrap
	JustifyContent() ViewJustify
	AlignItems() ViewAlign
	AlignContent() ViewAlign
	AlignSelf() ViewAlign
	Grow() float32
	Shrink() float32
	BasisString() string

	// Set Style Attributes
	SetDisplay(value ViewDisplay)
	SetOverflow(value ViewOverflow)
	SetDirection(value ViewDirection)
	SetWrap(value ViewWrap)
	SetJustifyContent(value ViewJustify)
	SetAlignItems(value ViewAlign)
	SetAlignContent(value ViewAlign)
	SetAlignSelf(value ViewAlign)
	SetGrow(value float32)
	SetShrink(value float32)
	SetBasisValue(value float32)
	SetBasisPercent(value float32)
	SetBasisAuto()

	// Set position
	SetPositionValue(value float32, edges ...ViewEdge)
	SetPositionPercent(percent float32, edges ...ViewEdge)

	// Set padding
	SetPaddingValue(value float32, edges ...ViewEdge)
	SetPaddingPercent(percent float32, edges ...ViewEdge)

	// Set margin
	SetMarginValue(value float32, edges ...ViewEdge)
	SetMarginPercent(percent float32, edges ...ViewEdge)
	SetMarginAuto(edges ...ViewEdge)

	// Set width and height
	SetDimensionValue(value float32, dimension ViewDimension)
	SetDimensionPercent(percent float32, dimension ViewDimension)
	SetDimensionAuto(dimension ViewDimension)

	// Minimum and maximum dimensions
	SetDimensionMinValue(value float32, dimension ViewDimension)
	SetDimensionMinPercent(percent float32, dimension ViewDimension)
	SetDimensionMinAuto(dimension ViewDimension)
	SetDimensionMaxValue(value float32, dimension ViewDimension)
	SetDimensionMaxPercent(percent float32, dimension ViewDimension)
	SetDimensionMaxAuto(dimension ViewDimension)

	// Get strings for position, margin and padding, each edge is separated by a space
	PositionString(edges ...ViewEdge) string
	MarginString(edges ...ViewEdge) string
	PaddingString(edges ...ViewEdge) string
	DimensionString(dimension ViewDimension) string
	DimensionMinString(dimension ViewDimension) string
	DimensionMaxString(dimension ViewDimension) string

	// Determine if view changes on this element require layout
	IsDirty() bool

	// Get layout values which are provided once 'CalculateLayout'
	// has been called in the Layout object
	LayoutValue(edge ViewEdge) float32
	LayoutWidth() float32
	LayoutHeight() float32
}

type ViewAlign uint

type ViewDimension uint

type ViewDirection uint

type ViewDisplay uint

type ViewEdge uint

type ViewJustify uint

type ViewOverflow uint

type ViewPositioning uint

type ViewWrap uint