Extends
- BaseClient
Methods
# acquire_data(acquisition_requests, action_name, group_name, data_timestampnullable, metadatanullable, argsopt) → {Promise.<data_acquisition.AcquireDataResponse.RequestId>}
Trigger a data acquisition to save data and metadata to the data buffer.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
acquisition_requests |
Object
|
The different image sources and data sources to capture from and save to the data buffer with the same timestamp. | ||
action_name |
string
|
The unique action name that all data will be saved with. | ||
group_name |
string
|
The unique group name that all data will be saved with. | ||
data_timestamp |
google.protobuf.Timestamp
|
<nullable> |
null | The unique timestamp that all data will be saved with. |
metadata |
Metadata
|
object
|
<nullable> |
null | The JSON structured metadata to be associated with the data returned by the DataAcquisitionService when logged in the data buffer service. |
args |
Object
|
<optional> |
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
If the RPC is successful, then it will return
the acquire data request id, which can be used to check the status of the acquisition and get feedback.
Promise.<data_acquisition.AcquireDataResponse.RequestId>
# cancel_acquisition(request_id, argsopt) → {Promise.<data_acquisition.CancelAcquisitionResponse>}
Cancel a data acquisition based on the request id.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
request_id |
number
|
The request id associated with an AcquireData request. | |
args |
Object
|
<optional> |
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
The data acquisitions associated with the request id were unable to be cancelled.
CancellationFailedError
The request id provided is incorrect.
RequestIdDoesNotExistError
If the RPC is successful, then it will return the
full status response, which includes the status as well as other information about any possible errors.
Promise.<data_acquisition.CancelAcquisitionResponse>
# get_service_info(argsopt) → {Promise.<data_acquisition.GetServiceInfoResponse.Capabilities>}
Get information from a DAQ service to list it's capabilities - which data, metadata,
or processing the DAQ service will perform.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
args |
Object
|
<optional> |
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
The GetServiceInfoResponse message,
which contains all the different capabilities.
Promise.<data_acquisition.GetServiceInfoResponse.Capabilities>
# get_status(request_id, argsopt) → {Promise.<data_acquisition.GetStatusResponse>}
Check the status of a data acquisition based on the request id.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
request_id |
number
|
The request id associated with an AcquireData request. | |
args |
Object
|
<optional> |
Extra arguments for controlling RPC details. |
Problem communicating with the robot.
RpcError
The request id provided is incorrect.
RequestIdDoesNotExistError
If the RPC is successful, then it will return
the full status response, which includes the status as well as other information about any possible errors.
Promise.<data_acquisition.GetStatusResponse>
# async update_from(other) → {Promise.<void>}
Update instance from another object.
Parameters:
| Name | Type | Description |
|---|---|---|
other |
Object
|
The object where to copy from. |
Promise.<void>