Data Acquisition Store

Client implementation for data acquisition store service.

class bosdyn.client.data_acquisition_store.DataAcquisitionStoreClient[source]

Bases: BaseClient

A client for triggering data acquisition store methods.

default_service_name = 'data-acquisition-store'

service_type = 'bosdyn.api.DataAcquisitionStoreService'

update_from(other)[source]: Adopt key objects like processors, logger, and wallet from other.

list_capture_actions(query, **kwargs)[source]

List capture actions that satisfy the query parameters.

Parameters:: query (bosdyn.api.DataQueryParams) – Query parameters.
Returns:: CaptureActionIds for the actions matching the query parameters.

list_capture_actions_async(query, **kwargs)[source]: Async version of the list_capture_actions() RPC.

list_stored_images(query, **kwargs)[source]

List images that satisfy the query parameters.

Parameters:: query (bosdyn.api.DataQueryParams) – Query parameters.
Returns:: DataIdentifiers for the images matching the query parameters.

list_stored_images_async(query, **kwargs)[source]: Async version of the list_stored_images_actions() RPC.

list_stored_metadata(query, **kwargs)[source]

List metadata that satisfy the query parameters.

Parameters:: query (bosdyn.api.DataQueryParams) – Query parameters.
Returns:: DataIdentifiers for the metadata matching the query parameters.

list_stored_metadata_async(query, **kwargs)[source]: Async version of the list_stored_metadata() RPC.

list_stored_alertdata(query, **kwargs)[source]

List AlertData that satisfy the query parameters.

Parameters:: query (bosdyn.api.DataQueryParams) – Query parameters.
Returns:: DataIdentifiers for the AlertData matching the query parameters.

list_stored_alertdata_async(query, **kwargs)[source]: Async version of the list_stored_alertdata() RPC.

list_stored_data(query, **kwargs)[source]

List data that satisfy the query parameters.

Parameters:: query (bosdyn.api.DataQueryParams) – Query parameters.
Returns:: DataIdentifiers for the data matching the query parameters.

list_stored_data_async(query, **kwargs)[source]: Async version of the list_stored_data() RPC.

store_image(image, data_id, **kwargs)[source]

Store image.

Parameters:

image (bosdyn.api.ImageCapture) – Image to store.
data_id (bosdyn.api.DataIdentifier) – Data identifier to use for storing the image.

Returns:

StoreImageResponse response.

store_image_async(image, data_id, **kwargs)[source]: Async version of the store_image() RPC.

store_metadata(associated_metadata, data_id, **kwargs)[source]

Store metadata.

Parameters:

associated_metadata (bosdyn.api.AssociatedMetadata) – Metadata to store. If metadata is not associated with a particular piece of data, the data_id field in this object needs to specify only the action_id part.
data_id (bosdyn.api.DataIdentifier) – Data identifier to use for storing this associated metadata.

Returns:

StoreMetadataResponse response.

store_metadata_async(associated_metadata, data_id, **kwargs)[source]: Async version of the store_metadata() RPC.

store_alertdata(associated_alert_data, data_id, **kwargs)[source]

Store AlertData.

Parameters:

associated_alert_data (bosdyn.api.AssociatedAlertData) – AlertData to store. If AlertData is not associated with a particular piece of data, the data_id field in this object needs to specify only the action_id part.
data_id (bosdyn.api.DataIdentifier) – Data identifier to use for storing this associated AlertData.

Returns:

StoreAlertDataResponse response.

store_alertdata_async(associated_alert_data, data_id, **kwargs)[source]: Async version of the store_alertdata() RPC.

store_data(data, data_id, file_extension=None, **kwargs)[source]

Store data.

Parameters:

data (bytes) – Arbitrary data to store.
data_id (bosdyn.api.DataIdentifier) – Data identifier to use for storing this data.
file_extension (string) – File extension to use for writing the data to a file.

Returns:

StoreDataResponse response.

store_data_async(data, data_id, file_extension=None, **kwargs)[source]: Async version of the store_data() RPC.

store_data_as_chunks(data, data_id, file_extension=None, **kwargs)[source]

Store data using streaming, supports storing of large data that is too large for a single store_data rpc. Note: using this rpc means that the data must be loaded into memory.

Parameters:

data (bytes) – Arbitrary data to store.
data_id (bosdyn.api.DataIdentifier) – Data identifier to use for storing this data.
file_extension (string) – File extension to use for writing the data to a file.

Returns:

StoreDataResponse final successful response or first failed response.

store_data_as_chunks_async(data, data_id, file_extension=None, **kwargs)[source]: Async version of the store_data_as_chunks() RPC.

store_file(file_path, data_id, file_extension=None, **kwargs)[source]

Store file using file path, supports storing of large files that are too large for a single store_data rpc.

Parameters:

file_path (string) – File path to arbitrary data to store.
data_id (bosdyn.api.DataIdentifier) – Data identifier to use for storing this data.
file_extension (string) – File extension to use for writing the data to a file.

Returns:

StoreDataResponse final successful response or first failed response.

store_file_async(file_path, data_id, file_extension=None, **kwargs)[source]: Async version of the store_file() RPC.

query_stored_captures(query=None, **kwargs)[source]

Query stored captures from the robot.

Parameters:: query (bosdyn.api.QueryParameters) – Query parameters.
Raises:: RpcError – Problem communicating with the robot.

query_stored_captures_async(query=None, **kwargs)[source]: Async version of the query_stored_captures() RPC.

query_max_capture_id(**kwargs)[source]: Query max capture id from the robot. :returns: QueryMaxCaptureIdResult, which has a max_capture_id uint64, corresponding to the

greatest capture id on the robot. Used for skipping DAQ synchronization on connect.

query_max_capture_id_async(**kwargs)[source]: Async version of the query_max_capture_id() RPC.