MTPPy2.0 0.1.5__py3-none-any.whl

mtppy/part4/automation_services/base_functions/service_source_mode.py

@@ -0,0 +1,138 @@
+"""Implementation of the Service Source (Selection) Mode as specified in
+PNO MTP 2.0 Part 4, Section 8.2.2.3.
+"""
+
+__copyright__ = (
+    "Copyright (c) 2026 Dresden University of Technology, Process-to-Order Group"
+)
+__license__ = "MIT"
+
+import typing
+from typing import ClassVar
+
+from mtppy.utils.logging import logger
+from mtppy.utils.data_item import DataItem, DataItemCollection
+from mtppy.part3.definitions.mtp_access import MTPAccess
+from mtppy.part5.definitions.w3c_xml_data_types import W3cXmlDataTypes
+
+
+class ServiceSourceMode(DataItemCollection):
+    """The Service Source Selection Mode is a concept that allows the service to select
+    its source of operation based on the state of the service and the configuration
+    parameters.
+
+    It is used to determine whether the service should operate in internal or external
+    mode, and whether it should be in automatic or manual mode.
+
+    - Manual Operations:    Operator actions are conveyed via the `Op` variables.
+    - Automatic Operation:  PEA-internal actions made visible via the `Aut` variables.
+    - Actual Operation:     The actual state of the service is shown in the `Act`
+                            variables.
+
+    Note: The State Variables StateChannel, StateIntOp, a.s.o. are implemented in class
+    ServiceOperationMode.
+    """
+
+    SRC_CHANNEL = "SrcChannel"
+    SRC_EXT_AUT = "SrcExtAut"
+    SRC_INT_OP = "SrcIntOp"
+    SRC_INT_AUT = "SrcIntAut"
+    SRC_EXT_OP = "SrcExtOp"
+    SRC_INT_ACT = "SrcIntAct"
+    SRC_EXT_ACT = "SrcExtAct"
+
+    CLASS_DATA_ITEMS: ClassVar = {
+        SRC_CHANNEL: DataItem(
+            SRC_CHANNEL,
+            W3cXmlDataTypes.BOOLEAN,
+            MTPAccess.ReadAccess,
+            init_value=False,
+        ),
+        SRC_EXT_AUT: DataItem(
+            SRC_EXT_AUT,
+            W3cXmlDataTypes.BOOLEAN,
+            MTPAccess.ReadAccess,
+            init_value=False,
+        ),
+        SRC_INT_OP: DataItem(
+            SRC_INT_OP,
+            W3cXmlDataTypes.BOOLEAN,
+            MTPAccess.ReadWriteAccess,
+            init_value=False,
+        ),
+        SRC_INT_AUT: DataItem(
+            SRC_INT_AUT,
+            W3cXmlDataTypes.BOOLEAN,
+            MTPAccess.ReadAccess,
+            init_value=False,
+        ),
+        SRC_EXT_OP: DataItem(
+            SRC_EXT_OP,
+            W3cXmlDataTypes.BOOLEAN,
+            MTPAccess.ReadWriteAccess,
+            init_value=False,
+        ),
+        SRC_INT_ACT: DataItem(
+            SRC_INT_ACT,
+            W3cXmlDataTypes.BOOLEAN,
+            MTPAccess.ReadAccess,
+            init_value=False,
+        ),
+        SRC_EXT_ACT: DataItem(
+            SRC_EXT_ACT,
+            W3cXmlDataTypes.BOOLEAN,
+            MTPAccess.ReadAccess,
+            init_value=False,
+        ),
+    }
+
+    def __init__(self) -> None:
+        """Assign callback functions after parent had set up internal structures."""
+        super().__init__()
+        self.get_item(ServiceSourceMode.SRC_INT_OP).ext_wrt_cb = self.set_src_int_op
+        self.get_item(ServiceSourceMode.SRC_EXT_OP).ext_wrt_cb = self.set_src_ext_op
+
+        self.get_item(ServiceSourceMode.SRC_INT_AUT).int_wrt_cb = self.set_src_int_aut
+        self.get_item(ServiceSourceMode.SRC_EXT_AUT).int_wrt_cb = self.set_src_ext_aut
+
+    def _src_to_off(self) -> None:
+        self[ServiceSourceMode.SRC_INT_ACT] = False
+        self[ServiceSourceMode.SRC_EXT_ACT] = False
+        logger.mtp("ServiceSourceMode is now off")
+
+    def _src_to_int(self) -> None:
+        self[ServiceSourceMode.SRC_INT_ACT] = True
+        self[ServiceSourceMode.SRC_EXT_ACT] = False
+        logger.mtp("ServiceSourceMode is now int")
+
+    def _src_to_ext(self) -> None:
+        self[ServiceSourceMode.SRC_INT_ACT] = False
+        self[ServiceSourceMode.SRC_EXT_ACT] = True
+        logger.mtp("ServiceSourceMode is now ext")
+
+    @typing.override
+    def set_src_channel(self, value: bool) -> None:
+        self[ServiceSourceMode.SRC_CHANNEL] = value
+        logger.mtp(f"ServiceSourceMode SrcChannel is now {value}")
+
+    @typing.override
+    def set_src_ext_aut(self, value: bool) -> None:
+        if self[ServiceSourceMode.SRC_CHANNEL] and value:
+            self._src_to_ext()
+
+    @typing.override
+    def set_src_ext_op(self, value: bool) -> None:
+        if not self[ServiceSourceMode.SRC_CHANNEL] and value:
+            self._src_to_ext()
+        self[ServiceSourceMode.SRC_EXT_OP] = False
+
+    @typing.override
+    def set_src_int_aut(self, value: bool) -> None:
+        if self[ServiceSourceMode.SRC_CHANNEL] and value:
+            self._src_to_int()
+
+    @typing.override
+    def set_src_int_op(self, value: bool) -> None:
+        if not self[ServiceSourceMode.SRC_CHANNEL] and value:
+            self._src_to_int()
+        self[ServiceSourceMode.SRC_INT_OP] = False

mtppy/part4/automation_services/base_functions/service_source_mode_test.py

@@ -0,0 +1,179 @@
+"""Test Suite for ServiceSourceMode."""
+
+__copyright__ = (
+    "Copyright (c) 2026 Dresden University of Technology, Process-to-Order Group"
+)
+__license__ = "MIT"
+
+import pytest
+
+from mtppy.part4.automation_services.base_functions.service_source_mode import (
+    ServiceSourceMode,
+)
+
+
+def init_service_source_mode(init_mode="int", src_channel=False):
+    service_src_mode = ServiceSourceMode()
+    service_src_mode.set_src_channel(src_channel)
+
+    if init_mode == "int":
+        service_src_mode[ServiceSourceMode.SRC_INT_ACT] = True
+        service_src_mode[ServiceSourceMode.SRC_EXT_ACT] = False
+    elif init_mode == "ext":
+        service_src_mode[ServiceSourceMode.SRC_INT_ACT] = False
+        service_src_mode[ServiceSourceMode.SRC_EXT_ACT] = True
+    else:
+        raise ValueError(f"ServiceSourceMode {init_mode} is unknown")
+
+    return service_src_mode
+
+
+def service_source_mode_is_in_specific_mode(
+    service_src_mode, source_channel_assertion: bool, mode_assertion: str
+):
+    mode = lambda m: (mode_assertion == m)
+    return all(
+        [
+            service_src_mode[ServiceSourceMode.SRC_CHANNEL] == source_channel_assertion,
+            service_src_mode[ServiceSourceMode.SRC_EXT_AUT] == False,
+            service_src_mode[ServiceSourceMode.SRC_INT_OP] == False,
+            service_src_mode[ServiceSourceMode.SRC_INT_AUT] == False,
+            service_src_mode[ServiceSourceMode.SRC_EXT_OP] == False,
+            service_src_mode[ServiceSourceMode.SRC_INT_ACT] == mode("int"),
+            service_src_mode[ServiceSourceMode.SRC_EXT_ACT] == mode("ext"),
+        ]
+    )
+
+
+def test_initial_state():
+    # Initial mode
+    service_src_mode = init_service_source_mode(init_mode="int", src_channel=False)
+    assert service_source_mode_is_in_specific_mode(service_src_mode, False, "int")
+
+
+def test_source_channel_change():
+    # Initial mode
+    service_src_mode = init_service_source_mode()
+    assert service_source_mode_is_in_specific_mode(service_src_mode, False, "int")
+    # Trigger channel change
+    service_src_mode[ServiceSourceMode.SRC_CHANNEL] = True
+    assert service_source_mode_is_in_specific_mode(service_src_mode, True, "int")
+
+    # Trigger channel change back
+    service_src_mode[ServiceSourceMode.SRC_CHANNEL] = False
+    assert service_source_mode_is_in_specific_mode(service_src_mode, False, "int")
+
+
+def test_int_to_ext_src_channel_false():
+    # Initial mode
+    service_src_mode = init_service_source_mode(init_mode="int", src_channel=False)
+    assert (
+        service_source_mode_is_in_specific_mode(service_src_mode, False, "int") == True
+    )
+    # Trigger mode transition
+    service_src_mode.get_item(ServiceSourceMode.SRC_EXT_OP).ext_wrt_cb(True)
+    assert (
+        service_source_mode_is_in_specific_mode(service_src_mode, False, "ext") == True
+    )
+
+
+def test_int_to_ext_src_channel_true():
+    # Initial mode
+    service_src_mode = init_service_source_mode(init_mode="int", src_channel=True)
+    assert (
+        service_source_mode_is_in_specific_mode(service_src_mode, True, "int") == True
+    )
+    # Trigger mode transition
+    service_src_mode.set_src_ext_aut(True)
+    assert (
+        service_source_mode_is_in_specific_mode(service_src_mode, True, "ext") == True
+    )
+
+
+def test_ext_to_int_src_channel_false():
+    # Initial mode
+    service_src_mode = init_service_source_mode(init_mode="ext", src_channel=False)
+    assert (
+        service_source_mode_is_in_specific_mode(service_src_mode, False, "ext") == True
+    )
+    # Trigger mode transition
+    service_src_mode.get_item(ServiceSourceMode.SRC_INT_OP).ext_wrt_cb(True)
+    assert (
+        service_source_mode_is_in_specific_mode(service_src_mode, False, "int") == True
+    )
+
+
+def test_ext_to_int_src_channel_true():
+    # Initial mode
+    service_src_mode = init_service_source_mode(init_mode="ext", src_channel=True)
+    assert (
+        service_source_mode_is_in_specific_mode(service_src_mode, True, "ext") == True
+    )
+    # Trigger mode transition
+    service_src_mode.set_src_int_aut(True)
+    assert (
+        service_source_mode_is_in_specific_mode(service_src_mode, True, "int") == True
+    )
+
+
+def test_source_mode_can_switch_off():
+    service_src_mode = init_service_source_mode(init_mode="ext")
+
+    service_src_mode._src_to_off()
+
+    assert service_source_mode_is_in_specific_mode(service_src_mode, False, "off")
+
+
+@pytest.mark.parametrize(
+    ("method_name", "requested_value", "active_state"),
+    [
+        ("set_src_ext_aut", True, "int"),
+        ("set_src_int_aut", True, "ext"),
+    ],
+)
+def test_automatic_source_request_is_ignored_without_source_channel(
+    method_name, requested_value, active_state
+):
+    service_src_mode = init_service_source_mode(
+        init_mode=active_state, src_channel=False
+    )
+
+    getattr(service_src_mode, method_name)(requested_value)
+
+    assert service_source_mode_is_in_specific_mode(
+        service_src_mode, False, active_state
+    )
+
+
+@pytest.mark.parametrize(
+    ("method_name", "active_state"),
+    [
+        ("set_src_ext_op", "int"),
+        ("set_src_int_op", "ext"),
+    ],
+)
+def test_operator_source_request_is_ignored_with_source_channel(
+    method_name, active_state
+):
+    service_src_mode = init_service_source_mode(
+        init_mode=active_state, src_channel=True
+    )
+
+    getattr(service_src_mode, method_name)(True)
+
+    assert service_source_mode_is_in_specific_mode(service_src_mode, True, active_state)
+
+
+def test_operator_source_requests_are_reset():
+    service_src_mode = init_service_source_mode()
+
+    service_src_mode.set_src_ext_op(False)
+    service_src_mode.set_src_int_op(False)
+
+    assert service_src_mode[ServiceSourceMode.SRC_EXT_OP] is False
+    assert service_src_mode[ServiceSourceMode.SRC_INT_OP] is False
+
+
+def test_invalid_initial_source_mode_is_rejected():
+    with pytest.raises(ValueError, match="ServiceSourceMode invalid is unknown"):
+        init_service_source_mode(init_mode="invalid")

mtppy/part4/automation_services/helpers/__init__.py

@@ -0,0 +1,4 @@
+__copyright__ = (
+    "Copyright (c) 2026 Dresden University of Technology, Process-to-Order Group"
+)
+__license__ = "MIT"

mtppy/part4/automation_services/helpers/command_en_control.py

@@ -0,0 +1,330 @@
+"""CommandEnControl."""
+
+__copyright__ = (
+    "Copyright (c) 2026 Dresden University of Technology, Process-to-Order Group"
+)
+__license__ = "MIT"
+
+import logging
+
+
+class CommandEnControl:
+    def __init__(self) -> None:
+        """Instantiate Command enable control."""
+        self.command_en = {
+            "undefined": {"default": False, "value": False, "bit_no": 0, "int": 1},
+            "reset": {"default": False, "value": False, "bit_no": 1, "int": 2},
+            "start": {"default": True, "value": True, "bit_no": 2, "int": 4},
+            "stop": {"default": True, "value": True, "bit_no": 3, "int": 8},
+            "hold": {"default": False, "value": False, "bit_no": 4, "int": 16},
+            "unhold": {"default": False, "value": False, "bit_no": 5, "int": 32},
+            "pause": {"default": False, "value": False, "bit_no": 6, "int": 64},
+            "resume": {"default": False, "value": False, "bit_no": 7, "int": 128},
+            "abort": {"default": True, "value": True, "bit_no": 8, "int": 256},
+            "restart": {"default": False, "value": False, "bit_no": 9, "int": 512},
+            "complete": {"default": False, "value": False, "bit_no": 10, "int": 1024},
+        }
+        self.hold_enabled = True
+        self.pause_enabled = True
+        self.restart_enabled = True
+
+    def set_default(self) -> None:
+        """Apply default values to all command enable flags."""
+        for command_en in self.command_en:
+            self.command_en[command_en]["value"] = self.command_en[command_en][
+                "default"
+            ]
+
+    def disable_all(self) -> None:
+        """Set False to all command enable flags."""
+        for command_en in self.command_en:
+            self.command_en[command_en]["value"] = False
+
+    def is_enabled(self, cmd: str) -> bool | None:
+        """Check if a given command is enabled right now.
+
+        Args:
+            cmd: Command to check.
+
+        Returns:
+            Command enable flag state or None.
+        """
+        if cmd in self.command_en.keys():
+            return self.command_en[cmd]["value"]
+        else:
+            return None
+
+    def get_command_en(self) -> int:
+        """Calculates a sum of all command enable flags.
+
+        Returns:
+            Sum of all command enable flags.
+        """
+        command_en_sum = 0
+        for command in self.command_en.values():
+            if command["value"]:
+                command_en_sum += command["int"]
+        return command_en_sum
+
+    def set_command_en(self, cmd: str, value: bool):
+        """
+        Sets a specific command enable to a given value.
+
+        Args:
+            cmd: Command enable flag.
+            value: Value to be set.
+        """
+        if cmd in self.command_en.keys():
+            self.command_en[cmd]["value"] = value
+
+    def enable_pause_loop(self, value: bool):
+        """Enable pause loop.
+
+        Args:
+            value: True if the pause loop is shall be enabled and False if disabled.
+        """
+        self.pause_enabled = value
+
+    def enable_restart(self, value: bool):
+        """Enable restart loop.
+
+        Args:
+            value: True if the restart command shall be enabled and False if disabled.
+        """
+        self.restart_enabled = value
+
+    def execute(self, state: str):
+        """Execute command enable changes required for a certain state.
+
+        Args:
+            state: Given state.
+        """
+        logging.debug(f"CommandEn changed to correspond {state}")
+        exec(f"self._execute_{state}()")
+
+    def _execute_undefined(self):
+        self.disable_all()
+
+    def _execute_idle(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", True)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", False)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", False)
+
+    def _execute_starting(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", True)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", True)
+
+    def _execute_execute(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", True)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", True)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", True)
+        self.set_command_en("complete", True)
+
+    def _execute_completing(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", True)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", False)
+
+    def _execute_completed(self):
+        self.set_command_en("reset", True)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", False)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", False)
+
+    def _execute_resuming(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", True)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", True)
+
+    def _execute_paused(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", True)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", True)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", True)
+
+    def _execute_pausing(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", True)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", True)
+
+    def _execute_holding(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", False)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", False)
+
+    def _execute_held(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", False)
+        self.set_command_en("unhold", True)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", False)
+
+    def _execute_unholding(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", True)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", True)
+
+    def _execute_stopping(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", False)
+        self.set_command_en("hold", False)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", False)
+
+    def _execute_stopped(self):
+        self.set_command_en("reset", True)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", False)
+        self.set_command_en("hold", False)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", False)
+
+    def _execute_aborting(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", False)
+        self.set_command_en("hold", False)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", False)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", False)
+
+    def _execute_aborted(self):
+        self.set_command_en("reset", True)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", False)
+        self.set_command_en("hold", False)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", False)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", False)
+
+    def _execute_resetting(self):
+        self.set_command_en("reset", False)
+        self.set_command_en("start", False)
+        self.set_command_en("stop", True)
+        self.set_command_en("hold", False)
+        self.set_command_en("unhold", False)
+        if self.pause_enabled:
+            self.set_command_en("pause", False)
+            self.set_command_en("resume", False)
+        self.set_command_en("abort", True)
+        if self.restart_enabled:
+            self.set_command_en("restart", False)
+        self.set_command_en("complete", False)