Feature/G9_Driver

.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.pyc
+usr/
+venv/
+.venv/
+build/
+dist/
+EBEAM-Dashboard-Logs/

dashboard.py

@@ -2,7 +2,61 @@
 import tkinter as tk
 from tkinter import ttk
 from utils import MessagesFrame, SetupScripts, LogLevel
-from usr.panel_config import save_pane_states, load_pane_states
+from usr.panel_config import save_pane_states, load_pane_states, saveFileExists
+
+# frames_config = [
+#     ("Oil System", 0, 50, 150),
+#     ("Visualization Gas Control", 0, 50, 150),
+#     ("System Checks", 0, None, None),
+#     ("Beam Extraction", 0, None, None),
+#     ("Vacuum System", 1, 150, 300),
+#     ("Deflection Monitor", 1, None, None),
+#     ("Beam Pulse", 1, None, None),
+#     ("Main Control", 1, 50, 300),
+#     ("Setup Script", 2, None, 25),
+#     ("Interlocks", 2, None, 25),
+#     ("High Voltage Warning", 2, None, 25),
+#     ("Environmental", 3, 150, 450),
+#     ("Cathode Heating", 3, 960, 450),
+# ]
+
+
+# # title, row, width, height
+# frames_config = [
+#     ("Interlocks", 0, None, 2),  # Moved to the top row
+#     ("Oil System", 0, 50, 150),
+#     ("Visualization Gas Control", 1, 50, 150),
+#     ("System Checks", 0, None, None),
+#     ("Beam Extraction", 0, None, None),
+#     ("Vacuum System", 1, 150, 300),
+#     ("Deflection Monitor", 1, None, None),
+#     ("Beam Pulse", 1, None, None),
+#     ("Main Control", 1, 50, 300),
+#     ("Setup Script", 2, None, 25),
+#     ("High Voltage Warning", 2, None, 25),
+#     ("Environmental", 3, 150, 450),
+#     ("Cathode Heating", 3, 960, 450),
+# ]
+
+
+# Only have the interlocks at the top of the display
+# title, row, width, height
+frames_config = [
+    ("Interlocks", 0, None, 2),  # Moved to the top row
+    ("Oil System", 1, 50, 150),
+    ("Visualization Gas Control", 2, 50, 150),
+    ("System Checks", 1, None, None),
+    ("Beam Extraction", 1, None, None),
+    ("Vacuum System", 2, 150, 300),
+    ("Deflection Monitor", 2, None, None),
+    ("Beam Pulse", 2, None, None),
+    ("Main Control", 2, 50, 300),
+    ("Setup Script", 3, None, 25),
+    ("High Voltage Warning", 3, None, 25),
+    ("Environmental", 4, 150, 450),
+    ("Cathode Heating", 4, 960, 450),
+]
+
 import serial.tools.list_ports
 
 class EBEAMSystemDashboard:
@@ -11,6 +65,11 @@ def __init__(self, root, com_ports):
         self.com_ports = com_ports
         self.root.title("EBEAM Control System Dashboard")
 
+
+        # if save file exists call it and open it
+        if saveFileExists():
+             self.load_saved_pane_state()
+
         # Initialize the frames dictionary to store various GUI components
         self.frames = {}
 
@@ -26,48 +85,31 @@ def __init__(self, root, com_ports):
         # Set up different subsystems within their respective frames
         self.create_subsystems()
 
-        # Load the saved state of the GUI pane layout if available
-        # self.load_saved_pane_state()
-
     def setup_main_pane(self):
         """Initialize the main layout pane and its rows."""
         self.main_pane = tk.PanedWindow(self.root, orient='vertical', sashrelief=tk.RAISED)
         self.main_pane.grid(row=0, column=0, sticky='nsew')
         self.root.grid_columnconfigure(0, weight=1)
         self.root.grid_rowconfigure(0, weight=1)
-
-        # Create horizontal paned windows for each row
         self.rows = [tk.PanedWindow(self.main_pane, orient='horizontal', sashrelief=tk.RAISED) for _ in range(5)]
         for row_pane in self.rows:
             self.main_pane.add(row_pane, stretch='always')
 
     def create_frames(self):
         """Create frames for different systems and controls within the dashboard."""
-        frames_config = [
-            ("Oil System", 0, 50, 150),
-            ("Visualization Gas Control", 0, 50, 150),
-            ("System Checks", 0, None, None),
-            ("Beam Extraction", 0, None, None),
-            ("Vacuum System", 1, 150, 300),
-            ("Deflection Monitor", 1, None, None),
-            ("Beam Pulse", 1, None, None),
-            ("Main Control", 1, 50, 300),
-            ("Setup Script", 2, None, 25),
-            ("Interlocks", 2, None, 25),
-            ("High Voltage Warning", 2, None, 25),
-            ("Environmental", 3, 150, 450),
-            ("Cathode Heating", 3, 960, 450),
-        ]
+        global frames_config
 
         for title, row, width, height in frames_config:
-            if width and height:
-                frame = tk.Frame(borderwidth=1, relief="solid", width=width, height=height)
+            if width and height and title:
+                frame = tk.Frame( borderwidth=1,highlightbackground="red", relief="solid", width=width, height=height)
                 frame.pack_propagate(False)
             else:
                 frame = tk.Frame(borderwidth=1, relief="solid")
+                # frame.pack_propagate(False)
 
             self.rows[row].add(frame, stretch='always')
-            self.add_title(frame, title)
+            if title != "Interlocks":
+                self.add_title(frame, title)
             self.frames[title] = frame
             if title == "Setup Script":
                 SetupScripts(frame)
@@ -97,13 +139,17 @@ def add_title(self, frame, title):
         label = tk.Label(frame, text=title, font=("Helvetica", 10, "bold"))
         label.pack(pady=0, fill=tk.X)
 
+    # saves data to file when button is pressed
     def save_current_pane_state(self):
-        num_sashes = len(self.rows) - 1  # Assuming each row might have one sash
-        save_pane_states(self.main_pane, num_sashes)
+        save_pane_states(frames_config, self.frames, self.main_pane)
 
+    # gets data in save config file (as dict) and updates the global var of frames_config
     def load_saved_pane_state(self):
-        num_sashes = len(self.rows) - 1
-        load_pane_states(self.main_pane, num_sashes)
+        savedData = load_pane_states()
+
+        for i in range(len(frames_config)):
+            if frames_config[i][0] in savedData:
+                frames_config[i] = (frames_config[i][0], frames_config[i][1], savedData[frames_config[i][0]][0],savedData[frames_config[i][0]][1])
 
     def create_log_level_dropdown(self, parent_frame):
         log_level_frame = ttk.Frame(parent_frame)
@@ -139,11 +185,13 @@ def create_subsystems(self):
                 logger=self.logger
             ),
             'Interlocks': subsystem.InterlocksSubsystem(
-                self.frames['Interlocks'], 
-                logger=self.logger
+                self.frames['Interlocks'],
+                com_ports = self.com_ports['Interlocks'],
+                logger=self.logger,
+                frames = self.frames
             ),
             'Oil System': subsystem.OilSubsystem(
-                self.frames['Oil System'], 
+                self.frames['Oil System'],
                 logger=self.logger
             ), 
             'Cathode Heating': subsystem.CathodeHeatingSubsystem(
@@ -155,8 +203,8 @@ def create_subsystems(self):
 
     def create_messages_frame(self):
         """Create a frame for displaying messages and errors."""
-        self.messages_frame = MessagesFrame(self.rows[3])
-        self.rows[3].add(self.messages_frame.frame, stretch='always')
+        self.messages_frame = MessagesFrame(self.rows[4])
+        self.rows[4].add(self.messages_frame.frame, stretch='always')
         self.logger = self.messages_frame.logger
 
     def create_com_port_frame(self, parent_frame):
@@ -173,7 +221,7 @@ def create_com_port_frame(self, parent_frame):
         self.port_selections = {}
         self.port_dropdowns = {}
 
-        for subsystem in ['VTRXSubsystem', 'CathodeA PS', 'CathodeB PS', 'CathodeC PS', 'TempControllers']:
+        for subsystem in ['VTRXSubsystem', 'CathodeA PS', 'CathodeB PS', 'CathodeC PS', 'TempControllers', 'Interlocks']:
             frame = ttk.Frame(self.com_port_menu)
             frame.pack(fill=tk.X, padx=5, pady=2)
             ttk.Label(frame, text=f"{subsystem}:").pack(side=tk.LEFT)

instrumentctl/errorTests.py

@@ -0,0 +1,101 @@
+import unittest
+from unittest.mock import MagicMock, patch
+from instrumentctl.g9_driver import G9Driver
+
+# Optional Data modified to throw no errors
+msg = b'@\x00\x00\xc3\x00\x00\xcb\x00\x00\x00\x00\x00\x08\x00\x00\x1f\xffC\x00\x1f\xff\xff\xff\x0f\x00\x1f\xff\xff\x00\x1f\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x01\x9a\x08\xbe\x14\x00\x0020000012X17M\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\n\n?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb2?\x00\x14\xac?\x00\x14\xac?\x00\x14\xac?\x00\x14\xa0?\x00\x14\xa0\x06\x00\x14\xb2\x01\x00\x14\xb2\x01\x00\x14\xb2\x01\x00\x14\xb2\x06\x00\x14\xb2\x01\x00\x14\xb2\x06\x00\x14\x9a\x01\x00\x14\x9a\x01\x00\x14\x9a\x06\x00\x14\x9a\x1a\xe8*\r'
+
+class TestG9Driver(unittest.TestCase):
+    UNIT_ERROR_MSG = b'@\x00\x00\xc3\x00\x00\xcb\x00\x00\x00\x00\x00\x08\x00\x00\x1f\xffC\x00\x1f\xff\xff\xff\x0f\x00\x1f\xff\xff\x00\x1f\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x02\x00\x9a\x08\xbe\x14\x00\x0020000012X17M\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\n\n?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb2?\x00\x14\xac?\x00\x14\xac?\x00\x14\xac?\x00\x14\xa0?\x00\x14\xa0\x06\x00\x14\xb2\x01\x00\x14\xb2\x01\x00\x14\xb2\x01\x00\x14\xb2\x06\x00\x14\xb2\x01\x00\x14\xb2\x06\x00\x14\x9a\x01\x00\x14\x9a\x01\x00\x14\x9a\x06\x00\x14\x9a\x1a\xe8*\r'
+    INPUT_ERROR_MSG = b'@\x00\x00\xc3\x00\x00\xcb\x00\x00\x00\x00\x00\x08\x00\x00\x1f\x00C\x00\x1f\xff\xff\xff\x0f\x00\x1f\xff\xff\x00\x1f\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x01\x9a\x08\xbe\x14\x00\x0020000012X17M\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\n\n?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb2?\x00\x14\xac?\x00\x14\xac?\x00\x14\xac?\x00\x14\xa0?\x00\x14\xa0\x06\x00\x14\xb2\x01\x00\x14\xb2\x01\x00\x14\xb2\x01\x00\x14\xb2\x06\x00\x14\xb2\x01\x00\x14\xb2\x06\x00\x14\x9a\x01\x00\x14\x9a\x01\x00\x14\x9a\x06\x00\x14\x9a\x1a\xe8*\r'
+    OUTPUT_ERROR_MSG = b'@\x00\x00\xc3\x00\x00\xcb\x00\x00\x00\x00\x00\x08\x00\x00\x1f\xffC\x00\x1f\x00\x00\xff\x0f\x00\x1f\xff\xff\x00\x1f\xff\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x01\x9a\x08\xbe\x14\x00\x0020000012X17M\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\n\n?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb8?\x00\x14\xb2?\x00\x14\xac?\x00\x14\xac?\x00\x14\xac?\x00\x14\xa0?\x00\x14\xa0\x06\x00\x14\xb2\x01\x00\x14\xb2\x01\x00\x14\xb2\x01\x00\x14\xb2\x06\x00\x14\xb2\x01\x00\x14\xb2\x06\x00\x14\x9a\x01\x00\x14\x9a\x01\x00\x14\x9a\x06\x00\x14\x9a\x1a\xe8*\r'
+
+    def create_message_with_checksum(self, base_message):
+        """Helper to create a message with valid checksum"""
+        message_without_checksum = base_message[:-4]  # Remove existing checksum and footer (these are probably incorrect in this older msg data)
+        checksum = self.driver.calculate_checksum(message_without_checksum)
+        return message_without_checksum + checksum + self.driver.FOOTER
+
+    def setUp(self):
+        self.driver = G9Driver()
+        self.driver.msgOptData = b'\x00\x00\x00\x00'
+        self.driver.ser = MagicMock()
+        self.driver.logger = MagicMock()
+
+    # Modified bytes msg[73:75] to ['02', '00'] to trigger a power supply error within unit status bytes
+    def test_unit_state_error(self):
+        msg_base = bytearray(self.UNIT_ERROR_MSG)
+        msg_base[73:75] = b'\x02\x00'  # Set US bytes to trigger power supply error
+        msg_with_checksum = self.create_message_with_checksum(bytes(msg_base))
+
+        self.driver.ser.read_until.return_value = msg_with_checksum
+
+        with self.assertRaises(ValueError) as context:
+            self.driver.read_response()
+        self.assertIn("Output Power Supply Error Flag (bit 9)", str(context.exception))
+
+    # changed 10 to \x00 instead of expected \xff
+    def test_input_error(self):
+        # Create base message with input error
+        msg_base = bytearray(self.INPUT_ERROR_MSG)
+        msg_base[self.driver.SITDF_OFFSET:self.driver.SITDF_OFFSET + 6] = b'\x00' * 6  # Set SITDF to all zeros
+        msg_with_checksum = self.create_message_with_checksum(bytes(msg_base))
+
+        self.driver.ser.read_until.return_value = msg_with_checksum
+
+        with self.assertRaises(ValueError) as context:
+            self.driver.read_response()
+        self.assertIn("Inputs off or in error state", str(context.exception))
+
+    # changed byte 20 to be \x00 instead of expected \xff
+    def test_output_error(self):
+        # Create base message with output error
+        msg_base = bytearray(self.OUTPUT_ERROR_MSG)
+        msg_base[self.driver.SOTDF_OFFSET:self.driver.SOTDF_OFFSET + 4] = b'\x00' * 4  # Set SOTDF to all zeros
+        msg_with_checksum = self.create_message_with_checksum(bytes(msg_base))
+
+        self.driver.ser.read_until.return_value = msg_with_checksum
+
+        with self.assertRaises(ValueError) as context:
+            self.driver.read_response()
+        self.assertIn("Outputs in off state", str(context.exception))
+
+
+    # test of normal excepted values
+    def test_no_error(self):
+        # Create message with valid checksum
+        msg_with_checksum = self.create_message_with_checksum(msg)
+        self.driver.ser.read_until.return_value = msg_with_checksum
+
+        try:
+            self.driver.read_response()
+        except ValueError as e:
+            self.fail(f"read_response() raised ValueError unexpectedly: {str(e)}")
+
+    def test_invalid_start_byte(self):
+        invalid_msg = b'\x41' + msg[1:]  # Replace start byte
+        msg_with_checksum = self.create_message_with_checksum(invalid_msg)
+        self.driver.ser.read_until.return_value = msg_with_checksum
+
+        with self.assertRaises(ValueError) as context:
+            self.driver.read_response()
+        self.assertIn("Invalid start byte", str(context.exception))
+
+    def test_invalid_length(self):
+        short_msg = msg[:-10]  # Remove last 10 bytes
+        self.driver.ser.read_until.return_value = short_msg
+
+        with self.assertRaises(ValueError) as context:
+            self.driver.read_response()
+        self.assertIn("Invalid response length", str(context.exception))
+
+    def test_checksum_validation(self):
+        bad_checksum_msg = msg[:-4] + b'\x00\x00' + msg[-2:]  # Replace checksum bytes
+        self.driver.ser.read_until.return_value = bad_checksum_msg
+
+        with self.assertRaises(ValueError) as context:
+            self.driver.read_response()
+        self.assertIn("Checksum validation failed", str(context.exception))
+
+if __name__ == '__main__':
+    unittest.main()