ASAM ODS EXD-API dydaglog csv plugin

This repository contains a ASAM ODS EXD-API plugin used to read dydaglog csv files.

GRPC stub

Because the repository does not contain the ASAM ODS protobuf files the generated stubs are added. The files that match *_pb2* are generated using the following command. To renew them you must put the proto files from the ODS standard into proto_src and rerun the command.

python -m grpc_tools.protoc --proto_path=proto_src --pyi_out=. --python_out=. --grpc_python_out=. ods.proto ods_external_data.proto

Content

exd_api_server.py

Runs the GRPC service to be accessed using http-2.

external_data_reader.py

Implements the EXD-API interface to access CSV files using pandas.

exd_api_test.py

Some basic tests on example files in data folder.

example_access_exd_api.ipynb

jupyter notebook the shows communication done by ASAM ODS server or Importer using the EXD-API plugin.

Usage in ODS Server

sequenceDiagram

actor CLIENT as Client
participant PDTT as 🛠️Importer
participant PODS as 🗃️ASAM ODS server
participant PLUGIN as 📊EXD-API plugin
participant FILE as 🗂️File Storage

autonumber

opt Import phase
  FILE ->>+ PDTT: New file shows up
  PDTT ->>+ PLUGIN : Get Structure
  PLUGIN -> FILE: Extract content information
  PLUGIN ->> PLUGIN: Create Structure
  PLUGIN ->>- PDTT: Return Structure
  PDTT ->> PODS: Import ODS structure
  Note right of PDTT: Create hierarchy<br/>AoTest,AoMeasurement,...
  PDTT ->>- PODS: Add External Data info
  Note right of PDTT: Attach AoFile ... for external data<br/>AoFile,AoSubmatrix,AoLocalColumn,...
end

Note over CLIENT, FILE: Now we can work with the imported files

loop Runtime phase
  CLIENT ->> PODS: Establish ODS session
  CLIENT ->> PODS: Work with meta data imported from structure
  CLIENT ->> PODS: Access external channel in preview
  PODS ->> PLUGIN: GetValues
  PLUGIN ->> FILE: Get Channel values
  PLUGIN ->> PODS: Return values of channels
  PODS ->> CLIENT: Return values needed for plot
end

Loading

Docker

Docker Image Details

The Docker image for this project is available at:

ghcr.io/peak-solution/asam-ods-exd-api-dydaqlog-csv:latest

This image is automatically built and pushed via a GitHub Actions workflow. To pull and run the image:

docker pull ghcr.io/peak-solution/asam-ods-exd-api-dydaqlog-csv:latest
docker run -v /path/to/local/data:/data -p 50051:50051 ghcr.io/peak-solution/asam-ods-exd-api-dydaqlog-csv:latest

Using the Docker Container

To build the Docker image locally:

docker build -t asam-ods-exd-api-dydaqlog-csv .

To start the Docker container:

docker run -v /path/to/local/data:/data -p 50051:50051 asam-ods-exd-api-dydaqlog-csv