tdms

upload_tdms

upload_tdms(
    client: NominalClient,
    file: Path | str,
    name: str | None = None,
    description: str | None = None,
    timestamp_column: str | None = None,
    timestamp_type: _AnyTimestampType | None = None,
    *,
    wait_until_complete: bool = True,
    channel_name_delimiter: str | None = None,
    labels: Sequence[str] = (),
    properties: Mapping[str, str] | None = None,
    tag_columns: Mapping[str, str] | None = None,
    tags: Mapping[str, str] | None = None
) -> Dataset

Create a dataset in the Nominal platform from a tdms file.

See upload_tdms_to_dataset for a description of arguments available, or nominal.thirdparty.pandas.upload_dataframe for a description of dataset creation arguments available.

upload_tdms_to_dataset

upload_tdms_to_dataset(
    dataset: Dataset,
    file: Path | str,
    timestamp_column: str | None = None,
    timestamp_type: _AnyTimestampType | None = None,
    *,
    wait_until_complete: bool = True,
    file_name: str | None = None,
    tag_columns: Mapping[str, str] | None = None,
    tags: Mapping[str, str] | None = None
) -> DatasetFile

Process and upload a tdms file to an existing dataset as if it were a gzipped-CSV file

Parameters:

• dataset

  (Dataset) –

  Dataset to upload the dataframe to

• file

  (Path | str) –

  Path to the TDMS file to parse and upload

• timestamp_column

  (str | None, default: None ) –

  Column containing timestamps to use for their respective rows NOTE: if provided, only groups containing a signal of this name will be uploaded. Furthermore, the length of all data columns must match their respective timestamp columns. NOTE: if not provided, TDMS channel properties must have botha wf_increment and wf_start_time property to be uploaded.

• timestamp_type

  (_AnyTimestampType | None, default: None ) –

  Type of timestamp, e.g., epoch_seconds, iso8601, etc.

• wait_until_complete

  (bool, default: True ) –

  If true, block until data has been ingested

• file_name

  (str | None, default: None ) –

  Manually override the name of the filename given to the uploaded data. If not provided, defaults to using the dataset's name

• tag_columns

  (Mapping[str, str] | None, default: None ) –

  Mapping of column names => tag keys to use for their respective rows.

• tags

  (Mapping[str, str] | None, default: None ) –

  Mapping of key-value pairs to apply uniformly as tags to all data within the dataframe.

Channels will be named as f"{group_name}.{channel_name}", with spaces replaced with underscores.

NOTE: timestamp_column and timestamp_type must both be provided or excluded together.