Remote Client¶
Client for the RemoteMission service.
-
exception
bosdyn.mission.remote_client.
InvalidSessionId
(response, error_message=None)[source]¶ Bases:
bosdyn.client.exceptions.ResponseError
Provided session ID was not valid on the server.
-
exception
bosdyn.mission.remote_client.
MissingInputs
(response, error_message=None)[source]¶ Bases:
bosdyn.client.exceptions.ResponseError
Missing required inputs.
-
exception
bosdyn.mission.remote_client.
MissingLeases
(response, error_message=None)[source]¶ Bases:
bosdyn.client.exceptions.ResponseError
Missing leases on required resources.
-
class
bosdyn.mission.remote_client.
RemoteClient
[source]¶ Bases:
bosdyn.client.common.BaseClient
-
default_service_name
= None¶
-
service_type
= 'bosdyn.api.mission.RemoteMissionService'¶
-
establish_session
(leases=(), inputs=None, lease_resources=<object object>, **kwargs)[source]¶ 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)[source]¶ Async version of establish_session()
-
tick
(session_id, leases=(), inputs=None, lease_resources=<object object>, **kwargs)[source]¶ 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.
-