Merge pull request #114 from pyonair/dev-latest

Dev latest

.flake8

@@ -0,0 +1,3 @@
+# Autoformatter friendly flake8 config (all formatting rules disabled)
+[flake8]
+extend-ignore = E1, E2, E3, E501, W1, W2, W3, W5

.gitignore

@@ -9,3 +9,5 @@ debug_config.json
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
+
+.vscode

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile=black

.markdownlint.yaml

@@ -0,0 +1,10 @@
+# Autoformatter friendly markdownlint config (all formatting rules disabled)
+default: true
+blank_lines: false
+bullet: false
+html: false
+indentation: false
+line_length: false
+spaces: false
+url: false
+whitespace: false

.trunk/.gitignore

@@ -0,0 +1 @@
+*out

.trunk/trunk.yaml

@@ -0,0 +1,12 @@
+version: 0.1
+cli:
+  version: 0.10.1-beta
+lint:
+  enabled:
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]
+    - [email protected]

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "python.analysis.extraPaths": ["./code/lib"]
+}

README.md

@@ -2,18 +2,17 @@
 
 ## Branches
 
-* main : prodcution 
-* dev-latest -- branch for all finalised features. 
+- main : prodcution
+- dev-latest -- branch for all finalised features.
 
 ## Adding code
 
 1. Branch `dev-latest`
-2. Name you branch `feature-*` `bug-*` `performance-*` `refactor-*` `doc-*`
-3. Edit your new branch 
-4. Pull request back to `dev-latest` when completed
-5. Expect a code review
-
-
+2. Name you branch `feature-*` `bug-*` `performance-*` `refactor-*`
+3. # Edit your new branch
+4. Name you branch `feature-*` `bug-*` `performance-*` `refactor-*` `doc-*`
+5. Edit your new branch
+6. Pull request back to `dev-latest` when completed
+7. Expect 2 code review(s)
 
 [https://www.pyonair.org](https://www.pyonair.org)
-

code/lib/Configuration.py

@@ -1,47 +1,63 @@
-import strings as s
-#from ubinascii import hexlify
-#from machine import unique_id
-#from network import LoRa
 import os
+
+import strings as s
 import ujson
-from Constants import *
 
-#TODO: memory hog, sort this class - static?
+# from ubinascii import hexlify
+# from machine import unique_id
+# from network import LoRa
+from Constants import (
+    CONFIG_FILE_DIRECTORY,
+    CONFIG_FILE_FULL_NAME,
+    CONFIG_FILE_NAME,
+    DEBUG_CONFIG_FILE_DIRECTORY,
+    DEBUG_CONFIG_FILE_FULL_NAME,
+    DEBUG_CONFIG_FILE_NAME,
+    DEFAULT_CONFIG,
+)
+
+# import imp
+
+# TODO: memory hog, sort this class - static?
+
 
 class ConfigurationException(Exception):
     """
     Exception to be thrown if Exception occurs in configuration
     """
-    #TODO: why?
+
+    # TODO: why?
     pass
 
 
+# Configuration
 class Configuration:
+    def __init__(self, logger):
+        self.logger = logger
+        self.configuration = {}
+        # RM
 
-    def __init__(self,logger):
-        self.logger= logger
-        self.configuration = {} 
-        #RM 
-
         self.read_configuration()
         print("CONFIG READ########################################")
 
     # Configuration Accessor/Getter
     def get_config(self, keys=None):
+
         """
+
         If keys are given, return corresponding values in a list, if one key is given, return the corresponding value,
         if no arguments are given, return the config dictionary
         :param keys: keys in configuration dictionary
         :type keys: None, list of keys or a single key
         :return: values in configuration dictionary
         :rtype: dict, list of any, any
         """
-        #TODO: Warn if key not in dict
+        # TODO: Warn if key not in dict
         if keys is None:
             return self.configuration
         if isinstance(keys, list):
             return list(self.configuration[k] for k in keys if k in self.configuration)
-            #TODO remove this multi option
+            # TODO remove this multi option
         else:
             return self.configuration[keys]
 
@@ -52,7 +68,7 @@ def set_config(self, new_config):
         :param new_config: set of new configuration key-value pairs
         :type new_config: dict
         """
-        
+
         self.configuration.update(new_config)
 
     #  Saves keys and preferences to sd card
@@ -64,42 +80,45 @@ def save_config(self, new_config):
         """
         self.set_config(new_config)
 
-        with open(s.root_path + CONFIG_FILE_NAME, 'w') as f:  # save credentials to sd card
+        with open(
+            s.root_path + CONFIG_FILE_NAME, "w"
+        ) as f:  # save credentials to sd card
+
             f.write(ujson.dumps(self.configuration))
 
     #  Reads and returns keys and preferences from sd card
     def read_configuration(self):
         """
         Read config file on SD card and load it to the configuration dict
         """
-        #set to default
+        # set to default
         self.configuration = DEFAULT_CONFIG
-
 
-        #if no config file
+        # if no config file
         if CONFIG_FILE_NAME not in os.listdir(CONFIG_FILE_DIRECTORY):
-            with open(CONFIG_FILE_FULL_NAME, 'w') as f:  # create new config file
+            with open(CONFIG_FILE_FULL_NAME, "w") as f:  # create new config file
                 f.write(ujson.dumps(self.configuration))
-                #self.set_config(str(self.configuration))
+                # self.set_config(str(self.configuration))
 
-        #load config
+        # load config
         if CONFIG_FILE_NAME in os.listdir(CONFIG_FILE_DIRECTORY):
-            with open(CONFIG_FILE_FULL_NAME, 'r') as f:
+            with open(CONFIG_FILE_FULL_NAME, "r") as f:
                 self.set_config(ujson.loads(f.read()))
                 self.logger.debug(str(self.configuration))
 
+        # check for debug force overwrite.
 
-        #check for debug force overwrite.
-
-
-        #Override Preferences - DEVELOPER USE ONLY - keep all overwrites here
+        # Override Preferences - DEVELOPER USE ONLY - keep all overwrites here
         if DEBUG_CONFIG_FILE_NAME in os.listdir(DEBUG_CONFIG_FILE_DIRECTORY):
-            self.logger.warning("Overriding configuration with the content of debug_config.json")
-
-            with open(DEBUG_CONFIG_FILE_FULL_NAME, 'r') as f:
-                self.set_config(ujson.loads(f.read()))
-                self.logger.warning("Configuration changed to: " + str(self.configuration))
+            self.logger.warning(
+                "Overriding configuration with the content of debug_config.json"
+            )
 
+            with open(DEBUG_CONFIG_FILE_FULL_NAME, "r") as f:
+                self.set_config(ujson.loads(f.read()))
+                self.logger.warning(
+                    "Configuration changed to: " + str(self.configuration)
+                )
 
     # Returns True if the configuration file is complete
     def is_complete(self, logger):
@@ -132,25 +151,25 @@ def reset_configuration(self, logger):
         :type logger: LoggerFactory object
         """
         try:
-            self.logger.warning("This wont work ") #TODO: this method needs sorting
+            self.logger.warning("This wont work ")  # TODO: this method needs sorting
             self.configuration.clear()  # clear configuration
             self.set_config(DEFAULT_CONFIG)  # set configuration to default
 
-            #disable Lora configs -- use pybytes
-            #self.set_config({"device_id": hexlify(unique_id()).upper().decode("utf-8")})  # set new device_id
+            # disable Lora configs -- use pybytes
+            # self.set_config({"device_id": hexlify(unique_id()).upper().decode("utf-8")})  # set new device_id
 
-            #lora = LoRa(mode=LoRa.LORAWAN)
-            #self.set_config({"device_eui": hexlify(lora.mac()).upper().decode('utf-8')})  # set new device_EUI
-            #del lora
+            # lora = LoRa(mode=LoRa.LORAWAN)
+            # self.set_config({"device_eui": hexlify(lora.mac()).upper().decode('utf-8')})  # set new device_EUI
+            # del lora
 
-            logger.info('Configurations were reset')
-            logger.warning('Please configure your device!')
+            logger.info("Configurations were reset")
+            logger.warning("Please configure your device!")
         except Exception as e:
-            logger.exception('Failed to reset configurations')
+            logger.exception("Failed to reset configurations")
             raise ConfigurationException(str(e))
 
     def getConfigDictionary(self):
         # TODO: that is a mess
         # global configuration dictionary
-        #config = Configuration()
+        # config = Configuration()
         return self.configuration