finder

Documentation

Index

• type BroadcastMessage
  • func ParseBroadcastMessageData(data []byte) (*BroadcastMessage, error)
  • func (b *BroadcastMessage) AppId() uint64
  • func (b *BroadcastMessage) IsPairing() bool
  • func (b *BroadcastMessage) SourceIp() net.IP
  • func (b *BroadcastMessage) SourceMac() net.HardwareAddr
  • func (b *BroadcastMessage) String() string
• type Finder
  • func New(l *support.Logger) *Finder
  • func (f *Finder) GetOrFindIP(timeout time.Duration) (net.IP, error)
  • func (f *Finder) SendACK()
  • func (f *Finder) SetIP(ip net.IP)

Types

type BroadcastMessage

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

BroadcastMessage represents a broadcast message sent by a Robomaster robot.

func ParseBroadcastMessageData

func ParseBroadcastMessageData(data []byte) (*BroadcastMessage, error)

ParseBroadcastMessageData parses the given data as a BroadcastMessage. It returns the associated BroadcastMessage instance pointer and a nil error on success and a nil BroadcastMessage and a non-nil error on failure.

func (*BroadcastMessage) AppId

func (b *BroadcastMessage) AppId() uint64

func (*BroadcastMessage) IsPairing

func (b *BroadcastMessage) IsPairing() bool

func (*BroadcastMessage) SourceIp

func (b *BroadcastMessage) SourceIp() net.IP

func (*BroadcastMessage) SourceMac

func (b *BroadcastMessage) SourceMac() net.HardwareAddr

func (*BroadcastMessage) String

func (b *BroadcastMessage) String() string

type Finder

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

Finder provides an interface for finding a robot broadcasting its ip in the network.

func New

func New(l *support.Logger) *Finder

New returns a Finder instance with no associated ip.

func (*Finder) GetOrFindIP

func (f *Finder) GetOrFindIP(timeout time.Duration) (net.IP, error)

GetOrFindIP returns the ip of a robot if it is already know or tries to detect a robot broadcasting its ip in the network. The search will go on until a robot is detected or a timeout happens. Returns the robot ip and a nil error on success and a non-nil error on failure.

func (*Finder) SendACK

func (f *Finder) SendACK()

func (*Finder) SetIP

func (f *Finder) SetIP(ip net.IP)

SetIP forces the associated ip to be the given one. Useful for when connecting to a robot with a known ip.