board

Documentation

Index

• func Details(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetailsResponse, error)
• func List(req *rpc.BoardListRequest) (r []*rpc.DetectedPort, discoveryStartErrors []error, e error)
• func ListAll(ctx context.Context, req *rpc.BoardListAllRequest) (*rpc.BoardListAllResponse, error)
• func Search(ctx context.Context, req *rpc.BoardSearchRequest) (*rpc.BoardSearchResponse, error)
• func Watch(req *rpc.BoardListWatchRequest) (<-chan *rpc.BoardListWatchResponse, func(), error)

Functions

func Details

func Details(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetailsResponse, error)

Details returns all details for a board including tools and HW identifiers. This command basically gather al the information and translates it into the required grpc struct properties

func List

func List(req *rpc.BoardListRequest) (r []*rpc.DetectedPort, discoveryStartErrors []error, e error)

List returns a list of boards found by the loaded discoveries. In case of errors partial results from discoveries that didn't fail are returned.

func ListAll

func ListAll(ctx context.Context, req *rpc.BoardListAllRequest) (*rpc.BoardListAllResponse, error)

ListAll FIXMEDOC

func Search

func Search(ctx context.Context, req *rpc.BoardSearchRequest) (*rpc.BoardSearchResponse, error)

Search returns all boards that match the search arg. Boards are searched in all platforms, including those in the index that are not yet installed. Note that platforms that are not installed don't include boards' FQBNs. If no search argument is used all boards are returned.

func Watch

func Watch(req *rpc.BoardListWatchRequest) (<-chan *rpc.BoardListWatchResponse, func(), error)

Watch returns a channel that receives boards connection and disconnection events. It also returns a callback function that must be used to stop and dispose the watch.