Documentation Github spot-sdk-js Github spot-server-js

Class

Robot

Robot()

Settings common to one user's access to one robot. This is the main point of access to all client functionality. The ensure_client member is used to get any client to a service exposed on the robot. Additionally, many helpers are exposed to provide commonly used functionality without explicitly accessing a particular client object. Note that any rpc call made to the robot can raise an RpcError subclass if there are errors communicating with the robot. Additionally, ResponseErrors will be raised if there was an error acting on the request itself. An InvalidRequestError indicates a programming error, where the request was malformed in some way. InvalidRequestErrors will never be thrown except in the case of client bugs. See also Sdk and BaseClient
Constructor

# new Robot()

View Source bosdyn-client/robot.js, line 80

Methods

# async ensure_channel(service_name, secureopt, options) → {Promise.<*>|*}

Verify the right information exists before calling the ensure_secure_channel method.
Parameters:
Name Type Attributes Default Description
service_name string Name of the service in the directory.
secure boolean <optional>
 true Create a secure channel or not.
options Array Options of the grpc channel.

View Source bosdyn-client/robot.js, line 233

Existing channel if found, or newly created channel if not found.
Promise.<*> | *