move methods into serial_base

Author: Lupin3000

serial_plugin/serial_base.py

@@ -1,6 +1,6 @@
+from logging import getLogger, error, debug
 from serial import Serial
 from time import sleep
-from logging import getLogger, error
 from types import TracebackType
 from typing import Optional, Type
 from config.application_configuration import SERIAL_RATE
@@ -11,7 +11,7 @@
 
 class SerialBase:
     """
-    Manages a MicroPython serial connection.
+    Manages a MicroPython serial connection and REPL modes.
     """
 
     def __init__(self, port: str, baudrate: int = SERIAL_RATE, timeout: int = 2):
@@ -53,6 +53,65 @@ def _disconnect(self) -> None:
         if self._ser and self._ser.is_open:
             self._ser.close()
 
+    def wake_repl(self) -> None:
+        """
+        Invokes a wake-up sequence for the REPL (Read-Eval-Print Loop) interface by
+        interacting with the serial connection.
+
+        :return: None
+        """
+        self._ser.reset_input_buffer()
+        self._ser.write(b'\r\n')
+        sleep(0.2)
+
+        self._ser.read_all()
+
+    def send_command(self, command: str, wait: float = 0.3) -> str:
+        """
+        Sends a command to the REPL interface and retrieves its output.
+
+        :param command: The command to be sent to the REPL interface.
+        :type command: str
+        :param wait: The amount of time, in seconds.
+        :type wait: float, optional
+        :return: The output received from the REPL
+        :rtype: str
+        :raises RuntimeError: If the REPL interface is not connected or available.
+        """
+        if not self._ser or not self._ser.is_open:
+            raise RuntimeError("REPL not connected")
+
+        self._ser.write(command.encode() + b'\r\n')
+        sleep(wait)
+
+        output = self._ser.read_all().decode(errors='ignore')
+        debug(f"[DEBUG] command output: {output}")
+
+        return output.strip()
+
+    def enter_raw_repl(self) -> None:
+        """
+        Enter raw REPL mode on the connected device.
+
+        :return: None
+        """
+        self._ser.write(b'\r\x03\x03')
+        sleep(0.1)
+
+        self._ser.write(b'\r\x01')
+        sleep(0.1)
+
+        self._ser.reset_input_buffer()
+
+    def exit_raw_repl(self) -> None:
+        """
+        Exits raw REPL mode on the connected device.
+
+        :return: None
+        """
+        self._ser.write(b'\r\x02')
+        sleep(0.1)
+
     def __enter__(self) -> "SerialBase":
         """
         Provides context management for the MicroPythonTree, ensuring resources are

serial_plugin/serial_get_file_structure.py

@@ -1,5 +1,5 @@
 from logging import getLogger, debug
-from time import time, sleep
+from time import time
 from serial_plugin.serial_base import SerialBase
 
 
@@ -33,29 +33,6 @@ class FileStructure(SerialBase):
         "tree('')\n"
     )
 
-    def _enter_raw_repl(self) -> None:
-        """
-        Enter raw REPL mode on the connected device.
-
-        :return: None
-        """
-        self._ser.write(b'\r\x03\x03')
-        sleep(0.1)
-
-        self._ser.write(b'\r\x01')
-        sleep(0.1)
-
-        self._ser.reset_input_buffer()
-
-    def _exit_raw_repl(self) -> None:
-        """
-        Exits raw REPL mode on the connected device.
-
-        :return: None
-        """
-        self._ser.write(b'\r\x02')
-        sleep(0.1)
-
     def get_tree(self) -> str:
         """
         Retrieves the current state of the tree structure by communicating with
@@ -66,7 +43,7 @@ def get_tree(self) -> str:
         :return: The tree structure information.
         :rtype: str
         """
-        self._enter_raw_repl()
+        self.enter_raw_repl()
         self._ser.write(self._TREE_CODE.encode('utf-8') + b'\x04')
         output = b''
         start = time()
@@ -83,7 +60,7 @@ def get_tree(self) -> str:
             if output.endswith(b'\x04>'):
                 break
 
-        self._exit_raw_repl()
+        self.exit_raw_repl()
         out = output.decode(errors="ignore")
         debug(f"[DEBUG] tree output: {out}")
 

serial_plugin/serial_get_version.py

@@ -1,5 +1,4 @@
 from logging import getLogger, debug
-from time import sleep
 from serial_plugin.serial_base import SerialBase
 
 
@@ -30,41 +29,6 @@ def _extract_version(raw_output: str) -> str:
 
         return "No MicroPython version found"
 
-    def _wake_repl(self) -> None:
-        """
-        Invokes a wake-up sequence for the REPL (Read-Eval-Print Loop) interface by
-        interacting with the serial connection.
-
-        :return: None
-        """
-        self._ser.reset_input_buffer()
-        self._ser.write(b'\r\n')
-        sleep(0.2)
-
-        self._ser.read_all()
-
-    def _send_command(self, command: str, wait: float = 0.3) -> str:
-        """
-        Sends a command to the REPL interface and retrieves its output.
-
-        :param command: The command to be sent to the REPL interface.
-        :type command: str
-        :param wait: The amount of time, in seconds.
-        :type wait: float, optional
-        :return: The output received from the REPL
-        :rtype: str
-        :raises RuntimeError: If the REPL interface is not connected or available.
-        """
-        if not self._ser or not self._ser.is_open:
-            raise RuntimeError("REPL not connected")
-
-        self._ser.write(command.encode() + b'\r\n')
-        sleep(wait)
-
-        output = self._ser.read_all().decode(errors='ignore')
-        debug(f"[DEBUG] command output: {output}")
-        return output.strip()
-
     def get_version(self) -> str:
         """
         Extracts and returns the Python version from the command output.
@@ -73,5 +37,7 @@ def get_version(self) -> str:
         :return: The extracted Python version as a string.
         :rtype: str
         """
-        output = self._send_command("import sys; print(sys.version)")
+        output = self.send_command("import sys; print(sys.version)")
+        debug(f"[DEBUG] version output: {output}")
+
         return self._extract_version(output)