OpenSMI-Core 0.2.1__tar.gz → 0.3__tar.gz

opensmi_core-0.3/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: OpenSMI-Core
+Version: 0.3
+Summary: Smart Machine Interface core functionality for server and client applications.
+Author-email: Carsten Harms <Carsten.Harms@dfki.de>, Simon Jungbluth <Simon.Jungbluth@smartfactory.de>
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSES/MIT.txt
+Requires-Dist: asyncua<3,>=2.0.1
+Requires-Dist: structlog>=26
+Requires-Dist: typing-extensions>=4.16.0
+Provides-Extra: rich
+Requires-Dist: rich>=15.0.0; extra == "rich"
+Requires-Dist: colorama>=0.4; sys_platform == "win32" and extra == "rich"
+Provides-Extra: json
+Requires-Dist: orjson<4,>=3; extra == "json"
+Dynamic: license-file
+
+![OpenSMI Logo](https://smartfactory.de/wp-content/uploads/2026/09/Logo_OpenSMI.png)
+
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://smartfactory-kl.github.io/opensmi-core/)
+[![PyPI version](https://img.shields.io/pypi/v/opensmi-core.svg)](https://pypi.org/project/opensmi-core/)
+[![Python versions](https://img.shields.io/pypi/pyversions/opensmi-core.svg)](https://pypi.org/project/opensmi-core/)
+[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+
+# OpenSMI Core
+
+Core functionality for other OpenSMI packages such as:
+
+- [OpenSMI Client](https://github.com/SmartFactory-KL/opensmi-client)
+- [OpenSMI Server](https://github.com/SmartFactory-KL/opensmi-server)
+
+## Features
+
+- (Nested) Configuration parsing into dataclasses from TOML files (See [config.py](src/opensmi/core/config.py))
+- Lifecycle management via mixin and `@lifecycle` decorators, allowing explicit ordering 
+  (See [lifecycle_mixin.py](src/opensmi/core/lifecycle_mixin.py))
+- Simple callbacks via `Signal` (similar to [aiosignal](https://pypi.org/project/aiosignal/), but without freezing)
+  (See [signal.py](src/opensmi/core/signal.py))
+- [asyncua](https://pypi.org/project/asyncua/) (OPC UA) helpers 
+  - Node helper functions (See [ua_node_util.py](src/opensmi/core/ua_node_util.py))
+  - SubscriptionManager (See [subscription_manager.py](src/opensmi/core/subscription_manager.py))
+- Enums for OpenSMI machine, component and skill states
+- All [UN/CEFACT-Rec20](https://unece.org/trade/documents/2021/06/uncefact-rec20-0) units as a type-checkable enum. 
+  (See [unit_all.py](src/opensmi/core/unit_all.py))
+- [Structured Logging](https://pypi.org/project/structlog/) configuration (See [logging.py](src/opensmi/core/logging.py))
+
+> [!warning]
+> This library is currently pre-1.0 — expect refactoring outside above-mentioned functionality.
+
+## Installation
+
+Requires Python 3.11+.
+
+```bash
+pip install opensmi-core
+```
+
+## Project Status
+
+OpenSMI began as a closed-source project at [SmartFactory-KL](https://smartfactory.de/), in active use in our model
+factory since 2020. Its OPC UA information model has been refined across many iterations of research and
+demonstrator use. The framework was open-sourced in 2026 following substantial refactoring and cleanup.
+
+## License
+
+[MIT License](LICENSE)

{opensmi_core-0.2.1 → opensmi_core-0.3}/pyproject.toml

@@ -5,12 +5,14 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "OpenSMI-Core"
 dynamic = ["version"]
-
+readme = "README.md"
 description = "Smart Machine Interface core functionality for server and client applications."
 authors = [
     { name = "Carsten Harms", email = "Carsten.Harms@dfki.de" },
     { name = "Simon Jungbluth", email = "Simon.Jungbluth@smartfactory.de" },
 ]
+license = "MIT"
+license-files = ["LICENSES/MIT.txt"]
 
 # see https://pypi.org/classifiers/
 classifiers = [

opensmi_core-0.3/src/OpenSMI_Core.egg-info/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: OpenSMI-Core
+Version: 0.3
+Summary: Smart Machine Interface core functionality for server and client applications.
+Author-email: Carsten Harms <Carsten.Harms@dfki.de>, Simon Jungbluth <Simon.Jungbluth@smartfactory.de>
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSES/MIT.txt
+Requires-Dist: asyncua<3,>=2.0.1
+Requires-Dist: structlog>=26
+Requires-Dist: typing-extensions>=4.16.0
+Provides-Extra: rich
+Requires-Dist: rich>=15.0.0; extra == "rich"
+Requires-Dist: colorama>=0.4; sys_platform == "win32" and extra == "rich"
+Provides-Extra: json
+Requires-Dist: orjson<4,>=3; extra == "json"
+Dynamic: license-file
+
+![OpenSMI Logo](https://smartfactory.de/wp-content/uploads/2026/09/Logo_OpenSMI.png)
+
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://smartfactory-kl.github.io/opensmi-core/)
+[![PyPI version](https://img.shields.io/pypi/v/opensmi-core.svg)](https://pypi.org/project/opensmi-core/)
+[![Python versions](https://img.shields.io/pypi/pyversions/opensmi-core.svg)](https://pypi.org/project/opensmi-core/)
+[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+
+# OpenSMI Core
+
+Core functionality for other OpenSMI packages such as:
+
+- [OpenSMI Client](https://github.com/SmartFactory-KL/opensmi-client)
+- [OpenSMI Server](https://github.com/SmartFactory-KL/opensmi-server)
+
+## Features
+
+- (Nested) Configuration parsing into dataclasses from TOML files (See [config.py](src/opensmi/core/config.py))
+- Lifecycle management via mixin and `@lifecycle` decorators, allowing explicit ordering 
+  (See [lifecycle_mixin.py](src/opensmi/core/lifecycle_mixin.py))
+- Simple callbacks via `Signal` (similar to [aiosignal](https://pypi.org/project/aiosignal/), but without freezing)
+  (See [signal.py](src/opensmi/core/signal.py))
+- [asyncua](https://pypi.org/project/asyncua/) (OPC UA) helpers 
+  - Node helper functions (See [ua_node_util.py](src/opensmi/core/ua_node_util.py))
+  - SubscriptionManager (See [subscription_manager.py](src/opensmi/core/subscription_manager.py))
+- Enums for OpenSMI machine, component and skill states
+- All [UN/CEFACT-Rec20](https://unece.org/trade/documents/2021/06/uncefact-rec20-0) units as a type-checkable enum. 
+  (See [unit_all.py](src/opensmi/core/unit_all.py))
+- [Structured Logging](https://pypi.org/project/structlog/) configuration (See [logging.py](src/opensmi/core/logging.py))
+
+> [!warning]
+> This library is currently pre-1.0 — expect refactoring outside above-mentioned functionality.
+
+## Installation
+
+Requires Python 3.11+.
+
+```bash
+pip install opensmi-core
+```
+
+## Project Status
+
+OpenSMI began as a closed-source project at [SmartFactory-KL](https://smartfactory.de/), in active use in our model
+factory since 2020. Its OPC UA information model has been refined across many iterations of research and
+demonstrator use. The framework was open-sourced in 2026 following substantial refactoring and cleanup.
+
+## License
+
+[MIT License](LICENSE)

opensmi_core-0.3/src/OpenSMI_Core.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.3",
+  "distance": 0,
+  "node": "g9a34c7edc8c3a53e37ec1e87441c3e25c2626982",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-07"
+}

{opensmi_core-0.2.1 → opensmi_core-0.3}/src/opensmi/core/subscription_manager.py

@@ -4,10 +4,13 @@
 
 from __future__ import annotations
 
+import asyncio
 import contextlib
+import time
 from abc import ABC, abstractmethod
+from asyncio import Task
 from collections.abc import Iterable
-from typing import Any
+from typing import Any, Never
 
 import structlog
 from asyncua import ua
@@ -46,49 +49,74 @@ class SubscriptionManager:
     _ua_client: Client
     _ua_subscription: Subscription
 
-    def __init__(self) -> None:
-        """Create a new instance."""
+    def __init__(
+        self,
+        *,
+        ua_client: Client,
+        publishing_interval_ms: float = 100,
+        heartbeat_stale_after: float = 10.0,
+    ) -> None:
+        """Create a new instance.
+
+        :param ua_client: OPC UA client to use.
+        :param publishing_interval_ms: Publishing interval in milliseconds for OPC UA subscription
+        :param heartbeat_stale_after: Time in seconds until any subscription should be received.
+        """
+        self._publishing_interval_ms = publishing_interval_ms
+        self._ua_client = ua_client
+
         self._data_subscription_map: dict[NodeId, list[UaDataChangeSubscriber]] = {}
         """ Maps a OPC UA node to a list of handlers for data change notifications. """
         self._event_subscription_map: dict[NodeId, list[UaEventSubscriber]] = {}
         """ Maps a OPC UA node to a list of handlers for event notifications. """
 
-        self.period: float = 100
-        """Publishing interval in milliseconds for OPC UA subscription."""
+        self._heartbeat_task: Task[Never] | None = None
+        self._last_heartbeat = time.monotonic()
+        self._heartbeat_stale_after = heartbeat_stale_after
 
         self.logger = structlog.getLogger("opensmi.SubscriptionManager")
 
-    async def _create_subscription(self, ua_client: Client):
-        self._ua_subscription = await ua_client.create_subscription(period=self.period, handler=self)
+    async def _create_subscription(self) -> None:
+        self._ua_subscription = await self._ua_client.create_subscription(
+            period=self._publishing_interval_ms, handler=self
+        )
         self.logger.info("Created subscription!", parameters=self._ua_subscription.parameters)
 
-    async def init(self, ua_client: Client, period: float = 100) -> None:
-        self.period = period
-        self._ua_client = ua_client
-        await self._create_subscription(ua_client)
+    async def init(self) -> None:
+        await self._create_subscription()
 
         # subscribe to a node that always changes reliably, for example the current time of the server
         # this is done to prevent the subscription from timing out
-        current_time_node = ua_client.get_node(ua.object_ids.ObjectIds.Server_ServerStatus_CurrentTime)
+        current_time_node = self._ua_client.get_node(ua.object_ids.ObjectIds.Server_ServerStatus_CurrentTime)
         await self.subscribe_data_change(self, current_time_node)  # pyright: ignore[reportArgumentType]
 
-    # async def renew_subscriptions(self, ua_client: Client) -> None:
-    #     self.logger.info(f"Renewing {self.no_of_monitored_items} subscriptions...")
-    #     old_data_subscription_map = self._data_subscription_map.copy()
-    #     old_event_subscription_map = self._event_subscription_map.copy()
-    #
-    #     await self.clear_subscriptions()
-    #     await self._create_subscription(ua_client)
-    #
-    #     # add all old data change subscriptions back
-    #     for node_id, handlers in old_data_subscription_map.items():
-    #         for handler in handlers:
-    #             await self.subscribe_data_change(handler=handler, nodes=[ua_client.get_node(node_id)])
-    #
-    #     # add all old event subscriptions back
-    #     for node_id, handlers in old_event_subscription_map.items():
-    #         for handler in handlers:
-    #             await self.subscribe_event(handler=handler, source_node=node_id)
+        self._last_heartbeat = time.monotonic()
+        self._heartbeat_task = asyncio.create_task(self._heartbeat_loop(), name="heartbeat_task")
+
+    async def _renew_subscriptions(self) -> None:
+        self.logger.info(f"Trying to renew {self.no_of_monitored_items} subscriptions...")
+        old_data_subscription_map = self._data_subscription_map.copy()
+        old_event_subscription_map = self._event_subscription_map.copy()
+
+        await self.clear_subscriptions()
+        while True:
+            try:
+                await self._create_subscription()
+                # add all old data change subscriptions back
+                for node_id, handlers in old_data_subscription_map.items():
+                    for handler in handlers:
+                        await self.subscribe_data_change(handler=handler, nodes=[self._ua_client.get_node(node_id)])
+
+                # add all old event subscriptions back
+                for node_id, handlers in old_event_subscription_map.items():
+                    for handler in handlers:
+                        await self.subscribe_event(handler=handler, source_node=node_id)
+
+                self.logger.info("Successfully renewed subscriptions")
+                break
+            except Exception as err:
+                self.logger.warning("Could not renew subscriptions!", reason=err)
+                await asyncio.sleep(1)
 
     async def clear_subscriptions(self) -> None:
         self.logger.info(f"Clearing {self.no_of_monitored_items} subscriptions...")
@@ -160,11 +188,24 @@ class SubscriptionManager:
         await self._ua_subscription.subscribe_events(sourcenode=source_node)
         self._event_subscription_map[node_id].append(handler)
 
+    async def _heartbeat_loop(self) -> Never:
+        while True:
+            await asyncio.sleep(self._heartbeat_stale_after / 4)
+            try:
+                stale_for = time.monotonic() - self._last_heartbeat
+                if stale_for > self._heartbeat_stale_after:
+                    self.logger.warning("Heartbeat stale, subscriptions presumed dead", stale_for=stale_for)
+                    await self._renew_subscriptions()
+            except Exception as err:
+                self.logger.warning("Heartbeat check failed", reason=err)
+
     ###########################################
     # asyncua callbacks
 
     async def datachange_notification(self, node: Node, val: Any, data: DataChangeNotif) -> None:
         """Handle OPC UA data change notifications callback."""
+        self._last_heartbeat = time.monotonic()
+
         try:
             for handler in self._data_subscription_map[node.nodeid]:  # list of handlers
                 if handler == self:
@@ -181,6 +222,8 @@ class SubscriptionManager:
 
     async def event_notification(self, ua_event: UaEvent) -> None:
         """Handle OPC UA event notifications callback."""
+        self._last_heartbeat = time.monotonic()
+
         # TODO(CaHa): ua_event.emitting_node is always i=2253 (=Server)
         # might be an asyncua problem
         try:

opensmi_core-0.2.1/PKG-INFO

@@ -1,32 +0,0 @@
-Metadata-Version: 2.4
-Name: OpenSMI-Core
-Version: 0.2.1
-Summary: Smart Machine Interface core functionality for server and client applications.
-Author-email: Carsten Harms <Carsten.Harms@dfki.de>, Simon Jungbluth <Simon.Jungbluth@smartfactory.de>
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: Manufacturing
-Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Topic :: Communications
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
-Classifier: Topic :: Software Development :: Embedded Systems
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Typing :: Typed
-Requires-Python: >=3.11
-License-File: LICENSE
-Requires-Dist: asyncua<3,>=2.0.1
-Requires-Dist: structlog>=26
-Requires-Dist: typing-extensions>=4.16.0
-Provides-Extra: rich
-Requires-Dist: rich>=15.0.0; extra == "rich"
-Requires-Dist: colorama>=0.4; sys_platform == "win32" and extra == "rich"
-Provides-Extra: json
-Requires-Dist: orjson<4,>=3; extra == "json"
-Dynamic: license-file

opensmi_core-0.2.1/src/OpenSMI_Core.egg-info/PKG-INFO

@@ -1,32 +0,0 @@
-Metadata-Version: 2.4
-Name: OpenSMI-Core
-Version: 0.2.1
-Summary: Smart Machine Interface core functionality for server and client applications.
-Author-email: Carsten Harms <Carsten.Harms@dfki.de>, Simon Jungbluth <Simon.Jungbluth@smartfactory.de>
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: Manufacturing
-Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Topic :: Communications
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
-Classifier: Topic :: Software Development :: Embedded Systems
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Typing :: Typed
-Requires-Python: >=3.11
-License-File: LICENSE
-Requires-Dist: asyncua<3,>=2.0.1
-Requires-Dist: structlog>=26
-Requires-Dist: typing-extensions>=4.16.0
-Provides-Extra: rich
-Requires-Dist: rich>=15.0.0; extra == "rich"
-Requires-Dist: colorama>=0.4; sys_platform == "win32" and extra == "rich"
-Provides-Extra: json
-Requires-Dist: orjson<4,>=3; extra == "json"
-Dynamic: license-file

opensmi_core-0.2.1/src/OpenSMI_Core.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "0.2.1",
-  "distance": 0,
-  "node": "ga8edabe8cc0987a9434f135a0b149bc312ad6458",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-10-06"
-}