Merge pull request #187 from semuconsulting/streamline-config

RC 1.5.7

Author: semuadmin

RELEASE_NOTES.md

@@ -1,5 +1,17 @@
 # PyGPSClient Release Notes
 
+### RELEASE 1.5.7
+
+FIXES:
+
+1. Fixes some typos in MQTT configuration settings (mqtt rather than mgtt) **NB:** recommend saving a new json configuration file for this version.
+
+ENHANCEMENTS:
+
+1. Refactor configuration settings - new `Configuration` class in `configuration.py`.
+1. Streamline command line argument handling.
+1. Add 'Decode SPARTN in console' checkbox to SPARTN config dialog.
+
 ### RELEASE 1.5.6
 
 1. Enhancements to Dynamic Configuration Panel to allow POLL arguments to be entered for those poll commands that require them.

docs/pygpsclient.rst

@@ -36,6 +36,14 @@ pygpsclient.chart\_frame module
    :show-inheritance:
    :undoc-members:
 
+pygpsclient.configuration module
+--------------------------------
+
+.. automodule:: pygpsclient.configuration
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 pygpsclient.confirm\_box module
 -------------------------------
 

images/app.png

@@ -21,7 +21,7 @@
     "spartnprot_b": 1,
     "degreesformat_s": "DD.D",
     "colortag_b": 0,
-    "units_s": "MM",
+    "units_s": "Metric m/s",
     "autoscroll_b": 1,
     "maxlines_n": 200,
     "consoleformat_s": "Parsed",
@@ -83,13 +83,14 @@
     "mqttclientserver_s": "",
     "mqttclientport_n": 8883,
     "mqttclientid_s": "<<=== YOUR MQTT CLIENT ID ===>",
-    "mgttclientregion_s": "eu",
-    "mgttclientmode_n": 0,
-    "mgttclienttopicip_b": 1,
-    "mgttclienttopicmga_b": 1,
-    "mgttclienttopickey_b": 1,
-    "mgttclienttlscrt_s": "<=== FULLY QUALIFIED PATH TO MQTT CRT FILE ===>",
-    "mgttclienttlskey_s": "<=== FULLY QUALIFIED PATH TO MQTT KEY FILE ===>",
+    "mqttclientregion_s": "eu",
+    "mqttclientmode_n": 0,
+    "mqttclienttopicip_b": 1,
+    "mqttclienttopicmga_b": 1,
+    "mqttclienttopickey_b": 1,
+    "mqttclienttopicfreq_b": 0,
+    "mqttclienttlscrt_s": "<=== FULLY QUALIFIED PATH TO MQTT CRT FILE ===>",
+    "mqttclienttlskey_s": "<=== FULLY QUALIFIED PATH TO MQTT KEY FILE ===>",
     "lbandclientbpsrate_n": 9600,
     "lbandclientdatabits_n": 8,
     "lbandclientstopbits_f": 1.0,
@@ -281,6 +282,14 @@
             "NTRIP",
             "#9f30c1"
         ],
+        [
+            "MQTT",
+            "#a53570"
+        ],
+        [
+            "LBAND",
+            "#a53570"
+        ],
         [
             "txbuf alloc",
             "red"

pygpsclient.json

@@ -8,8 +8,7 @@ dynamic = ["version"]
 authors = [{ name = "semuadmin", email = "[email protected]" }]
 maintainers = [{ name = "semuadmin", email = "[email protected]" }]
 description = "GNSS Diagnostic and UBX Configuration GUI Application"
-license = { file = "LICENSE" }
-#license-files = ["LICENSE"]
+license-files = ["LICENSE"]
 keywords = [
     "PyGPSClient",
     "GNSS",
@@ -52,7 +51,7 @@ classifiers = [
 dependencies = [
     "requests>=2.28.0",
     "Pillow>=9.0.0",
-    "pygnssutils>=1.1.11",
+    "pygnssutils>=1.1.12",
     "pyubxutils>=1.0.2",
     "pyserial>=3.5",
 ]

pyproject.toml

@@ -9,9 +9,8 @@
 """
 
 import sys
-from argparse import ArgumentDefaultsHelpFormatter, ArgumentParser
+from argparse import SUPPRESS, ArgumentDefaultsHelpFormatter, ArgumentParser
 from logging import getLogger
-from os import getenv
 from tkinter import Tk
 
 from pygnssutils import (
@@ -28,12 +27,8 @@
 from pygpsclient.globals import (
     APPNAME,
     CONFIGFILE,
-    DEFAULT_PASSWORD,
-    DEFAULT_REGION,
-    DEFAULT_USER,
     SPARTN_BASEDATE_CURRENT,
     SPARTN_BASEDATE_DATASTREAM,
-    SPARTN_DEFAULT_KEY,
 )
 from pygpsclient.strings import EPILOG
 
@@ -50,84 +45,72 @@ def main():
     ap.add_argument(
         "-C",
         "--config",
-        required=False,
         help="Fully-qualified path to configuration file",
         default=CONFIGFILE,
     )
     ap.add_argument(
         "-U",
         "--userport",
-        required=False,
         help="User-defined GNSS receiver port",
-        default=getenv("PYGPSCLIENT_USERPORT", ""),
+        default=SUPPRESS,
     )
     ap.add_argument(
         "-S",
         "--spartnport",
-        required=False,
         help="User-defined SPARTN receiver port",
-        default=getenv("PYGPSCLIENT_SPARTNPORT", ""),
+        default=SUPPRESS,
     )
     ap.add_argument(
         "--mqapikey",
-        required=False,
         help="MapQuest API Key",
-        default=getenv("MQAPIKEY", ""),
+        default=SUPPRESS,
     )
     ap.add_argument(
         "--mqttclientid",
-        required=False,
         help="MQTT Client ID",
-        default=getenv("MQTTCLIENTID", ""),
+        default=SUPPRESS,
     )
     ap.add_argument(
         "--mqttclientregion",
-        required=False,
         help="MQTT Client Region",
-        default=getenv("MQTTCLIENTREGION", DEFAULT_REGION),
+        default=SUPPRESS,
     )
     ap.add_argument(
         "--mqttclientmode",
-        required=False,
         help="MQTT Client Mode (0 - IP, 1 - L-Band)",
-        default=getenv("MQTTCLIENTMODE", "0"),
-        type=int,
+        default=SUPPRESS,
     )
     ap.add_argument(
         "--ntripcasteruser",
-        required=False,
         help="NTRIP Caster authentication user",
-        default=getenv("NTRIPCASTER_USER", DEFAULT_USER),
+        default=SUPPRESS,
     )
     ap.add_argument(
         "--ntripcasterpassword",
-        required=False,
         help="NTRIP Caster authentication password",
-        default=getenv("NTRIPCASTER_PASSWORD", DEFAULT_PASSWORD),
+        default=SUPPRESS,
     )
     ap.add_argument(
         "--spartnkey",
-        required=False,
         help="SPARTN message decryption key",
-        default=getenv("MQTTKEY", SPARTN_DEFAULT_KEY),
+        default=SUPPRESS,
     )
     ap.add_argument(
         "--spartnbasedate",
-        required=False,
         help=f"SPARTN message decryption timetag ({SPARTN_BASEDATE_CURRENT} = \
             current datetime, {SPARTN_BASEDATE_DATASTREAM} = use timetags from data stream)",
-        default=SPARTN_BASEDATE_CURRENT,
         type=int,
+        default=SUPPRESS,
     )
     ap.add_argument(
         "--verbosity",
-        required=False,
         help=(
             f"Log message verbosity "
             f"{VERBOSITY_CRITICAL} = critical, "
             f"{VERBOSITY_LOW} = low (error), "
             f"{VERBOSITY_MEDIUM} = medium (warning), "
-            f"{VERBOSITY_HIGH} = high (info), {VERBOSITY_DEBUG} = debug"
+            f"{VERBOSITY_HIGH} = high (info), {VERBOSITY_DEBUG} = debug, "
+            f"default = {VERBOSITY_CRITICAL}"
         ),
         type=int,
         choices=[
@@ -141,9 +124,7 @@ def main():
     )
     ap.add_argument(
         "--logtofile",
-        required=False,
         help="fully qualified log file name, or '' for no log file",
-        type=str,
         default="",
     )
     kwargs = vars(ap.parse_args())

src/pygpsclient/__main__.py

@@ -8,4 +8,4 @@
 :license: BSD 3-Clause
 """
 
-__version__ = "1.5.6"
+__version__ = "1.5.7"

src/pygpsclient/_version.py

@@ -77,8 +77,7 @@ def __init__(self, app, **kwargs):  # pylint: disable=unused-argument
         self._img_exit = ImageTk.PhotoImage(Image.open(ICON_EXIT))
         self._img_sponsor = ImageTk.PhotoImage(Image.open(ICON_SPONSOR))
         self._checkonstartup = IntVar()
-        cfu = self.__app.saved_config.get("checkforupdate_b", False)
-        self._checkonstartup.set(cfu)
+        self._checkonstartup.set(self.__app.configuration.get("checkforupdate_b"))
         self._updates = []
 
         self._body()
@@ -199,7 +198,16 @@ def _attach_events(self):
         self._lbl_copyright.bind("<Button>", self._on_license)
         self._btn_ok.bind("<Return>", self._ok_press)
         self._btn_ok.focus_set()
-        self._checkonstartup.trace_add("write", self._on_save_settings)
+        self._checkonstartup.trace_add("write", self._on_update_config)
+
+    def _on_update_config(self, var, index, mode):  # pylint: disable=unused-argument
+        """
+        Save current settings to saved app config dict.
+        """
+
+        self.__app.configuration.set(
+            "checkforupdate_b", int(self._checkonstartup.get())
+        )
 
     def _on_github(self, *args, **kwargs):  # pylint: disable=unused-argument
         """
@@ -295,10 +303,3 @@ def _do_update(self, *args, **kwargs):  # pylint: disable=unused-argument
 
         self._btn_checkupdate.config(text="RESTART APP", fg=OKCOL)
         self._btn_checkupdate.bind("<Button>", self.__app.on_exit)
-
-    def _on_save_settings(self, var, index, mode):  # pylint: disable=unused-argument
-        """
-        Save current settings to saved app config dict.
-        """
-
-        self.__app.saved_config["checkforupdate_b"] = self._checkonstartup.get()