module

Documentation

Index

• type Module
• type Type

Types

type Module

type Module interface {
	fmt.Stringer

	// Start starts the module.
	Start() error

	// Connected returns true if the module connection has been established.
	Connected() bool

	// WaitForConnection waits for the module connection to be established.
	WaitForConnection(timeout time.Duration) bool

	// Stop stops the module.
	Stop() error
}

Module is the interface implemented by all modules.

type Type

type Type uint8

const (
	TypeConnection Type = 1 << iota
	TypeRobot
	TypeController
	TypeChassis
	TypeGimbal
	TypeCamera
	TypeGun
	TypeGamePad

	TypeAll = TypeConnection | TypeRobot | TypeController | TypeChassis |
		TypeGimbal | TypeCamera | TypeGun | TypeGamePad
	TypeAllButGamePad = TypeConnection | TypeRobot | TypeController | TypeChassis |
		TypeGimbal | TypeCamera | TypeGun
)