gun

Documentation

Index

• type Gun
  • func New(ub unitybridge.UnityBridge, l *logger.Logger, cm *connection.Connection, ...) (*Gun, error)
  • func (g *Gun) Connected() bool
  • func (g *Gun) Fire(typ Type) error
  • func (g *Gun) Start() error
  • func (g *Gun) Stop() error
  • func (G *Gun) String() string
  • func (g *Gun) WaitForConnection(timeout time.Duration) bool
• type Type
  • func (t Type) String() string
  • func (t Type) Valid() bool

Types

type Gun

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

Gun is the module that controls turret firing. It supports both infrared and beads firing.

func New

func New(ub unitybridge.UnityBridge, l *logger.Logger,
	cm *connection.Connection, rm *robot.Robot) (*Gun, error)

New creates a new Gun instance.

func (*Gun) Connected

func (g *Gun) Connected() bool

Connected returns whether the Gun module is connected.

func (*Gun) Fire

func (g *Gun) Fire(typ Type) error

Fire fires the Gun module with the given type.

func (*Gun) Start

func (g *Gun) Start() error

Start starts the Gun module.

func (*Gun) Stop

func (g *Gun) Stop() error

Stop stops the Gun module.

func (*Gun) String

func (G *Gun) String() string

String returns a string representation of the Gun module.

func (*Gun) WaitForConnection

func (g *Gun) WaitForConnection(timeout time.Duration) bool

WaitForConnection waits for the Gun module to connect and returns the connected status.

type Type

type Type uint8

const (
	TypeBead Type = iota
	TypeInfrared
)

func (Type) String

func (t Type) String() string

func (Type) Valid

func (t Type) Valid() bool