RC 1.7.3

README.md

@@ -15,7 +15,7 @@
 [Mapquest API Key](#mapquestapi) |
 [User-defined Presets](#userdefined) |
 [CLI Utilities](#cli) |
-[Troubleshooting](#troubleshoot) |
+[Troubleshooting & Known Issues](#troubleshoot) |
 [License](#license) |
 [Author Information](#author)
 
@@ -59,7 +59,7 @@ This is an independent project and we have no affiliation whatsoever with any GN
 
 The PyGPSClient home page is at [PyGPSClient](https://github.com/semuconsulting/PyGPSClient). 
 
-Contributions from human beings welcome - please refer to [CONTRIBUTING.MD](https://github.com/semuconsulting/PyGPSClient/blob/master/CONTRIBUTING.md).
+Contributions **_from human beings_** welcome - please refer to [CONTRIBUTING.MD](https://github.com/semuconsulting/PyGPSClient/blob/master/CONTRIBUTING.md).
 
 For [Bug reports](https://github.com/semuconsulting/PyGPSClient/blob/master/.github/ISSUE_TEMPLATE/bug_report.md), please use the template provided. For feature requests and general queries and advice, post a message to one of the [PyGPSClient Discussions](https://github.com/semuconsulting/PyGPSClient/discussions) channels in the first instance.
 
@@ -91,7 +91,8 @@ To install into a virtual environment (*which may be necessary if you have an [`
 python3 -m venv pygpsclient
 source pygpsclient/bin/activate # (or .\pygpsclient\Scripts\activate on Windows)
 python3 -m pip install --upgrade pygpsclient
-deactivate
+pygpsclient
+deactivate # to deactivate virtual environment when finished
 ```
 
 Quick [installation shell scripts](https://github.com/semuconsulting/PyGPSClient/blob/master/INSTALLATION.md#script) are available for Linux and MacOS platforms.
@@ -149,6 +150,7 @@ For more comprehensive installation instructions, please refer to [INSTALLATION.
     gnssstreamer --port /dev/ttyACM0 --baudrate 115200 --timeout 3 --format 2 --clioutput 1 --output pygpsdata.log --verbosity 2
     ```
 
+    Datalogs will include both receiver output and (_if the relevant protocol is enabled in settings_) any incoming NTRIP RTK data stream.
 18. GPX Track - Turn track recording (in GPX format) on or off. On first selection, you will be prompted to select the directory into which timestamped GPX track files are saved. See also [GPX Track Viewer](#gpxviewer).
 19. Database - Turn spatialite database recording (*where available*) on or off. On first selection, you will be prompted to select the directory into which the `pygpsclient.sqlite` database is saved. *Note that, when first created, the database's spatial metadata may take up to a minute or so to initialise*. 
     - Database logging is dependent on your Python environment supporting the requisite [sqlite3 `mod_spatialite` extension](https://www.gaia-gis.it/fossil/libspatialite/index) - see [INSTALLATION.md](https://github.com/semuconsulting/PyGPSClient/blob/master/INSTALLATION.md#prereqs) for further details. If not supported, the option will be greyed out. Check the Menu..Help..About dialog for an indication of the current spatialite support status - `no-ext` means the spatialite extension is not supported; `no-ms` means spatialite *is* supported but the necessary `mod_spatialite` extension module cannot be found in the PATH; a numeric version number like `3.51.2` indicates spatialite is fully supported.
@@ -508,17 +510,19 @@ The `pygnssutils` and `pyubxutils` libraries which underpin many of the function
 For further details, refer to the `pygnssutils` homepage at [https://github.com/semuconsulting/pygnssutils](https://github.com/semuconsulting/pygnssutils) or `pyubxutils` homepage at [https://github.com/semuconsulting/pyubxutils](https://github.com/semuconsulting/pyubxutils).
 
 ---
-## <a name="troubleshoot">Troubleshooting</a>
+## <a name="troubleshoot">Troubleshooting and Known Issues</a>
+
+1. There is a known issue with PyGPSClient GUI refreshes becoming progressively slower on certain platforms if the app is left unattended (_i.e. no user interaction_) for an extended period - typically 30 minutes or more. The issue is more pronounced on low-end SBC platforms like the Raspberry Pi. **Underlying processing (including message parsing and datalogging) is unaffected**, and the GUI can generally be 'woken up' within a few seconds via a simple user interaction e.g. resizing the main panel. The root cause of this issue is under investigation, but as a workaround, users can try a) increasing the `guiupdateinterval_f` setting in the json configuration file, or b) hiding some or all user-selectable widgets until needed.
 
-1. **NB:** The latest version of Python for MacOS (>=3.14.5) comes with a new version of tkinter (9.0). There appear to be fairly serious performance issues with this version on MacOS Tahoe which render the PyGPSClient UI somewhat sluggish. For the time being, it is recommended that users use >=3.14.4. This issue does *not* affect other operating systems or Python apps not using tkinter.
+2. **NB:** The latest version of Python for MacOS (>=3.14.5) comes with a new version of tkinter (9.0). There appear to be fairly serious performance issues with this version on MacOS Tahoe which render the PyGPSClient GUI somewhat sluggish. For the time being, it is recommended that users use >=3.14.4. This issue does *not* affect other operating systems or Python apps not using tkinter.
 
-2. If you encounter persistent `WARNING>>Error parsing data stream Serial stream terminated unexpectedly` messages in the console, this may be indicative of insufficient serial port bandwidth (baudrate or timeout) for the current output message cohort (*particularly if this includes Ephemera or Observation data*). Try increasing the baudrate in the first instance.
+3. If you encounter persistent `WARNING>>Error parsing data stream Serial stream terminated unexpectedly` messages in the console, this may be indicative of insufficient serial port bandwidth (baudrate or timeout) for the current output message cohort (*particularly if this includes raw Ephemerides or Observation data*). Try increasing the baudrate in the first instance.
 
-3. Most [budget USB-UART adapters](https://www.amazon.co.uk/DSD-TECH-adapter-FT232RL-Compatible/dp/B07BBPX8B8?ref_=ast_sto_dp) (e.g. FT232, CH345, CP2102, *including those embedded on development boards*) have a bandwidth limit of around 3Mbps (≈ 375000 baud) and may not work reliably above 230600 baud, even if the receiver supports higher baud rates. If you're using an adapter and notice significant message corruption (e.g. frequent `WARNING>>..invalid checksum` messages), try reducing the baud rate to a maximum 230600.
+4. Most [budget USB-UART adapters](https://www.amazon.co.uk/DSD-TECH-adapter-FT232RL-Compatible/dp/B07BBPX8B8?ref_=ast_sto_dp) (e.g. FT232, CH345, CP2102, *including those embedded on development boards*) have a bandwidth limit of around 3Mbps (≈ 375000 baud) and may not work reliably above 230600 baud, even if the receiver supports higher baud rates. If you're using an adapter and notice significant message corruption (e.g. frequent `WARNING>>..invalid checksum` messages), try reducing the baud rate to a maximum 230600.
 
-4. Some Linux Wayland platforms appear to require Toplevel dialog windows to be non-transient (`transient_dialog_b: 0`) for the window 'maximise' icon to work properly.
+5. Some Linux Wayland platforms appear to require Toplevel dialog windows to be non-transient (`transient_dialog_b: 0`) for the window 'maximise' icon to work properly.
 
-5. Some Homebrew-installed Python environments on MacOS can give rise to critical segmentation errors (*illegal memory access*)  when shell subprocesses are invoked, due to the way permissions are implemented. This may, for example, affect About..Update functionality; the workaround is to update via a standard CLI `pip install --upgrade` command.
+6. Some Homebrew-installed Python environments on MacOS can give rise to critical segmentation errors (*illegal memory access*)  when shell subprocesses are invoked, due to the way permissions are implemented. For this reason, application updates via the  About..Update button are disabled on Homebrew environments; use the CLI `python3 -m pip install --upgrade pygpsclient` command instead.
 
 ---
 ## <a name="license">License</a>

RELEASE_NOTES.md

@@ -1,5 +1,16 @@
 # PyGPSClient Release Notes
 
+### RELEASE 1.7.3
+
+FIXES:
+
+1. Enhancement for unattended UI lag issue.
+1. Remove redundant CLI arguments relating to disused SPARTN client.
+
+CHANGES:
+
+1. When datalogging is enabled, any incoming NTRIP RTK stream (RTCM3 or SPARTN) will _only_ be logged if its protocol is enabled in settings; otherwise logging will be restricted to receiver output.
+
 ### RELEASE 1.7.2
 
 FIXES:

pyproject.toml

@@ -52,7 +52,7 @@ classifiers = [
 dependencies = [
     "requests>=2.34.0",
     "Pillow>=12.0.0",
-    "pygnssutils>=1.2.6",
+    "pygnssutils>=1.2.7",
     "pyunigps>=1.0.0",
     "pynmeagps>=1.1.5",
     "pyubx2>=1.3.5",

src/pygpsclient/__main__.py

@@ -22,12 +22,7 @@
 
 from pygpsclient._version import __version__ as VERSION
 from pygpsclient.app import App
-from pygpsclient.globals import (
-    APPNAME,
-    CONFIGFILE,
-    SPARTN_BASEDATE_CURRENT,
-    SPARTN_BASEDATE_DATASTREAM,
-)
+from pygpsclient.globals import APPNAME, CONFIGFILE
 from pygpsclient.strings import EPILOG
 
 
@@ -52,32 +47,11 @@ def main():
         help="User-defined GNSS receiver port",
         default=SUPPRESS,
     )
-    ap.add_argument(
-        "-S",
-        "--spartnport",
-        help="User-defined SPARTN receiver port",
-        default=SUPPRESS,
-    )
     ap.add_argument(
         "--mqapikey",
         help="MapQuest API Key",
         default=SUPPRESS,
     )
-    ap.add_argument(
-        "--mqttclientid",
-        help="MQTT Client ID",
-        default=SUPPRESS,
-    )
-    ap.add_argument(
-        "--mqttclientregion",
-        help="MQTT Client Region",
-        default=SUPPRESS,
-    )
-    ap.add_argument(
-        "--mqttclientmode",
-        help="MQTT Client Mode (0 - IP, 1 - L-Band)",
-        default=SUPPRESS,
-    )
     ap.add_argument(
         "--ntripcasteruser",
         help="NTRIP Caster authentication user",
@@ -88,26 +62,14 @@ def main():
         help="NTRIP Caster authentication password",
         default=SUPPRESS,
     )
-    ap.add_argument(
-        "--spartnkey",
-        help="SPARTN message decryption key",
-        default=SUPPRESS,
-    )
-    ap.add_argument(
-        "--spartnbasedate",
-        help=f"SPARTN message decryption timetag ({SPARTN_BASEDATE_CURRENT} = \
-            current datetime, {SPARTN_BASEDATE_DATASTREAM} = use timetags from data stream)",
-        type=int,
-        default=SUPPRESS,
-    )
     ap.add_argument(
         "--tlspempath",
-        help="Fully qualified path to TLS PEM (private key/certificate) file",
+        help="Fully qualified path to TLS PEM (private key/certificate) file used by socket server",
         default=SUPPRESS,
     )
     ap.add_argument(
         "--tlscrtpath",
-        help="Fully qualified path to TLS CRT (certificate) file",
+        help="Fully qualified path to TLS CRT (certificate) file used by socket client",
         default=SUPPRESS,
     )
     ap.add_argument(

src/pygpsclient/_version.py

@@ -8,4 +8,4 @@
 :license: BSD 3-Clause
 """
 
-__version__ = "1.7.2"
+__version__ = "1.7.3"