Class

DataAcquisitionPluginClient

DataAcquisitionPluginClient(nameopt)

Constructor

# new DataAcquisitionPluginClient(nameopt)

Create an instance of DataAcquisitionPluginClient's class.
Parameters:
Name Type Attributes Default Description
name string <optional>
null Name of the Class.

View Source bosdyn-client/data_acquisition_plugin.js, line 24

Methods

# acquire_plugin_data(acquisition_requests, action_id, data_identifiersopt, nullable, metadataopt, nullable, args) → {Promise.<data_acquisition.AcquirePluginDataResponse>}

Trigger a data acquisition to save data and metadata to the data acquisition store service.
Parameters:
Name Type Attributes Default Description
acquisition_requests data_acquisition.AcquisitionRequestList The different image sources and data sources to capture from and save to the data acquisition store service with the same timestamp.
action_id data_acquisition.CaptureActionId The unique action that all data should be saved with.
data_identifiers Array.<data_acquisition.DataIdentifier> <optional>
<nullable>
null List of data identifiers to associate with metadata.
metadata data_acquisition.Metadata <optional>
<nullable>
null The JSON structured metadata to be associated with the data returned by the DataAcquisitionService when logged in the data acquisition store service.
args Object Extra arguments for controlling RPC details.

View Source bosdyn-client/data_acquisition_plugin.js, line 53

Problem communicating with the robot.
RpcError
If the RPC is successful, then it will return the acquire data response which can be used to check the status of the acquisition and get feedback.
Promise.<data_acquisition.AcquirePluginDataResponse>

# update_from(other) → {void}

Update instance from another object.
Parameters:
Name Type Description
other Object The object where to copy from.

View Source bosdyn-client/data_acquisition_plugin.js, line 33

void