initial commit

Author: a.krantz

.devcontainer/devcontainer.json

@@ -0,0 +1,44 @@
+{
+    "name": "Jupyter Dev Container",
+    "image": "mcr.microsoft.com/vscode/devcontainers/python:3.12",
+    "features": {
+        "docker-in-docker": "latest"
+    },
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "github.vscode-pull-request-github",
+                "github.vscode-github-actions",
+                "ms-toolsai.python-ds-extension-pack",
+                "ms-python.vscode-pylance",
+                "ms-python.flake8",
+                "ms-python.black-formatter",
+                "ms-python.isort",
+                "streetsidesoftware.code-spell-checker",
+                "ms-vscode.live-server",
+                "GitHub.copilot"
+            ],
+            "settings": {
+                "python.defaultInterpreterPath": "/usr/local/bin/python",
+                "black-formatter.path": [
+                    "/usr/local/py-utils/bin/black"
+                ],
+                "pylint.path": [
+                    "/usr/local/py-utils/bin/pylint"
+                ],
+                "flake8.path": [
+                    "/usr/local/py-utils/bin/flake8"
+                ],
+                "isort.path": [
+                    "/usr/local/py-utils/bin/isort"
+                ],
+                "terminal.integrated.shell.linux": "/bin/bash"
+            }
+        }
+    },
+    "postCreateCommand": "python -m pip install --upgrade pip && pip install jupyterlab odsbox[exd-data] matplotlib grpcio grpcio-tools pandas openpyxl xlrd",
+    "forwardPorts": [
+        8888
+    ],
+    "remoteUser": "vscode"
+}

.gitattribute

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.github/workflows/python-package.yml

@@ -0,0 +1,37 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        flake8 . --count --max-complexity=22 --max-line-length=200 --statistics --exclude=*pb2*,test*.py
+    - name: Test with unittest
+      run: |
+        python -m unittest

.gitignore

@@ -0,0 +1,5 @@
+*.proto
+.venv/
+.vscode/
+__pycache__/
+/data/examples/internal_test_files/

Dockerfile

@@ -0,0 +1,21 @@
+# docker build --tag docker.peak-solution.de/exd_api/np_mdf4 .
+FROM python:3.12-slim
+WORKDIR /app
+# Install required packages
+COPY requirements.txt requirements.txt
+RUN pip3 install -r requirements.txt
+# Copy ASAM ODS Interface files into container
+## Download from ASAM ODS github repository
+ADD https://raw.githubusercontent.com/asam-ev/ASAM-ODS-Interfaces/main/ods.proto /app/
+ADD https://raw.githubusercontent.com/asam-ev/ASAM-ODS-Interfaces/main/ods_external_data.proto /app/
+## Use local copy
+# COPY proto_src/ods.proto ods.proto
+# COPY proto_src/ods_external_data.proto ods_external_data.proto
+# Use protoc to compile stubs in container
+RUN python3 -m grpc_tools.protoc -I. --python_out=. ods.proto
+RUN python3 -m grpc_tools.protoc -I. --python_out=. --grpc_python_out=. ods_external_data.proto
+# Copy Plugin Implementation
+COPY exd_api_server.py exd_api_server.py
+COPY external_data_reader.py external_data_reader.py
+# Start server
+CMD [ "python3", "exd_api_server.py"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Andreas K
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,68 @@
+# ASAM ODS EXD-API MDF4 plugin
+
+This repository contains a [ASAM ODS EXD-API](https://www.asam.net/standards/detail/ods/) plugin that uses [asammdf](https://pypi.org/project/asammdf/) to read the [ASAM MDF4](https://www.asam.net/standards/detail/mdf/wiki/) files.
+
+> This is only a prototype to check if it works with [asammdf](https://pypi.org/project/asammdf/).
+
+
+## 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](https://github.com/asam-ev/ASAM-ODS-Interfaces) 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
+
+### Implementation
+* [exd_api_server.py](exd_api_server.py)<br>
+  Runs the GRPC service to be accessed using http-2.
+* [external_data_reader.py](external_data_reader.py)<br>
+  Implements the EXD-API interface to access MDF4 files using [asammdf](https://pypi.org/project/asammdf/).
+
+### Tests
+* [test_exd_api.py](test/test_exd_api.py)<br>
+  Some basic tests on example files in `data` folder.
+* [example_access_exd_api_mdf4.ipynb](example_access_exd_api_mdf4.ipynb)<br>
+  jupyter notebook the shows communication done by ASAM ODS server or Importer using the EXD-API plugin.
+
+## Usage in ODS Server
+
+```mermaid
+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
+```