io4edge-client 2.6.3.dev0__tar.gz → 2.6.5__tar.gz

{io4edge_client-2.6.3.dev0 → io4edge_client-2.6.5}/.gitignore

@@ -131,3 +131,5 @@ dmypy.json
 *.vcd
 
 *.bin
+
+io4edge_client/_version.py

io4edge_client-2.6.5/.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "python-envs.pythonProjects": [
+        {
+            "path": ".",
+            "envManager": "ms-python.python:venv",
+            "packageManager": "ms-python.python:pip"
+        }
+    ]
+}

{io4edge_client-2.6.3.dev0 → io4edge_client-2.6.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: io4edge_client
-Version: 2.6.3.dev0
+Version: 2.6.5
 Summary: Python client for io4edge devices
 Author-email: Ci4Rail GmbH <engineering@ci4rail.com>, EKF GmbH <info@ekf.com>
 License-Expression: Apache-2.0

io4edge_client-2.6.5/io4edge_client/__init__.py

@@ -0,0 +1,99 @@
+# SPDX-License-Identifier: Apache-2.0
+
+from pathlib import Path
+import re
+import subprocess
+
+# Import all client classes with descriptive names
+from .analogintypea import Client as AnalogInTypeAClient
+from .analogintypeb import Client as AnalogInTypeBClient
+from .binaryiotypea import Client as BinaryIoTypeAClient
+from .binaryiotypeb import Client as BinaryIoTypeBClient
+from .binaryiotypec import Client as BinaryIoTypeCClient
+from .binaryiotyped import Client as BinaryIoTypeDClient
+from .bitbussniffer import Client as BitbusSnifferClient
+from .canl2 import Client as CanL2Client
+from .colorLED import Client as ColorLEDClient
+from .digiwave import Client as DigiwaveClient
+from .eeprom import Client as EepromClient
+from .mvbsniffer import Client as MvbSnifferClient
+from .pixelDisplay import Client as PixelDisplayClient
+from .ssm import Client as SsmClient
+# from .watchdog import Client as WatchdogClient
+
+# Import core clients
+from .core import CoreClient
+from .functionblock import Client as FunctionblockClient
+
+# This create _version.py file if it doesn't exist,
+# using git describe to generate version information
+# Use when running from source, but will be ignored when installed via pip (since _version.py is in .gitignore)
+def _version_tuple_from_git() -> tuple:
+    package_dir = Path(__file__).resolve().parent
+    repo_dir = package_dir.parent
+
+    try:
+        describe = subprocess.run(
+            ["git", "describe", "--tags", "--long", "--dirty", "--always"],
+            cwd=repo_dir,
+            check=True,
+            capture_output=True,
+            text=True,
+        ).stdout.strip()
+    except (OSError, subprocess.CalledProcessError):
+        return (0, 0, 0, "dev0")
+
+    match = re.match(r"^v?(\d+)\.(\d+)\.(\d+)-(\d+)-g[0-9a-f]+(?:-dirty)?$", describe)
+    if not match:
+        return (0, 0, 0, "dev0")
+
+    major, minor, patch, distance = (int(part) for part in match.groups())
+    if distance == 0 and not describe.endswith("-dirty"):
+        return (major, minor, patch)
+
+    return (major, minor, patch + 1, f"dev{distance}")
+
+
+def _ensure_version_file() -> None:
+    version_path = Path(__file__).resolve().with_name("_version.py")
+    if version_path.exists():
+        return
+
+    generated_version = _version_tuple_from_git()
+    version_path.write_text(
+        "# SPDX-License-Identifier: Apache-2.0\n"
+        f"version = {generated_version!r}\n"
+        'VERSION = ".".join(str(x) for x in version)\n',
+        encoding="utf-8",
+    )
+
+
+# Version information
+_ensure_version_file()
+from ._version import version, VERSION
+
+__all__ = [
+    # Device-specific clients
+    "AnalogInTypeAClient",
+    "AnalogInTypeBClient",
+    "BinaryIoTypeAClient",
+    "BinaryIoTypeBClient",
+    "BinaryIoTypeCClient",
+    "BinaryIoTypeDClient",
+    "BitbusSnifferClient",
+    "CanL2Client",
+    "ColorLEDClient",
+    "DigiwaveClient",
+    "EepromClient",
+    "MvbSnifferClient",
+    "PixelDisplayClient",
+    "SsmClient",
+
+    # Core clients
+    "CoreClient",
+    "FunctionblockClient",
+
+    # Version
+    "version",
+    "VERSION"
+]

{io4edge_client-2.6.3.dev0 → io4edge_client-2.6.5}/io4edge_client/_version.py

@@ -1,3 +1,3 @@
 # SPDX-License-Identifier: Apache-2.0
-version = (2, 6, 3, 'dev0')
+version = (2, 6, 5)
 VERSION = ".".join(str(x) for x in version)

io4edge_client-2.6.5/io4edge_client/api/.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/universal
+{
+	"name": "Protobuf Dev Container",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	// based on Ubuntu 24.04.3
+	"image": "mcr.microsoft.com/devcontainers/base:ubuntu-24.04",
+	"features": {
+		"ghcr.io/devcontainers/features/python:1": {},
+		"ghcr.io/devcontainers/features/go:1": {
+			"version": "1.25.1"
+		}
+	},
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "./install_tools_ubuntu.sh",
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"zxh404.vscode-proto3",
+				"twxs.cmake",
+				"github.copilot",
+				"golang.go"
+			]
+		}
+	}
+}

io4edge_client-2.6.5/io4edge_client/api/.github/workflows/generate.yaml

@@ -0,0 +1,40 @@
+name: generate code
+on:
+  push:
+    branches: [ main, ci ]
+
+permissions:
+  contents: write        # allow pushing back to the repo
+
+jobs:
+  generate:
+    env:
+      GO_VERSION: '1.25.1'
+    runs-on: ubuntu-24.04   
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0    
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: install tools
+        run: ./install_tools_ubuntu.sh
+
+      - name: generate code
+        run: make clean && make build
+
+      - name: push generated code
+        run: |
+          if [[ -n "$(git status --porcelain)" ]]; then
+            git config --local user.email "actions@github.com"
+            git config --local user.name "GitHub Actions"
+            git add --all
+            git commit -m 'ci: Generate code from protobuf files'
+            git push
+          else
+            echo "No changes to commit"
+          fi

io4edge_client-2.6.5/io4edge_client/api/.gitignore

@@ -0,0 +1,4 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class

io4edge_client-2.6.5/io4edge_client/api/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: trailing-whitespace
+        # note: whitespace exclusions use multiline regex, see https://pre-commit.com/#regular-expressions
+        # items are:
+        # 1 - some file extensions
+        # 2 - any file matching *test*/*expected* (for host tests, if possible use this naming pattern always)
+        # 3 - any directory named 'testdata'
+        # 4 - IDF monitor test data
+        exclude: &whitespace_excludes |
+          (?x)^(
+            .+\.(md|rst|map|bin|py)|
+            .+test.*\/.*expected.*|
+            .+\/testdata\/.+|
+            .+test_idf_monitor\/tests\/.+
+          )$
+      - id: end-of-file-fixer
+        exclude: *whitespace_excludes
+      - id: check-executables-have-shebangs
+      - id: mixed-line-ending
+        args: ["-f=lf"]
+      - id: double-quote-string-fixer
+        exclude: *whitespace_excludes
+  - repo: https://github.com/pocc/pre-commit-hooks
+    rev: 093614db90b54cca053c04de00128d70c638b4c2
+    hooks:
+      - id: clang-format
+        exclude: ^(?x).+\.pb-c\.[ch]
+        args: ["--style=file", "-i"]

io4edge_client-2.6.5/io4edge_client/api/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Ci4Rail
+
+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.

io4edge_client-2.6.5/io4edge_client/api/Makefile

@@ -0,0 +1,9 @@
+SUBDIRS := $(dir $(wildcard */Makefile))
+
+TOPTARGETS := build clean
+
+$(TOPTARGETS): $(SUBDIRS)
+$(SUBDIRS):
+	@$(MAKE) -C $@ $(MAKECMDGOALS)
+
+.PHONY: $(TOPTARGETS) $(SUBDIRS)

io4edge_client-2.6.5/io4edge_client/api/README.md

@@ -0,0 +1,18 @@
+# io4edge_api
+
+This repository contain all proto files for communicate with io4edge modules.
+
+## How to build
+
+Run this repo from a vscode devcontainer. (CTRL+SHIFT+P -> Remote-Containers: Open Folder in Container, or clone the repo in the devcontainer)
+
+Run `make` to generate all the files.
+
+Currently implemented:
+- golang
+- protobuf-c 
+- python
+
+# CI 
+
+When you push to main, the CI will build the go/python/protobuf-c files and check if the files are up to date. If not, the CI will push the changes to the main branch.

io4edge_client-2.6.5/io4edge_client/api/analogInTypeA/Makefile

@@ -0,0 +1,3 @@
+MODULE := analogInTypeA/v1alpha1
+PROTOS := analogInTypeA.proto
+include ../rules.mk