mindcli

Documentation

Index

• func GetLocalIPByNeighbourIP(neighbourIPStr string) (net.IP, error)
• func GetLocalIPs() ([]net.IP, error)
• func IsTCPPortAvailable(port int) bool
• func IsUDPPortAvailable(port int) bool
• type MindCli
  • func NewMindCli(robotScanner *RobotScanner, userConfig *UserConfig, config *MindCliConfig) *MindCli
  • func (mindcli *MindCli) DefaultRobotIP() string
  • func (mindcli *MindCli) DefaultRobotName() string
  • func (mindcli *MindCli) Login(email, pass string) error
  • func (mindcli *MindCli) RobotByName(robotName string) *Robot
  • func (mindcli *MindCli) RunFlightTest(args ...string)
  • func (mindcli *MindCli) RunSkill(noInstall bool, robotIp string, args ...string)
  • func (mindcli *MindCli) Scan(waitDuration int, args ...string) ([]Robot, error)
  • func (mindcli *MindCli) SetDefaultRobotName(robotName string) error
  • func (mindcli *MindCli) UpgradeImage()
  • func (mindcli *MindCli) X(args ...string)
  • func (mindcli *MindCli) XOutput(args ...string) string
• type MindCliConfig
• type Robot
• type RobotScanner
  • func NewRobotScanner(config *RobotScannerConfig) *RobotScanner
  • func (scanner *RobotScanner) BroadcastToNetwork(waitDuration time.Duration) ([]Robot, error)
  • func (scanner *RobotScanner) HasRobot(robot Robot) bool
  • func (scanner *RobotScanner) ScanIP(ip string, waitDuration time.Duration) ([]Robot, error)
  • func (scanner *RobotScanner) ScanNetwork(waitDuration time.Duration) ([]Robot, error)
• type RobotScannerConfig
• type UserConfig
  • func NewUserConfig(path, authFile string) *UserConfig
  • func (config *UserConfig) Write() error

Functions

func GetLocalIPByNeighbourIP

func GetLocalIPByNeighbourIP(neighbourIPStr string) (net.IP, error)

func GetLocalIPs

func GetLocalIPs() ([]net.IP, error)

func IsTCPPortAvailable

func IsTCPPortAvailable(port int) bool

func IsUDPPortAvailable

func IsUDPPortAvailable(port int) bool

Types

type MindCli

type MindCli struct {
	RobotScanner *RobotScanner
	// contains filtered or unexported fields
}

func NewMindCli

func NewMindCli(robotScanner *RobotScanner, userConfig *UserConfig, config *MindCliConfig) *MindCli

func (*MindCli) DefaultRobotIP

func (mindcli *MindCli) DefaultRobotIP() string

func (*MindCli) DefaultRobotName

func (mindcli *MindCli) DefaultRobotName() string

func (*MindCli) Login

func (mindcli *MindCli) Login(email, pass string) error

func (*MindCli) RobotByName

func (mindcli *MindCli) RobotByName(robotName string) *Robot

func (*MindCli) RunFlightTest

func (mindcli *MindCli) RunFlightTest(args ...string)

func (*MindCli) RunSkill

func (mindcli *MindCli) RunSkill(noInstall bool, robotIp string, args ...string)

func (*MindCli) Scan

func (mindcli *MindCli) Scan(waitDuration int, args ...string) ([]Robot, error)

func (*MindCli) SetDefaultRobotName

func (mindcli *MindCli) SetDefaultRobotName(robotName string) error

func (*MindCli) UpgradeImage

func (mindcli *MindCli) UpgradeImage()

func (*MindCli) X

func (mindcli *MindCli) X(args ...string)

func (*MindCli) XOutput

func (mindcli *MindCli) XOutput(args ...string) string

type MindCliConfig

type MindCliConfig struct {
	Image             string
	ContainerSkillDir string
	ServeMPKPort      int
	ServeRemotePort   int
}

type Robot

type Robot struct {
	Name string `json:"Name"`
	IP   string `json:"IP"`
}

type RobotScanner

type RobotScanner struct {
	Config *RobotScannerConfig
	// contains filtered or unexported fields
}

func NewRobotScanner

func NewRobotScanner(config *RobotScannerConfig) *RobotScanner

func (*RobotScanner) BroadcastToNetwork

func (scanner *RobotScanner) BroadcastToNetwork(waitDuration time.Duration) ([]Robot, error)

func (*RobotScanner) HasRobot

func (scanner *RobotScanner) HasRobot(robot Robot) bool

func (*RobotScanner) ScanIP

func (scanner *RobotScanner) ScanIP(ip string, waitDuration time.Duration) ([]Robot, error)

func (*RobotScanner) ScanNetwork

func (scanner *RobotScanner) ScanNetwork(waitDuration time.Duration) ([]Robot, error)

type RobotScannerConfig

type RobotScannerConfig struct {
	Message string
	Port    int
}

type UserConfig

type UserConfig struct {
	DefaultRobotName string  `json:"DefaultRobotName"`
	Robots           []Robot `json:"Robots"`
	DockerImage      string  `json:"DockerImage"`
	// contains filtered or unexported fields
}

func NewUserConfig

func NewUserConfig(path, authFile string) *UserConfig

func (*UserConfig) Write

func (config *UserConfig) Write() error