User config documentation and better REPL inspection capabilities

Author: psychogenic

src/ttboard/config/config_file.py

@@ -43,6 +43,13 @@ def load(self, filepath:str):
         except: # no FileNotFoundError on uPython
             log.warn(f'Could not load config file {filepath}')
 
+    @property
+    def filepath(self):
+        return self._inifile_path
+    
+    @filepath.setter 
+    def filepath(self, set_to:str):
+        self.load(set_to)
     @property 
     def is_loaded(self):
         return self._ini_file_loaded

src/ttboard/config/user_config.py

@@ -12,6 +12,31 @@
 log = logging.getLogger(__name__)
 
 class UserProjectConfig:
+    '''
+        Configuration specific to a project, held in a section with the 
+        project's shuttle name, e.g.
+        
+            [tt_um_psychogenic_neptuneproportional]
+            # set clock to 4kHz
+            clock_frequency = 4000
+            # clock config 4k, disp single bits
+            input_byte = 0b11001000
+            mode = ASIC_ON_BOARD
+        
+        You can use this to set:
+            - mode (str)
+            - start_in_reset (bool)
+            - input_byte (int)
+            - bidir_direction (int)
+            - bidir_byte (int)
+            - clock_frequency (int)
+            
+        all keys are optional.
+        
+        A repr function lets you see the basics, do a print(tt.user_config.tt_um_someproject) to
+        see more info.
+
+    '''
     def __init__(self, section:str, conf:ConfigParser):
         self.section = section 
         self._config = conf 
@@ -20,6 +45,8 @@ def __init__(self, section:str, conf:ConfigParser):
     def config(self):
         return self._config
 
+
+    
     def has(self, name:str):
         return  self.config.has_option(self.section, name)
 
@@ -31,10 +58,58 @@ def get(self, name:str):
 
     def __getattr__(self, name):
         return self.get(name)
+    
+    def _properties_dict(self, include_unset:bool=False):
+        ret = dict()
+        known_attribs = ['mode', 'start_in_reset', 'input_byte',
+                         'bidir_direction',
+                         'bidir_byte',
+                         'clock_frequency',
+                         ]
+        for atr in known_attribs:
+            v = self.get(atr)
+            if v is not None or include_unset:
+                ret[atr] = v
+        
+        return ret
 
+    def __repr__(self):
+        props = self._properties_dict(True)
+        return f'<UserProjectConfig {self.section}, {props["clock_frequency"]}Hz, mode: {props["mode"]}>'
 
+    def __str__(self):
+        return f'UserProjectConfig {self.section}\n{self._properties_dict()}'
 
 class UserConfig(ConfigFile):
+    '''
+        Encapsulates the configuration for defaults and all the projects, in sections.
+        The DEFAULT section holds system wide defaults and the default project to load
+        on startup.
+        
+        DEFAULT section may have
+        
+            # project: project to load by default
+            project = tt_um_test
+            
+            # start in reset (bool)
+            start_in_reset = no
+            
+            # mode can be any of
+            #  - SAFE: all RP2040 pins inputs
+            #  - ASIC_ON_BOARD: TT inputs,nrst and clock driven, outputs monitored
+            #  - ASIC_MANUAL_INPUTS: basically same as safe, but intent is clear
+            mode = ASIC_ON_BOARD
+            
+            # log_level can be one of
+            #  - DEBUG
+            #  - INFO
+            #  - WARN
+            #  - ERROR
+            log_level = INFO
+        Each project section is named [SHUTTLE_PROJECT_NAME]
+        and will be an instance of, and described by, UserProjectConfig
+    '''
+    
     def __init__(self, ini_filepath:str='config.ini'):
         super().__init__(ini_filepath)
 
@@ -70,5 +145,19 @@ def project(self, name:str):
 
         return UserProjectConfig(name, self.ini_file)
 
+    def __getattr__(self, name):
+        if name in self.sections:
+            return self.project(name)
+    
+    def __dir__(self):
+        return self.sections
+    def __repr__(self):
+        return f'<UserConfig {self.filepath}, default project: {self.default_project}>'
+    
+    def __str__(self):
+        def_mode = self.default_mode
+        if def_mode is not None:
+            def_mode = RPMode.to_string(def_mode)
+        return f'UserConfig {self.filepath}, Defaults:\nproject: {self.default_project}\nmode: {def_mode}'