Remote Client

Client for the RemoteMission service.

exception bosdyn.mission.remote_client.Error

Bases: Exception

exception bosdyn.mission.remote_client.InvalidSessionId(response, error_message=None)

Bases: ResponseError

Provided session ID was not valid on the server.

exception bosdyn.mission.remote_client.MissingInputs(response, error_message=None)

Bases: ResponseError

Missing required inputs.

exception bosdyn.mission.remote_client.MissingLeases(response, error_message=None)

Bases: ResponseError

Missing leases on required resources.

bosdyn.mission.remote_client.tree_status_from_tick_status(tick_status)

class bosdyn.mission.remote_client.RemoteClient

Bases: BaseClient

default_service_name = None

service_type = 'bosdyn.api.mission.RemoteMissionService'

update_from(other)

Adopt key objects like processors, logger, and wallet from other.

establish_session(leases=(), inputs=None, lease_resources=<object object>, **kwargs)

Establish a session.

Parameters:

• leases (Iterable[Lease]) – List of lease protobufs to establish session with.

• inputs (Iterable[bosdyn.api.mission.KeyValue]) – any inputs needed by by the remote node.

• lease_resources (Iterable[str]) – List of resource names to use from the lease wallet. Only applied if no leases are provided.

establish_session_async(leases=(), inputs=None, lease_resources=<object object>, **kwargs)

Async version of establish_session()

tick(session_id, leases=(), inputs=None, lease_resources=<object object>, group_name=None, params=None, **kwargs)

Tick the remote node.

Parameters:

• session_id – session

• leases (Iterable[Lease]) – List of lease protobufs to use during the tick.

• inputs (Iterable[bosdyn.api.mission.KeyValue]) – any inputs needed by by the remote node.

• lease_resources (Iterable[str]) – List of resource names to use from the lease wallet. Only applied if no leases are provided.

tick_async(session_id, leases=(), inputs=None, lease_resources=<object object>, group_name=None, params=None, **kwargs)

Async version of tick()

stop(session_id, **kwargs)

stop_async(session_id, **kwargs)

teardown_session(session_id, **kwargs)

teardown_session_async(session_id, **kwargs)

get_service_info(**kwargs)

Get information about the service itself, such as a custom parameter spec.

Raises:

RpcError – problem communicating with the robot.

Returns:

A GetRemoteMissionServiceInfoResponse message describing this service.

get_service_info_async(**kwargs)

Async version of get_service_info()