MTPPy2.0 0.1.5__py3-none-any.whl

mtppy/part3/data_assembly_set/active_elements/valves/bin_vlv.py

@@ -0,0 +1,279 @@
+"""Implementation of BinVlv."""
+
+__copyright__ = (
+    "Copyright (c) 2026 Dresden University of Technology, Process-to-Order Group"
+)
+__license__ = "MIT"
+from typing import ClassVar
+
+from mtppy.utils.logging import logger
+from mtppy.utils.data_item import DataItem
+from mtppy.part3.definitions.mtp_access import MTPAccess
+from mtppy.part5.definitions.w3c_xml_data_types import W3cXmlDataTypes
+from mtppy.part3.data_assembly_set.active_elements.active_element import ActiveElement
+from mtppy.part3.data_assembly_set.base_functions.operation_mode import OperationMode
+from mtppy.part3.data_assembly_set.base_functions.source_mode import SourceMode
+
+
+class BinVlv(ActiveElement):
+    # DataItem constant definitions
+    SAFE_POS = "SafePos"
+    SAFE_POS_EN = "SafePosEn"
+    SAFE_POS_ACT = "SafePosAct"
+    OPEN_OP = "OpenOp"
+    CLOSE_OP = "CloseOp"
+    OPEN_AUT = "OpenAut"
+    CLOSE_AUT = "CloseAut"
+    CTRL_ = "Ctrl"
+    OPEN_FBK_CALC = "OpenFbkCalc"
+    OPEN_FBK = "OpenFbk"
+    CLOSE_FBK_CALC = "CloseFbkCalc"
+    CLOSE_FBK = "CloseFbk"
+    PERM_EN = "PermEn"
+    PERMIT_ = "Permit"
+    INTL_EN = "IntlEn"
+    INTERLOCK_ = "Interlock"
+    PROT_EN = "ProtEn"
+    PROTECT_ = "Protect"
+    RESET_OP = "ResetOp"
+    RESET_AUT = "ResetAut"
+
+    # Class-level data items dictionary
+    CLASS_DATA_ITEMS: ClassVar = {
+        SAFE_POS: DataItem(
+            SAFE_POS, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        SAFE_POS_EN: DataItem(
+            SAFE_POS_EN, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        SAFE_POS_ACT: DataItem(
+            SAFE_POS_ACT, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        OPEN_OP: DataItem(
+            OPEN_OP, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadWriteAccess, None
+        ),
+        CLOSE_OP: DataItem(
+            CLOSE_OP, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadWriteAccess, None
+        ),
+        OPEN_AUT: DataItem(
+            OPEN_AUT, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        CLOSE_AUT: DataItem(
+            CLOSE_AUT, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        CTRL_: DataItem(CTRL_, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None),
+        OPEN_FBK_CALC: DataItem(
+            OPEN_FBK_CALC, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        OPEN_FBK: DataItem(
+            OPEN_FBK, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        CLOSE_FBK_CALC: DataItem(
+            CLOSE_FBK_CALC, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        CLOSE_FBK: DataItem(
+            CLOSE_FBK, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        PERM_EN: DataItem(PERM_EN, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None),
+        PERMIT_: DataItem(PERMIT_, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None),
+        INTL_EN: DataItem(INTL_EN, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None),
+        INTERLOCK_: DataItem(
+            INTERLOCK_, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        PROT_EN: DataItem(PROT_EN, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None),
+        PROTECT_: DataItem(
+            PROTECT_, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+        RESET_OP: DataItem(
+            RESET_OP, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadWriteAccess, None
+        ),
+        RESET_AUT: DataItem(
+            RESET_AUT, W3cXmlDataTypes.BOOLEAN, MTPAccess.ReadAccess, None
+        ),
+    }
+
+    op_mode: OperationMode
+    src_mode: SourceMode
+
+    def __init__(
+        self,
+        tag_name: str,
+        tag_description: str = "",
+        open_fbk_calc: bool = True,
+        close_fbk_calc: bool = True,
+        safe_pos: int = 0,
+        safe_pos_en: bool = False,
+        perm_en: bool = False,
+        intl_en: bool = False,
+        prot_en: bool = False,
+    ):
+        """
+        Binary Valve (BinVlv).
+        """
+
+        super().__init__(tag_name, tag_description)
+        self.mtpObjectType = "MTPDataObjectSUCLib/DataAssembly/ActiveElement/BinVlv"
+
+        self.op_mode = OperationMode()
+        self.src_mode = SourceMode()
+
+        # Initialize data items with dynamic values (using class-defined data items)
+        self[BinVlv.SAFE_POS] = safe_pos
+        self[BinVlv.SAFE_POS_EN] = safe_pos_en
+        self[BinVlv.SAFE_POS_ACT] = False
+        self[BinVlv.OPEN_OP] = 0
+        self[BinVlv.CLOSE_OP] = 0
+        self[BinVlv.OPEN_AUT] = 0
+        self[BinVlv.CLOSE_AUT] = 0
+        self[BinVlv.CTRL_] = 0
+        self[BinVlv.OPEN_FBK_CALC] = open_fbk_calc
+        self[BinVlv.OPEN_FBK] = False
+        self[BinVlv.CLOSE_FBK_CALC] = close_fbk_calc
+        self[BinVlv.CLOSE_FBK] = False
+        self[BinVlv.PERM_EN] = perm_en
+        self[BinVlv.PERMIT_] = 0
+        self[BinVlv.INTL_EN] = intl_en
+        self[BinVlv.INTERLOCK_] = 0
+        self[BinVlv.PROT_EN] = prot_en
+        self[BinVlv.PROTECT_] = 0
+        self[BinVlv.RESET_OP] = 0
+        self[BinVlv.RESET_AUT] = 0
+
+        # Set callbacks for writable items
+        self.get_item(BinVlv.OPEN_OP).ext_wrt_cb = self.set_open_op
+        self.get_item(BinVlv.CLOSE_OP).ext_wrt_cb = self.set_close_op
+        self.get_item(BinVlv.RESET_OP).ext_wrt_cb = self.set_reset_op
+
+    def _expect_save_pos(self):
+        if self._run_allowed():
+            self[BinVlv.SAFE_POS_ACT] = False
+        else:
+            if self[BinVlv.SAFE_POS_EN]:
+                self._go_safe_pos()
+            else:
+                logger.debug("Device has no safe position")
+            self[BinVlv.SAFE_POS_ACT] = True
+
+    def _go_safe_pos(self):
+        if self[BinVlv.SAFE_POS]:
+            self._run_open_vlv()
+        else:
+            self._run_close_vlv()
+
+    def set_open_aut(self, value: bool):
+        logger.debug(f"OpenAut set to {value}")
+        if self.op_mode[OperationMode.STATE_AUT_ACT]:
+            if value and self._run_allowed():
+                self._run_open_vlv()
+
+    def set_close_aut(self, value: bool):
+        logger.debug(f"CloseAut set to {value}")
+        if self.op_mode[OperationMode.STATE_AUT_ACT]:
+            if value and self._run_allowed():
+                self._run_close_vlv()
+
+    def set_reset_aut(self, value: bool):
+        logger.debug(f"ResetAut set to {value}")
+        if self.op_mode[OperationMode.STATE_AUT_ACT] and value:
+            self._reset_vlv()
+
+    def set_open_op(self, value: bool):
+        logger.debug(f"OpenOp set to {value}")
+        if self.op_mode[OperationMode.STATE_OP_ACT]:
+            if value and self._run_allowed():
+                self._run_open_vlv()
+                self[BinVlv.OPEN_OP] = False
+
+    def set_close_op(self, value: bool):
+        logger.debug(f"CloseOp set to {value}")
+        if self.op_mode[OperationMode.STATE_OP_ACT]:
+            if value and self._run_allowed():
+                self._run_close_vlv()
+                self[BinVlv.CLOSE_OP] = False
+
+    def set_reset_op(self, value: bool):
+        logger.debug(f"ResetOp set to {value}")
+        if self.op_mode[OperationMode.STATE_OP_ACT] and value:
+            self._reset_vlv()
+            self[BinVlv.RESET_OP] = False
+
+    def _run_allowed(self):
+        if self[BinVlv.PERM_EN] and self[BinVlv.PERMIT_] == 0:
+            logger.debug("Permission is not given")
+            return False
+        if self[BinVlv.INTL_EN] and self[BinVlv.INTERLOCK_] == 0:
+            logger.debug("Interlock is active")
+            return False
+        if self[BinVlv.PROT_EN] and self[BinVlv.PROTECT_] == 0:
+            logger.debug("Protect is active")
+            return False
+        return True
+
+    def _run_open_vlv(self):
+        self[BinVlv.CTRL_] = True
+        if self[BinVlv.OPEN_FBK_CALC]:
+            self[BinVlv.OPEN_FBK] = True
+
+        if self[BinVlv.CLOSE_FBK_CALC]:
+            self[BinVlv.CLOSE_FBK] = False
+
+    def _run_close_vlv(self):
+        self[BinVlv.CTRL_] = False
+        if self[BinVlv.OPEN_FBK_CALC]:
+            self[BinVlv.OPEN_FBK] = False
+
+        if self[BinVlv.CLOSE_FBK_CALC]:
+            self[BinVlv.CLOSE_FBK] = True
+
+    def _reset_vlv(self):
+        if self[BinVlv.PROT_EN] and self[BinVlv.PROTECT_] == 0:
+            self[BinVlv.PROTECT_] = True
+
+        if self[BinVlv.SAFE_POS_EN]:
+            self[BinVlv.SAFE_POS_ACT] = False
+
+        self[BinVlv.CTRL_] = False
+        if self[BinVlv.OPEN_FBK_CALC]:
+            self[BinVlv.OPEN_FBK] = False
+
+        if self[BinVlv.CLOSE_FBK_CALC]:
+            self[BinVlv.CLOSE_FBK] = False
+
+    def set_open_fbk(self, value: bool):
+        if not self[BinVlv.OPEN_FBK_CALC]:
+            self[BinVlv.OPEN_FBK] = value
+            logger.debug(f"OpenFbk set to {value}")
+
+    def set_close_fbk(self, value: bool):
+        if not self[BinVlv.CLOSE_FBK_CALC]:
+            self[BinVlv.CLOSE_FBK] = value
+            logger.debug(f"CloseFbk set to {value}")
+
+    def set_permit(self, value: bool):
+        if not self[BinVlv.PERM_EN]:
+            value = True
+        self[BinVlv.PERMIT_] = value
+        logger.debug(f"Permit set to {value}")
+        self[BinVlv.SAFE_POS_ACT] = False
+
+    def set_interlock(self, value: bool):
+        if not self[BinVlv.INTL_EN]:
+            value = True
+        self[BinVlv.INTERLOCK_] = value
+        logger.debug(f"Interlock set to {value}")
+        self._expect_save_pos()
+
+    def set_protect(self, value: bool):
+        if not self[BinVlv.PROT_EN]:
+            value = True
+        if value:
+            self._reset_vlv()
+        self[BinVlv.PROTECT_] = value
+        logger.debug(f"Protect set to {value}")
+        self._expect_save_pos()
+
+    def get_open_fbk(self):
+        return self[BinVlv.OPEN_FBK]
+
+    def get_close_fbk(self):
+        return self[BinVlv.CLOSE_FBK]