- framework.py now has a VERSION variable indicating the pyControl version. On connecting to a pyboard the framework version is read by the GUI and displayed in the log. If the framework version does not match the GUI version a message is displayed recomending reloading the framework. The framework version and micropython version are now saved in datafiles.

Author: ThomasAkam

com/data_logger.py

@@ -35,6 +35,8 @@ def open_data_file(self, data_dir, experiment_name, setup_ID, subject_ID, dateti
         self.data_file.write('I Task name : {}\n'.format(self.sm_info['name']))
         self.data_file.write('I Task file hash : {}\n'.format(self.sm_info['task_hash']))
         self.data_file.write('I Setup ID : {}\n'.format(self.setup_ID))
+        self.data_file.write('I Framework version : {}\n'.format(self.sm_info['framework_version']))
+        self.data_file.write('I Micropython version : {}\n'.format(self.sm_info['micropython_version']))
         self.data_file.write('I Subject ID : {}\n'.format(self.subject_ID))
         self.data_file.write('I Start date : ' + datetime_now.strftime('%Y/%m/%d %H:%M:%S') + '\n\n')
         self.data_file.write('S {}\n\n'.format(json.dumps(self.sm_info['states'])))

com/pycboard.py

@@ -6,6 +6,7 @@
 from array import array
 from .pyboard import Pyboard, PyboardError
 from config.paths import dirs
+from config.gui_settings import VERSION
 
 # ----------------------------------------------------------------------------------------
 #  Helper functions.
@@ -81,7 +82,10 @@ def __init__(self, serial_port,  baudrate=115200, verbose=True, print_func=print
                 self.print('Error: Unable to open serial connection.')
                 return
             if self.status['framework']:
-                self.print('pyControl Framework: OK')
+                self.print(f'Framework version: {self.framework_version}')
+                if self.framework_version != VERSION:
+                    self.print('\nThe pyControl framework version on the board does not match the GUI version. '
+                               'It is recommended to reload the pyControl framework to the pyboard to ensure compatibility.')
             else:
                 if self.status['framework'] is None:
                     self.print('pyControl Framework: Not loaded')
@@ -109,6 +113,10 @@ def reset(self):
                 self.status['framework'] = None # Framework not installed.
             else:
                 self.status['framework'] = False # Framework import error.
+        try:
+            self.framework_version = self.eval('fw.VERSION').decode()
+        except PyboardError:
+            self.framework_version = '<1.8'
         return error_message
 
     def hard_reset(self, reconnect=True):
@@ -309,7 +317,9 @@ def setup_state_machine(self, sm_name, sm_dir=None, uploaded=False):
                         'events': events, # {name:ID}
                         'ID2name': {ID: name for name, ID in {**states, **events}.items()}, # {ID:name}
                         'analog_inputs': self.get_analog_inputs(), # {name: {'ID': ID, 'Fs':sampling rate}}
-                        'variables': self.get_variables()} # {name: repr(value)}
+                        'variables': self.get_variables(),
+                        'framework_version': self.framework_version,
+                        'micropython_version': self.micropython_version} # {name: repr(value)}
         if self.data_logger:
             self.data_logger.set_state_machine(self.sm_info)
 

config/gui_settings.py

@@ -1,6 +1,6 @@
 # Graphical user interface settings.
 
-VERSION = '1.7.2'
+VERSION = '1.8'
 
 update_interval = 10 # Interval between calls to the GUIs update function (ms).
 

pyControl/framework.py

@@ -3,6 +3,8 @@
 from . import state_machine as sm
 from . import hardware as hw
 
+VERSION = '1.8'
+
 class pyControlError(BaseException): # Exception for pyControl errors.
     pass