Class

NetworkComputeBridgeClient

NetworkComputeBridgeClient()

Constructor

# new NetworkComputeBridgeClient()

Client to either the NetworkComputeBridgeService or the NetworkComputeBridgeWorkerService.

View Source bosdyn-client/network_compute_bridge_client.js, line 30

Extends

  • BaseClient

Methods

# list_available_models(service_name, args) → {Promise.<network_compute_bridge_pb.ListAvailableModelsResponse>}

List all available models that the service knows.
Parameters:
Name Type Description
service_name string The service to query for models.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/network_compute_bridge_client.js, line 59

Problem communicating with the robot.
RpcError
The network compute bridge worker service was not found in the robot's directory.
ExternalServiceNotFoundError
Either the service or worker service threw an error when responding with the set of all models.
ExternalServerError
The full ListAvailableModelsResponse, which contains any models the service or worker service advertise.
Promise.<network_compute_bridge_pb.ListAvailableModelsResponse>

# list_available_models_command(list_request, args) → {network_compute_bridge_pb.ListAvailableModelsResponse}

List all available models that the service knows.
Parameters:
Name Type Description
list_request network_compute_bridge_pb.ListAvailableModelsRequest The request to list all models.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/network_compute_bridge_client.js, line 78

Problem communicating with the robot.
RpcError
The network compute bridge worker service was not found in the robot's directory.
ExternalServiceNotFoundError
Either the service or worker service threw an error when responding with the set of all models.
ExternalServerError
The full ListAvailableModelsResponse, which contains any models the service or worker service advertise.
network_compute_bridge_pb.ListAvailableModelsResponse

# network_compute_bridge_command(network_compute_request, args) → {Promise.<network_compute_bridge_pb.NetworkComputeResponse>}

Issue the main network compute bridge request to run a model on specific, requested data.
Parameters:
Name Type Description
network_compute_request network_compute_bridge_pb.NetworkComputeRequest The request which contains what type of data should be processed, and which model the server should run.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/network_compute_bridge_client.js, line 97

Problem communicating with the robot.
RpcError
The network compute bridge worker service was not found in the robot's directory.
ExternalServiceNotFoundError
Either the service or worker service threw an error when responding with the set of all models.
ExternalServerError
For processed image data, the robot was unable to rotate the image as requested.
NetworkComputeRotationError
The full NetworkComputeResponse, which contains the processed data.
Promise.<network_compute_bridge_pb.NetworkComputeResponse>

NetworkComputeBridgeClient(nameopt)

Constructor

# new NetworkComputeBridgeClient(nameopt)

Create an instance of NetworkComputeBridgeClient's class.
Parameters:
Name Type Attributes Default Description
name string <optional>
null The BaseClient's name.

View Source bosdyn-client/network_compute_bridge_client.js, line 43

Methods

# list_available_models(service_name, args) → {Promise.<network_compute_bridge_pb.ListAvailableModelsResponse>}

List all available models that the service knows.
Parameters:
Name Type Description
service_name string The service to query for models.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/network_compute_bridge_client.js, line 59

Problem communicating with the robot.
RpcError
The network compute bridge worker service was not found in the robot's directory.
ExternalServiceNotFoundError
Either the service or worker service threw an error when responding with the set of all models.
ExternalServerError
The full ListAvailableModelsResponse, which contains any models the service or worker service advertise.
Promise.<network_compute_bridge_pb.ListAvailableModelsResponse>

# list_available_models_command(list_request, args) → {network_compute_bridge_pb.ListAvailableModelsResponse}

List all available models that the service knows.
Parameters:
Name Type Description
list_request network_compute_bridge_pb.ListAvailableModelsRequest The request to list all models.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/network_compute_bridge_client.js, line 78

Problem communicating with the robot.
RpcError
The network compute bridge worker service was not found in the robot's directory.
ExternalServiceNotFoundError
Either the service or worker service threw an error when responding with the set of all models.
ExternalServerError
The full ListAvailableModelsResponse, which contains any models the service or worker service advertise.
network_compute_bridge_pb.ListAvailableModelsResponse

# network_compute_bridge_command(network_compute_request, args) → {Promise.<network_compute_bridge_pb.NetworkComputeResponse>}

Issue the main network compute bridge request to run a model on specific, requested data.
Parameters:
Name Type Description
network_compute_request network_compute_bridge_pb.NetworkComputeRequest The request which contains what type of data should be processed, and which model the server should run.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/network_compute_bridge_client.js, line 97

Problem communicating with the robot.
RpcError
The network compute bridge worker service was not found in the robot's directory.
ExternalServiceNotFoundError
Either the service or worker service threw an error when responding with the set of all models.
ExternalServerError
For processed image data, the robot was unable to rotate the image as requested.
NetworkComputeRotationError
The full NetworkComputeResponse, which contains the processed data.
Promise.<network_compute_bridge_pb.NetworkComputeResponse>