Payload

Client for the payload service.

This allows client code to read from the robot payload registry.

class bosdyn.client.payload.PayloadClient[source]

Bases: bosdyn.client.common.BaseClient

A client handling payload configs.

default_service_name = 'payload'
service_type = 'bosdyn.api.PayloadService'
list_payloads(**kw_args)[source]

List all payloads registered on the robot

Parameters

kw_args – Extra arguments to pass to grpc call invocation.

Returns

A list of the proto message definitions of all registered payloads

Raises

RpcError – Problem communicating with the robot.

list_payloads_async(**kw_args)[source]

List all payloads registered on the robot

Parameters

kw_args – Extra arguments to pass to grpc call invocation.

Returns

A list of the proto message definitions of all registered payloads

Raises

RpcError – Problem communicating with the robot.