fixing plc_config.json issue if this file wasn't there by creating a file with N…

…one values, adding and uptading comments on this file

fixing plc_config.json issue if this file wasn't there by creating a file with N…
…one values, adding and uptading comments on this file
Alexis Koralewski
1 parent d45d4a0b
Showing 1 changed file with 84 additions and 26 deletions Show diff stats
src/core/pyros_django/monitoring/plc_checker.py
@@ -39,12 +39,16 @@ class PlcChecker(object):
         self.sensors_table = []
         self.load_config()
  
-    def monitor_name_switch(self, cmd_args):
+    def monitor_name_switch(self, cmd_args:str)->None:
         """
-        Replace sensor's monitring_name
-        cmd : monitor_name_switch None Came:/S/N_A5EM:/Power_input SHUTTERS
-        :param cmd_args: ex:  None Came:/S/N_A5EM:/Power_input SHUTTERS
-        :return:
+        Replace sensor's monitoring_name
+        example of full cmd : monitor_name_switch None Came:/S/N_A5EM:/Power_input SHUTTERS
+
+        Args:
+            param cmd_args : arguments of command (example:  None Came:/S/N_A5EM:/Power_input SHUTTERS)
+        
+        Returns :
+            None
         """
         #TODO test
         old_monitoring_name, sensor_id, new_monitoring_name = cmd_args.split(" ")
@@ -53,13 +57,17 @@ class PlcChecker(object):
                 self.sensors_table[5] = new_monitoring_name
         self.save_config()
  
-    def sensor_switch(self, cmd_args):
+    def sensor_switch(self, cmd_args:str)->None:
         """
         Replace monitoring_mame's sensor
         and switch selected in  sensors_table
-        cmd : sensor_switch Temperature_outside CV7:/S/N_09172419:/OutsideTemperature
-        :param cmd_args: Temperature_outside CV7:/S/N_09172419:/OutsideTemperature
-        :return:
+
+        Args:
+        example of cmd : sensor_switch Temperature_outside CV7:/S/N_09172419:/OutsideTemperature
+        :param cmd_args: arguments of command (example : Temperature_outside CV7:/S/N_09172419:/OutsideTemperature)
+        
+        Returns : 
+            None
         """
         #TODO test
         #  Replace monitoring_mame's sensor
@@ -77,18 +85,28 @@ class PlcChecker(object):
                     self.sensors_table[7] = ""
         self.save_config()
  
-    def reset_plc_checker(self, cmd_args):
+    def reset_plc_checker(self, cmd_args)->None:
         """
         Change plc_origin and next json check will make it reset
-        :param cmd_args: Not used
-        :return:
+
+        Args:
+            cmd_args: Not used
+        
+        Returns:
+            None
         """
         #TODO test
         no_arg = cmd_args
         self.origin["plc_origin"] = "Tataouine"
         self.origin["plc_origin"] = "Tataouine Observatory"
  
-    def load_config(self):
+    def load_config(self)->None:
+        """
+        Load config file (in json format) and update values of the attributes of this class
+
+        If the config file isn't found, it will call save_config() to create file with null values.
+        Those values will be updated by chk_config() called by agentM.
+        """
         try:
             # ok with ./start_agent agentM
             #plc_config_dir = Path("./monitoring/")
@@ -107,10 +125,18 @@ class PlcChecker(object):
             logger.info("Loaded : plc_config.json")
             colibri_json.close
         except:
-            logger.error("No plc_config.json")
-            raise Exception(f"Could not load plc_config.json ; current dir is {os.getcwd()} ; plc_config_dir is {plc_config_dir}")
+            # logger.error("No plc_config.json")
+            # raise Exception(f"Could not load plc_config.json ; current dir is {os.getcwd()} ; plc_config_dir is {plc_config_dir}")
+            # if the file doesn't exist we're creating a new one with initial values (null values)
+            self.save_config()
  
-    def save_config(self):
+    def save_config(self)->None:
+        """
+        Save current config into json file.
+
+        Raises:
+            Exception: failed to write into config file.
+        """
         try:
             _struct = {}
             _struct["origin"] = self.origin
@@ -129,16 +155,23 @@ class PlcChecker(object):
             logger.error("Not saved plc_config.json")
             raise Exception(f"Could not save plc_config.json ; current dir is {os.getcwd()} ; plc_config_dir is {plc_config_dir}")
  
-    def init_monitoring_names(self):
+    def init_monitoring_names(self)->None:
+        """
+        Initialize monitoring names with None values.
+        """
         for sensor in self.monitoring_names:
             self.monitoring_names[sensor] = None
  
-    def chk_config(self, status_plc):
+    def chk_config(self, status_plc:json)->bool:
         """
         Load struct new status_plc and check origin
-        If origin changed. First time (ori or other PLC
-        :param status_plc:
-        :return: True
+        If origin changed. First time (original or other PLC)
+
+        Args:
+            param status_plc: json given by plc (astroguita)
+
+        Returns:
+            True
         """
         try:
             struct = json.loads(status_plc)
@@ -155,7 +188,13 @@ class PlcChecker(object):
                 self.save_config()
         return True
  
-    def same_origin(self):
+    def same_origin(self)->bool:
+        """
+        Check if the origin from the json is the same as the plcChecker.
+        If they are different, it will update the origin and site values.
+        Returns:
+            Bool: True if they're the same, false otherwise
+        """
         # check new origin
         print('?')
         if self.struct["origin"] == self.origin["plc_origin"] and self.struct["site"] == self.origin["plc_site"]:
@@ -168,7 +207,7 @@ class PlcChecker(object):
             self.init_monitoring_names()
             return False
  
-    def known_sensor(self, name):
+    def known_sensor(self, name:str)->str:
         known = None
         if name in self.monitoring_names.keys():
             known = name
@@ -181,18 +220,34 @@ class PlcChecker(object):
            selected = "checked"
         return selected
  
-    def get_key(self, struct, key):
+    def get_key(self, struct:dict, key:str)->any:
+        """
+        Return value associate to key in struct
+
+        Args:
+            struct (dict): 
+            key (str): 
+
+        Returns:
+            any: the corresponding object of that key in struct
+        """
         try:
             ret = struct[key]
         except:
             ret = None
         return ret
  
-    def get_sensor(self, monitored):
+    def get_sensor(self, monitored:str)->any:
         """
         Return value from struct with path = monitoring_names.key(monitored)
         ex:'RG11:/S/N_207588:/RainSate'
         ex:'DHT22:/MiFe_DHT1_1:/Humidity'
+
+        Args:
+            monitored (str): sensor name
+
+        Returns:
+            any: value associated to that sensor name.
         """
         _id = self.monitoring_names[monitored]
         _value = None
@@ -206,7 +261,10 @@ class PlcChecker(object):
         return _value
  
  
-    def scan_sensors(self):
+    def scan_sensors(self)->None:
+        """
+        log and update sensors table from struct
+        """
         # return sensors table from struct
         # TODO doc it
         self.sensors_table = []