checklist: added logging

log completion of checklist items

Author: tridge

MAVProxy/modules/lib/mp_checklist.py

@@ -6,6 +6,9 @@
 """
 
 import sys
+import os
+import time
+import datetime
 from MAVProxy.modules.lib import mp_util
 from MAVProxy.modules.lib import multiproc
 from MAVProxy.modules.lib.wx_loader import wx
@@ -23,12 +26,13 @@ class CheckUI():
     '''
     a checklist UI for MAVProxy
     '''
-    def __init__(self, title='MAVProxy: Checklist', checklist_file=None):
+    def __init__(self, title='MAVProxy: Checklist', checklist_file=None, logdir=None):
         import threading
-        self.title  = title
+        self.title = title
         self.menu_callback = None
         self.checklist_file = checklist_file
-        self.parent_pipe,self.child_pipe = multiproc.Pipe()
+        self.logdir = logdir
+        self.parent_pipe, self.child_pipe = multiproc.Pipe()
         self.close_event = multiproc.Event()
         self.close_event.clear()
         self.child = multiproc.Process(target=self.child_task)
@@ -67,6 +71,9 @@ def __init__(self, state, title):
         self.state = state
         wx.Frame.__init__(self, None, title=title, size=(600,600), style=wx.DEFAULT_FRAME_STYLE)
 
+        # Track previously checked states to detect changes
+        self.previous_states = {}
+
         #use tabs for the individual checklists
         self.createLists()
         self.panel = wx.Panel(self)
@@ -131,6 +138,19 @@ def createLists(self):
             'GCS stable'
             ]
 
+    def log_check_item(self, item_name, state):
+        '''Log a checkbox state change to file'''
+        if self.state.logdir is not None:
+            log_path = os.path.join(self.state.logdir, "checklist_log.txt")
+            timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+
+            statestr = "CHECKED" if state else "UNCHECKED"
+            try:
+                with open(log_path, 'a') as f:
+                    f.write(f"{timestamp}: {item_name} - {statestr}\n")
+            except Exception as e:
+                print(f"Error writing to checklist log: {e}")
+
     # create controls on form - labels, buttons, etc
     def createWidgets(self):
         #create the panels for the tabs
@@ -149,8 +169,15 @@ def createWidgets(self):
 
             # Add each checkbox to the scrolled window
             for key in self.lists[name]:
-                CheckBox = wx.CheckBox(scrolled_window, wx.ID_ANY, key)
-                box.Add(CheckBox, 0, wx.ALL, 5)
+                checkbox = wx.CheckBox(scrolled_window, wx.ID_ANY, key)
+                box.Add(checkbox, 0, wx.ALL, 5)
+                
+                # Setup the event handler for manual checkbox changes
+                checkbox.Bind(wx.EVT_CHECKBOX, self.on_checkbox_change)
+                
+                # Initialize previous state tracking
+                checkbox_id = f"{name}:{key}"
+                self.previous_states[checkbox_id] = False
 
             # Create a sizer for the panel and add the scrolled window to it
             panel_sizer = wx.BoxSizer(wx.VERTICAL)
@@ -160,10 +187,24 @@ def createWidgets(self):
             # Add the panel to the notebook
             self.nb.AddPage(panel, name)
 
+    def on_checkbox_change(self, event):
+        '''Handle manual checkbox changes'''
+        checkbox = event.GetEventObject()
+        is_checked = checkbox.GetValue()
+        checkbox_text = checkbox.GetLabel()
+        
+        # Get current tab name
+        tab_idx = self.nb.GetSelection()
+        tab_name = self.nb.GetPageText(tab_idx)
+        
+        # Log the check if it's newly checked
+        self.log_check_item(checkbox_text, is_checked)
+
     #Receive messages from MAVProxy and process them
     def on_timer(self, event, notebook):
         state = self.state
         page = notebook.GetPage(notebook.GetSelection())
+        tab_name = notebook.GetPageText(notebook.GetSelection())
 
         if state.close_event.wait(0.001):
             self.timer.Stop()
@@ -180,15 +221,30 @@ def on_timer(self, event, notebook):
                         # Go through each item in the current tab and (un)check as needed
                         for widget in scrolled_window.GetChildren():
                             if isinstance(widget, wx.CheckBox) and widget.GetLabel() == obj.name:
+                                # Check if this is a change from unchecked to checked
+                                checkbox_id = f"{tab_name}:{obj.name}"
+                                was_checked = self.previous_states.get(checkbox_id, False)
+                                
+                                # Update the checkbox
                                 widget.SetValue(obj.state)
+                                
+                                # Update previous state
+                                self.previous_states[checkbox_id] = obj.state
+                                break
                         break
 
 
 if __name__ == "__main__":
     # test the console
     import time
-
-    checklist = CheckUI()
+    
+    # Create a test log directory if it doesn't exist
+    test_logdir = os.path.join(os.getcwd(), "checklist_logs")
+    if not os.path.exists(test_logdir):
+        os.makedirs(test_logdir)
+    
+    # Initialize with the log directory
+    checklist = CheckUI(logdir=test_logdir)
 
     #example auto-tick in second tab page
     while checklist.is_alive():

MAVProxy/modules/mavproxy_checklist.py

@@ -18,7 +18,7 @@ def __init__(self, mpstate):
             path = os.path.join(mpstate.aircraft_dir, "checklist.txt")
             if os.path.exists(path):
                 checklist_file = path
-        self.checklist = mp_checklist.CheckUI(checklist_file=checklist_file)
+        self.checklist = mp_checklist.CheckUI(checklist_file=checklist_file, logdir=self.logdir)
 
     def mavlink_packet(self, msg):
         '''handle an incoming mavlink packet'''