topology

Documentation

Index

• func ConvertServoTopologyItemToString(c *tlw.ServoTopologyItem) string
• func Devices(c *tlw.ServoTopology, filteredBoard string) []*tlw.ServoTopologyItem
• func GetRootServo(ctx context.Context, runner execs.Runner, servoSerial string) (*tlw.ServoTopologyItem, error)
• func GetRootServoPath(ctx context.Context, runner execs.Runner, servoSerial string) (string, error)
• func GetServoUsbDevnum(ctx context.Context, runner execs.Runner, servoSerial string) (string, error)
• func ListOfDevices(ctx context.Context, runner execs.Runner, servoSerial string) ([]*tlw.ServoTopologyItem, error)
• func RereadServoFwVersion(ctx context.Context, runner execs.Runner, servo *tlw.ServoTopologyItem) error
• func RetrieveServoTopology(ctx context.Context, runner execs.Runner, servoSerial string) (*tlw.ServoTopology, error)
• func USBDrives(ctx context.Context, runner execs.Runner, servoSerial string) ([]*labApi.UsbDrive, error)

Functions

func ConvertServoTopologyItemToString

func ConvertServoTopologyItemToString(c *tlw.ServoTopologyItem) string

ConvertServoTopologyItemToString returns a string representation of ServoTopologyItem instance.

func Devices

func Devices(c *tlw.ServoTopology, filteredBoard string) []*tlw.ServoTopologyItem

Devices creates and returns a slice of the servo devices in servo topology. if there is a filteredBoard, then only return the slice of topology item that contains that one filtered board.

func GetRootServo

func GetRootServo(ctx context.Context, runner execs.Runner, servoSerial string) (*tlw.ServoTopologyItem, error)

GetRootServo fetches the ServoTopologyItem representing the root-servo for a given servo serial number.

func GetRootServoPath

func GetRootServoPath(ctx context.Context, runner execs.Runner, servoSerial string) (string, error)

GetRootServoPath gets the path of root servo on servo host.

func GetServoUsbDevnum

func GetServoUsbDevnum(ctx context.Context, runner execs.Runner, servoSerial string) (string, error)

GetServoUsbDevnum returns the current usb devnum of servo.

func ListOfDevices

func ListOfDevices(ctx context.Context, runner execs.Runner, servoSerial string) ([]*tlw.ServoTopologyItem, error)

ListOfDevices returns a slice of ServoTopologyItem objects that represent all the servo devices connected to the servo host.

func RereadServoFwVersion

func RereadServoFwVersion(ctx context.Context, runner execs.Runner, servo *tlw.ServoTopologyItem) error

RereadServoFwVersion rereads the servo's firmware inside servo toplogy to the current version based on the configuration file.

func RetrieveServoTopology

func RetrieveServoTopology(ctx context.Context, runner execs.Runner, servoSerial string) (*tlw.ServoTopology, error)

RetrieveServoTopology retries the servo topology consisting of root servo and servo children on a host.

func USBDrives

func USBDrives(ctx context.Context, runner execs.Runner, servoSerial string) ([]*labApi.UsbDrive, error)

USBDrives reads the USB drive's information that contains the serial and the manufacture.