MTPPy2.0 0.1.5__py3-none-any.whl

mtppy/part4/automation_services/helpers/command_en_control_test.py

@@ -0,0 +1,302 @@
+"""Test Suite for CommandEnControl."""
+
+__copyright__ = (
+    "Copyright (c) 2026 Dresden University of Technology, Process-to-Order Group"
+)
+__license__ = "MIT"
+
+from mtppy.part4.automation_services.helpers.command_en_control import CommandEnControl
+import itertools
+
+hold_enabled = True
+pause_enabled = True
+restart_enabled = True
+
+test_cases = {
+    "undefined": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": False,
+        "hold": False,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": False,
+        "restart": False,
+        "complete": False,
+    },
+    "idle": {
+        "undefined": False,
+        "reset": False,
+        "start": True,
+        "stop": True,
+        "hold": False,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": False,
+    },
+    "starting": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": True,
+        "hold": hold_enabled,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": True,
+    },
+    "execute": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": True,
+        "hold": hold_enabled,
+        "unhold": False,
+        "pause": pause_enabled,
+        "resume": False,
+        "abort": True,
+        "restart": restart_enabled,
+        "complete": True,
+    },
+    "completing": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": True,
+        "hold": hold_enabled,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": False,
+    },
+    "completed": {
+        "undefined": False,
+        "reset": True,
+        "start": False,
+        "stop": True,
+        "hold": False,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": False,
+    },
+    "resuming": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": True,
+        "hold": hold_enabled,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": True,
+    },
+    "paused": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": True,
+        "hold": hold_enabled,
+        "unhold": False,
+        "pause": False,
+        "resume": True,
+        "abort": True,
+        "restart": False,
+        "complete": True,
+    },
+    "pausing": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": True,
+        "hold": hold_enabled,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": True,
+    },
+    "holding": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": True,
+        "hold": False,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": False,
+    },
+    "held": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": True,
+        "hold": False,
+        "unhold": True,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": False,
+    },
+    "unholding": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": True,
+        "hold": hold_enabled,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": True,
+    },
+    "stopping": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": False,
+        "hold": False,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": False,
+    },
+    "stopped": {
+        "undefined": False,
+        "reset": True,
+        "start": False,
+        "stop": False,
+        "hold": False,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": False,
+    },
+    "aborting": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": False,
+        "hold": False,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": False,
+        "restart": False,
+        "complete": False,
+    },
+    "aborted": {
+        "undefined": False,
+        "reset": True,
+        "start": False,
+        "stop": False,
+        "hold": False,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": False,
+        "restart": False,
+        "complete": False,
+    },
+    "resetting": {
+        "undefined": False,
+        "reset": False,
+        "start": False,
+        "stop": True,
+        "hold": False,
+        "unhold": False,
+        "pause": False,
+        "resume": False,
+        "abort": True,
+        "restart": False,
+        "complete": False,
+    },
+}
+
+
+def init_state(state="idle", pause_en=True, restart_en=True):
+    command_en_ctrl = CommandEnControl()
+    command_en_ctrl.execute(state)
+    command_en_ctrl.enable_pause_loop(pause_en)
+    command_en_ctrl.enable_restart(restart_en)
+    return command_en_ctrl
+
+
+def test_states():
+    for state in test_cases:
+        for loop_en_flags in itertools.product([False, True], repeat=3):
+            pause_en = loop_en_flags[0]
+            restart_en = loop_en_flags[0]
+            command_en_ctrl = init_state(
+                state=state, pause_en=pause_en, restart_en=restart_en
+            )
+            command_en_ctrl.execute(state)
+            for command, command_en in test_cases[state].items():
+                response = command_en_ctrl.command_en[command]["value"]
+                print(
+                    f"State: {state}, command: {command}, pause_en: {pause_en}, restart_en: {restart_en}, expected: {command_en}, received: {response}"
+                )
+                assert response == command_en
+
+
+def test_set_default():
+    command_en_ctrl = init_state()
+    command_en_ctrl.set_default()
+    for command_en in command_en_ctrl.command_en:
+        assert (
+            command_en_ctrl.command_en[command_en]["value"]
+            == command_en_ctrl.command_en[command_en]["default"]
+        )
+
+
+def test_disable_all():
+    command_en_ctrl = init_state()
+    command_en_ctrl.disable_all()
+    for command_en in command_en_ctrl.command_en:
+        assert command_en_ctrl.command_en[command_en]["value"] == False
+
+
+def test_get_command():
+    command_en_ctrl = init_state()
+    for command_en in command_en_ctrl.command_en:
+        assert (
+            command_en_ctrl.is_enabled(command_en)
+            == command_en_ctrl.command_en[command_en]["value"]
+        )
+
+    assert command_en_ctrl.is_enabled("not_exist") is None
+
+
+def test_set_command():
+    command_en_ctrl = init_state()
+    for command_en in command_en_ctrl.command_en:
+        command_en_ctrl.set_command_en(command_en, True)
+        command_en_ctrl.set_command_en("not_exist", False)
+        assert command_en_ctrl.command_en[command_en]["value"] == True
+
+        command_en_ctrl.set_command_en(command_en, False)
+        command_en_ctrl.set_command_en("not_exist", True)
+        assert command_en_ctrl.command_en[command_en]["value"] == False

mtppy/part4/automation_services/helpers/state_machine.py

@@ -0,0 +1,167 @@
+"""
+Implementation of the State Machine concept as specified in PNO MTP 2.0 Part 4, Section 8.2.3.1
+"""
+
+__copyright__ = (
+    "Copyright (c) 2026 Dresden University of Technology, Process-to-Order Group"
+)
+__license__ = "MIT"
+
+from collections.abc import Callable
+
+from mtppy.utils.logging import logger
+from mtppy.part4.definitions.state_codes import StateCodes
+from mtppy.part4.definitions.command_codes import CommandCodes
+from mtppy.part4.automation_services.helpers.command_en_control import CommandEnControl
+from mtppy.part4.automation_services.service_elements.service_control import ServiceControl
+
+
+class StateMachine:
+    def __init__(self, service_control: ServiceControl, execution_routine: Callable):
+        """
+        Initialize the state machine for a service.
+
+        Args:
+            service_control: ServiceControl.
+            execution_routine: Execution routine for state changing.
+
+        """
+
+        self.service_control = service_control
+        self.service_op_mode = service_control.service_op_mode
+        self.service_src_mode = service_control.service_src_mode
+
+        self.execution_routine = execution_routine
+        self.command_en_ctrl = CommandEnControl()
+
+        self.act_state: int = StateCodes.UNDEFINED.code
+        self.prev_state: int = StateCodes.UNDEFINED.code
+
+        self.is_active = False
+
+    def activate(self):
+        # should happen on ServiceOpMode Off --> *
+        if self.act_state == StateCodes.UNDEFINED.code:
+            self._change_state_to(StateCodes.IDLE.code)
+            self.is_active = True
+            self.command_en_ctrl.execute(StateCodes.from_code(self.act_state))
+
+    def deactivate(self):
+        # should happen on ServiceOpMode * --> Off while in IDLE
+        if self.act_state == StateCodes.IDLE.code:
+            self._change_state_to(StateCodes.UNDEFINED.code)
+            self.is_active = False
+            self.command_en_ctrl.execute(StateCodes.from_code(self.act_state))
+
+    def set_command_op(self, value: int):
+        if self.service_op_mode["StateOpAct"]:
+            self.command_execution(value)
+
+    def set_command_int(self, value: int):
+        if self.service_op_mode["StateAutAct"] and self.service_src_mode["SrcIntAct"]:
+            self.command_execution(value)
+
+    def set_command_ext(self, value: int):
+        if self.service_op_mode["StateAutAct"] and self.service_src_mode["SrcExtAct"]:
+            self.command_execution(value)
+
+    def command_execution(self, command_code: int):
+        if self.is_active:
+            logger.debug(
+                f"command code {command_code} received for {self.service_control.tag_name}"
+            )
+            if command_code not in CommandCodes.list_of_codes():
+                logger.debug(f"Command Code {command_code} does not exist")
+                return
+
+            cmd_str = CommandCodes.from_code(command_code)
+            if not self.command_en_ctrl.is_enabled(cmd_str):
+                logger.debug(
+                    f"CommandEn does not permit to execute {cmd_str} from state {self.get_current_state_str()}"
+                )
+                return
+            else:
+                logger.debug(f"CommandEn permits to execute {cmd_str}")
+
+            eval(f"self.{cmd_str}()")
+
+    def start(self):
+        if self.command_en_ctrl.is_enabled("start"):
+            self.service_control.set_procedure_cur()
+            # applying the procedure is job of the Service callback
+            self._change_state_to(StateCodes.STARTING.code)
+
+    def restart(self):
+        if self.command_en_ctrl.is_enabled("restart"):
+            self._change_state_to(StateCodes.STARTING.code)
+
+    def complete(self):
+        if self.command_en_ctrl.is_enabled("complete"):
+            self._change_state_to(StateCodes.COMPLETING.code)
+
+    def pause(self):
+        if self.command_en_ctrl.is_enabled("pause"):
+            self._change_state_to(StateCodes.PAUSING.code)
+
+    def resume(self):
+        if self.command_en_ctrl.is_enabled("resume"):
+            self._change_state_to(StateCodes.RESUMING.code)
+
+    def reset(self):
+        if self.command_en_ctrl.is_enabled("reset"):
+            self._change_state_to(StateCodes.RESETTING.code)
+
+    def hold(self):
+        if self.command_en_ctrl.is_enabled("hold"):
+            self._change_state_to(StateCodes.HOLDING.code)
+
+    def unhold(self):
+        if self.command_en_ctrl.is_enabled("unhold"):
+            self._change_state_to(StateCodes.UNHOLDING.code)
+
+    def stop(self):
+        if self.command_en_ctrl.is_enabled("stop"):
+            self._change_state_to(StateCodes.STOPPING.code)
+
+    def abort(self):
+        if self.command_en_ctrl.is_enabled("abort"):
+            self._change_state_to(StateCodes.ABORTING.code)
+
+    def state_change(self):
+        logger.debug(
+            f"get possible state_change transitions for state {self.act_state}"
+        )
+        if self.act_state == StateCodes.STARTING.code:
+            self._change_state_to(StateCodes.EXECUTE.code)
+        elif self.act_state == StateCodes.STARTING.code:
+            self._change_state_to(StateCodes.EXECUTE.code)
+        elif self.act_state == StateCodes.COMPLETING.code:
+            self._change_state_to(StateCodes.COMPLETED.code)
+        elif self.act_state == StateCodes.PAUSING.code:
+            self._change_state_to(StateCodes.PAUSED.code)
+        elif self.act_state == StateCodes.RESUMING.code:
+            self._change_state_to(StateCodes.EXECUTE.code)
+        elif self.act_state == StateCodes.RESETTING.code:
+            self._change_state_to(StateCodes.IDLE.code)
+        elif self.act_state == StateCodes.HOLDING.code:
+            self._change_state_to(StateCodes.HELD.code)
+        elif self.act_state == StateCodes.UNHOLDING.code:
+            self._change_state_to(StateCodes.EXECUTE.code)
+        elif self.act_state == StateCodes.STOPPING.code:
+            self._change_state_to(StateCodes.STOPPED.code)
+        elif self.act_state == StateCodes.HOLDING.code:
+            self._change_state_to(StateCodes.ABORTING.code)
+
+    def _change_state_to(self, new_state: int) -> None:
+        logger.debug(f"Service state switching requested {new_state}")
+        self.act_state = new_state
+        self.service_control["StateCur"] = new_state
+        new_state_str = StateCodes.from_code(new_state)
+        self.command_en_ctrl.execute(new_state_str)
+        self.service_control["CommandEn"] = self.command_en_ctrl.get_command_en()
+        self.execution_routine()
+        logger.debug(f"Service state changed to {new_state}")
+
+    def get_current_state_str(self) -> str:
+        logger.debug(f"current state {self.act_state}")
+        return StateCodes.from_code(self.act_state)