OpenSMI-Core 0.1__py3-none-any.whl

opensmi/core/unit_base.py

@@ -0,0 +1,71 @@
+# SPDX-FileCopyrightText: 2026 OpenSMI Contributors
+#
+# SPDX-License-Identifier: MIT
+
+"""Base class for all autogenerated units, see `Unit`."""
+
+from enum import Enum
+from typing import Self
+
+from asyncua import ua
+
+
+class BaseUnit(Enum):
+    """Base class for all autogenerated units, see `Unit`."""
+
+    @property
+    def symbol(self) -> str:
+        """Symbol of the Unit, e.g. ``cm`` for centimeters."""
+        return self.value[0]
+
+    @classmethod
+    def from_ua_unit_id(cls, ua_unit_id: int) -> Self:
+        """Return the unique unit corresponding to given OPC UA unit ID."""
+        for unit in cls:
+            if unit.ua_unit_id == ua_unit_id:
+                return unit
+
+        msg = f"Unknown OPC UA unit ID: {ua_unit_id}"
+        raise ValueError(msg)
+
+    @classmethod
+    def from_symbol(cls, symbol: str) -> Self:
+        """Return the unique unit corresponding to given symbol.
+
+        :raises ValueError: if the symbol is not valid or ambiguous.
+        """
+        matches = [unit for unit in cls if unit.symbol == symbol]
+
+        if not matches:
+            msg = f"Unknown Unit symbol: {symbol}"
+            raise ValueError(msg)
+
+        if len(matches) > 1:
+            ua_unit_ids = ", ".join(str(unit.ua_unit_id) for unit in matches)
+            msg = f"Ambiguous Unit symbol {symbol!r}; unit IDs: {ua_unit_ids}"
+            raise ValueError(msg)
+
+        return matches[0]
+
+    @property
+    def ua_unit_id(self) -> int:
+        """OPC UA Unit ID for the unit."""
+        return self.value[1]
+
+    @property
+    def ua_eu_information(self) -> ua.EUInformation:
+        """Return the OPC UA EU information."""
+        return ua.EUInformation(
+            NamespaceUri="http://www.opcfoundation.org/UA/units/un/cefact",  # type: ignore
+            UnitId=ua.Int32(self.ua_unit_id),  # type: ignore
+            DisplayName=ua.LocalizedText(self.symbol),
+            Description=ua.LocalizedText(self.name),
+        )
+
+    def __str__(self) -> str:
+        """Symbol of the Unit."""
+        return self.symbol
+
+    def __repr__(self) -> str:
+        """Descriptive string representation of the Unit."""
+        return f"{type(self).__name__}.{self.name}(symbol={self.symbol!r}, ua_unit_id={self.ua_unit_id!r})"

opensmi/core/unset.py

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: 2026 OpenSMI Contributors
+#
+# SPDX-License-Identifier: MIT
+
+"""Sentinel to distinguish unset values from ``None`` values."""
+
+from typing import Final, TypeGuard, TypeVar
+
+_T = TypeVar("_T")
+
+
+class Unset:
+    """Sentinel to distinguish unset values from ``None`` values."""
+
+
+UNSET: Final = Unset()
+"""Singleton instance to signal unset values."""
+
+
+def is_set(value: _T | Unset) -> TypeGuard[_T]:
+    """Return ``True`` if given ``value`` is set."""
+    return value is not UNSET

opensmi_core-0.1.dist-info/METADATA

@@ -0,0 +1,32 @@
+Metadata-Version: 2.4
+Name: OpenSMI-Core
+Version: 0.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.1.dist-info/RECORD

@@ -0,0 +1,28 @@
+opensmi/core/__init__.py,sha256=myy_q8shptZwUKBXa8ayckKTzY7VzzeRKvHPWz1mKIs,800
+opensmi/core/async_task_mixin.py,sha256=wZEGutRM1s15Qblk-qb_2AhIupOYiNarcj-pstM5GcI,1576
+opensmi/core/base_server.py,sha256=FYlR_06yusIGp03TrBTu-_mdEKeq-WrTbTgjwXX9e14,2781
+opensmi/core/base_ua_object.py,sha256=E8ymdpUn21hGtGlo7Vjvg8aBcaO2nPPdxk_afdPxCjI,3752
+opensmi/core/config.py,sha256=Q2fevnPE_F6nRG8Mz_5aIi3L9ioDf97WJmlrQREokiA,3183
+opensmi/core/enums.py,sha256=UStae4GL9s_kEl3ZGFWAWOU_0_EQdIyYe_98t6RnGxQ,915
+opensmi/core/errors.py,sha256=V8QNFsnTZP7dLVSrHN8yPWrqLIy6vwsFQQH3A_-pKks,1981
+opensmi/core/frozen.py,sha256=tH9Owkg_olSCZB4Y_Qhv9yYQKrovJCKFP2xKXa4-oW0,781
+opensmi/core/hook.py,sha256=nCBB26Y-QNn3oUVLe8fl-X72ujQcrPmC2nor12Nz_jA,685
+opensmi/core/lifecycle_mixin.py,sha256=Oswjdf4EPGFnx6EImK9SlwcyIB5mIMhhhugckVKYNNU,11158
+opensmi/core/logging.py,sha256=k6T_lg8uyc7n-s5o4ZQp5Fb-w_FB0xvzyc8FsbhklqM,5262
+opensmi/core/meta.py,sha256=TYQuohKPX8b7Dnjdf4mfa3HiRPQr9tZNCQlrYFOb-Kw,1575
+opensmi/core/mixin_helpers.py,sha256=iAIGTrG_C_6wGRHgAoiXKTMvGuGUoqUlQyMsvS3q9Oo,498
+opensmi/core/protocols.py,sha256=A4pQx3eCDbe4GFQr2wcL2e6eIbOSPVuIjxuMZFVIYSY,700
+opensmi/core/repr_mixin.py,sha256=rbeuNKziv8VGJg3ZP9R6bCc1z8V4kiOKFZ-5UfdIddI,1127
+opensmi/core/signal.py,sha256=vQLtVuGCB_W3i0mkjTSgh8P8BA5g5WYsz-v7ewwRpMs,1170
+opensmi/core/subscription_manager.py,sha256=OulHPIVFzewZWa5tV5T35g91Cqb8dmLHKYXLtoR2SxE,8461
+opensmi/core/ua.py,sha256=0HsWOsZwbjvt6EXhq7YLEbsi7Rmz0Dq2BCiVDirlL54,328
+opensmi/core/ua_enums.py,sha256=WkcGXFZJXOJaTUiq1T8inC18uQeQFTnycalUikscQ6c,3902
+opensmi/core/ua_node_util.py,sha256=6r0D7fBXX2LJx3l12hVo5fkxeDIeziXFmzGgD2QtlH8,9496
+opensmi/core/unit_all.py,sha256=V_Q9VjEFxm_KyU2NY7aduGmjOOT1d8YLtzApbaMn2qY,102964
+opensmi/core/unit_base.py,sha256=xY1EYy1sw-34FHr5I1-XxZ2ASE2iH8Zf8RmX1WWi_04,2240
+opensmi/core/unset.py,sha256=ki6fQ6QEvyIHz4oDKMs2O9nAYRS6rXoMsblurvHZhVI,508
+opensmi_core-0.1.dist-info/licenses/LICENSE,sha256=3OGTGWBqU2ALHuARh4vkKHT1dXxm5TXYO7OL0k7JUuI,1078
+opensmi_core-0.1.dist-info/METADATA,sha256=I8VrRtEXSHSy5rvfxevVTzGU6R2E8gm2Bi7F-gYI5-M,1423
+opensmi_core-0.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+opensmi_core-0.1.dist-info/top_level.txt,sha256=RNwRHgN-Y6DKEdMS39Fx2JG5UVX9gQ0t2Cw8X8hmIqM,8
+opensmi_core-0.1.dist-info/RECORD,,

opensmi_core-0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

opensmi_core-0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2026 OpenSMI Contributors.
+
+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.

opensmi_core-0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+opensmi