opensignalbox-interface 0.1.0__py3-none-any.whl

opensignalbox/interface/interfaces/basicio/connections.py

@@ -0,0 +1,239 @@
+import logging
+from abc import ABC, abstractmethod
+from math import ceil
+
+from opensignalbox.interface.adapters.base import BaseAdapter
+from opensignalbox.interface.interfaces.basicio.models import BasicIOInterface
+
+logger = logging.getLogger(__name__)
+
+
+class BasicIOConnection(ABC):
+    """Base abstract class for all basic I/O connections."""
+
+    @classmethod
+    @abstractmethod
+    def connect(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bool:
+        """Connect to the basic I/O interface."""
+        pass
+
+    @classmethod
+    @abstractmethod
+    def disconnect(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bool:
+        """Disconnect from the basic I/O interface."""
+        pass
+
+    @classmethod
+    @abstractmethod
+    def send_data(
+        cls,
+        interface: BasicIOInterface,
+        data: bytearray,
+        adapter: BaseAdapter | None = None,
+    ) -> None:
+        """Send data through the basic I/O interface."""
+        pass
+
+    @classmethod
+    @abstractmethod
+    def receive_data(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bytearray:
+        """Receive data from the basic I/O interface."""
+        pass
+
+
+class BasicIOTestConnection(BasicIOConnection):
+    """Test implementation of the BasicIOConnection for unit testing."""
+
+    @classmethod
+    def connect(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bool:
+        """Simulate connecting to the interface."""
+        logger.debug(
+            f"Connecting to interface {interface.system_name} with test connection."
+        )
+        interface.is_connected = True
+        return True
+
+    @classmethod
+    def disconnect(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bool:
+        """Simulate disconnecting from the interface."""
+        logger.debug(
+            f"Disconnecting from interface {interface.system_name} with test connection."
+        )
+        interface.is_connected = False
+        return True
+
+    @classmethod
+    def send_data(
+        cls,
+        interface: BasicIOInterface,
+        data: bytearray,
+        adapter: BaseAdapter | None = None,
+    ) -> None:
+        """Simulate sending data."""
+        logger.debug(
+            f"Sending data to interface {interface.system_name} with test connection."
+        )
+        return
+
+    @classmethod
+    def receive_data(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bytearray:
+        """Simulate receiving data."""
+        logger.debug(
+            f"Receiving data from interface {interface.system_name} with test connection."
+        )
+        # Simulate receiving data
+        return bytearray(b"Test Data")
+
+
+class BasicIOModbusConnection(BasicIOConnection):
+    """Modbus implementation of the BasicIOConnection."""
+
+    @classmethod
+    def connect(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bool:
+        """Connect to the Modbus interface."""
+        logger.debug(f"Connecting to BasicIO Modbus interface {interface.system_name}.")
+        if adapter is not None:
+            if not adapter.is_connected:
+                adapter.connect()
+                if adapter.is_connected:
+                    interface.is_connected = True
+                    return True
+            else:
+                interface.is_connected = True
+                return True
+        return False
+
+    @classmethod
+    def disconnect(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bool:
+        """Disconnect from the Modbus interface."""
+        logger.debug(
+            f"Disconnecting from BasicIO Modbus interface {interface.system_name}."
+        )
+        interface.is_connected = False
+        return True
+
+    @classmethod
+    def send_data(
+        cls,
+        interface: BasicIOInterface,
+        data: bytearray,
+        adapter: BaseAdapter | None = None,
+    ) -> None:
+        """Send data through the Modbus interface."""
+        if adapter is not None and interface.modbus_address is not None:
+            command = 15
+            cmd = interface.modbus_address.to_bytes()
+            cmd += command.to_bytes()
+            cmd += interface.output_start_address.to_bytes(2)
+            cmd += (interface.output_bits).to_bytes(2)
+            cmd += len(data).to_bytes()
+            cmd += data
+            adapter.attempt_write(cmd)
+            adapter.attempt_read()
+        return
+
+    @classmethod
+    def receive_data(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bytearray:
+        """Receive data from the Modbus interface."""
+        if adapter is not None and interface.modbus_address is not None:
+            command = 3
+            cmd = interface.modbus_address.to_bytes()
+            cmd += command.to_bytes()
+            cmd += interface.input_start_address.to_bytes(2)
+            cmd += ceil(interface.input_bits / 16).to_bytes(2)
+            adapter.attempt_write(cmd)
+            return adapter.attempt_read()
+        return bytearray(b"")
+
+
+class BasicIODingtianModbusConnection(BasicIOConnection):
+    """Modbus implementation of the BasicIOConnection for Dingtian boards."""
+
+    @classmethod
+    def connect(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bool:
+        """Connect to the Dingtian Modbus interface."""
+        logger.debug(
+            f"Connecting to BasicIO Dingtian Modbus interface {interface.system_name}."
+        )
+        if adapter is not None:
+            if not adapter.is_connected:
+                adapter.connect()
+                if adapter.is_connected:
+                    interface.is_connected = True
+                    return True
+            else:
+                interface.is_connected = True
+                return True
+        return False
+
+    @classmethod
+    def disconnect(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bool:
+        """Disconnect from the Dingtian Modbus interface."""
+        logger.debug(
+            f"Disconnecting from BasicIO Dingtian Modbus interface {interface.system_name}."
+        )
+        interface.is_connected = False
+        return True
+
+    @classmethod
+    def send_data(
+        cls,
+        interface: BasicIOInterface,
+        data: bytearray,
+        adapter: BaseAdapter | None = None,
+    ) -> None:
+        """Send data through the Dingtian Modbus interface."""
+        if adapter is not None and interface.modbus_address is not None:
+            command = 16
+            cmd = interface.modbus_address.to_bytes()
+            cmd += command.to_bytes()
+            cmd += interface.output_start_address.to_bytes(2)
+            cmd += 0x04.to_bytes(2)
+            cmd += 0x08.to_bytes()
+            cmd += 0xFFFF.to_bytes(2)
+            cmd += 0x00.to_bytes(2)
+            cmd += data
+            cmd += 0x00.to_bytes(2)
+            logger.debug(
+                f"Sending data to Dingtian interface {interface.system_name}. Command: {cmd.hex()}"
+            )
+            adapter.attempt_write(cmd)
+            adapter.attempt_read()
+        return
+
+    @classmethod
+    def receive_data(
+        cls, interface: BasicIOInterface, adapter: BaseAdapter | None = None
+    ) -> bytearray:
+        """Receive data from the Dingtian Modbus interface."""
+        if adapter is not None and interface.modbus_address is not None:
+            command = 3
+            cmd = interface.modbus_address.to_bytes()
+            cmd += command.to_bytes()
+            cmd += interface.input_start_address.to_bytes(2)
+            cmd += ceil(interface.input_bits / 16).to_bytes(2)
+            adapter.attempt_write(cmd)
+            return adapter.attempt_read()
+        return bytearray(b"")