Improve docs for config

BiogasControllerApp.spec

@@ -1,5 +1,6 @@
 # -*- mode: python ; coding: utf-8 -*-
 from kivy_deps import sdl2, glew
+from kivymd import hooks_path as kivymd_hooks_path
 
 block_cipher = None
 
@@ -10,7 +11,7 @@ a = Analysis(
     binaries=[],
     datas=[],
     hiddenimports=[],
-    hookspath=[],
+    hookspath=[kivymd_hooks_path],
     hooksconfig={},
     runtime_hooks=[],
     excludes=[],

biogascontrollerapp.py

@@ -28,7 +28,7 @@ print(
 ━━━━━━━━━━━┏━┛┃━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┃┃━━┃┃━━
 ━━━━━━━━━━━┗━━┛━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┗┛━━┗┛━━
 
-                            Version 3.2.1
+                            Version 3.2.2
 
  => Initializing....
           """
@@ -36,6 +36,9 @@ print(
 
 # Load the config file
 import time
+import sys
+
+from kivy.resources import resource_add_path
 from util.config import read_config, set_verbosity, str_to_bool
 
 verbose = str_to_bool(read_config("Dev", "verbose", "False", type_to_validate="bool"))
@@ -186,7 +189,7 @@ class BiogasControllerApp(MDApp):
             print("\n", "-" * 20, "\n")
 
         self.icon = "./BiogasControllerAppLogo.png"
-        self.title = "BiogasControllerApp-V3.2.1"
+        self.title = "BiogasControllerApp-V3.2.2"
         self.screen_manager.add_widget(HomeScreen(com, name="home"))
         self.screen_manager.add_widget(MainScreen(com, name="main"))
         self.screen_manager.add_widget(ProgramScreen(com, name="program"))
@@ -205,10 +208,12 @@ if __name__ == "__main__":
 
     # Start the application
     try:
+        if hasattr(sys, "_MEIPASS"):
+            resource_add_path(os.path.join(sys._MEIPASS))
         BiogasControllerApp().run()
     except Exception as e:
         print("Failed to run BiogasControllerApp!")
         if verbose:
             print(e)
-        time.sleep(5)
+        input("Press enter to continue.")
     print("\n => Exiting!")

changelog

@@ -1,4 +1,7 @@
 ***CHANGELOG***
+V3.2.2
+- Fix issues with Windows distributable: kivymd build
+
 V3.2.1
 - Fix issue with Windows distributable: kivymd not found
 

gui/home/home.kv

@@ -40,7 +40,7 @@
                 on_release: root.quit()
 
         MDLabel:
-            text: "You are running version V3.2.1"
+            text: "You are running version V3.2.2"
             font_size: 13
             pos_hint: {"y": -0.45, "x":0}
             halign: 'center'

util/config.py

@@ -47,11 +47,12 @@ def read_config(
         key_0: The first key (top level)
         key_1: The second key (where the actual key-value pair is)
         default: The default value to return if the check fails
-        valid_entries: [Optiona] The entries that are valid ones to check against
+        valid_entries: [Optional] The entries that are valid ones to check against
         type_to_validate: [Optional] Data type to validate
 
     Returns:
-        [TODO:return]
+        The read config option as a string. You can cast this to the type you specified with type_to_validate safely.
+        When converting to a boolean though, use the str_to_bool function provided by this library
     """
     # Try loading the keys
     tmp = {}

util/test/com.py

@@ -249,7 +249,7 @@ class Com(ControllerConnection):
     def __add_integer_as_hex(self, c: int):
         """Writes the hexadecimal representation of the high and low bytes of integer `c` (16-bit) to the simulated serial port."""
         if not (0 <= c <= 0xFFFF):
-            raise ValueError("Input must be a 16-bit integer (0–65535)")
+            raise ValueError("Input must be a 16-bit integer (0-65535)")
 
         # Get high byte (most significant byte)
         hi_byte = (c >> 8) & 0xFF