add spatial check on startup

Author: semuadmin

README.md

@@ -106,7 +106,7 @@ Please refer to [INSTALLATION.md](https://github.com/semuconsulting/PyGPSClient/
 1. Show Unused Satellites - Include or exclude satellites that are not used in the navigation solution (e.g. because their signal level is too low) from the graph and sky view panels.
 1. DataLogging - Turn Data logging in the selected format on or off. On first selection, you will be prompted to select the directory into which timestamped log files are saved.
 1. 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.
-1. 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 will take a few seconds to initialise. **NB** This facility is dependent on your Python environment supporting the requisite sqlite3 `mod_spatialite` extension - see [INSTALLATION.md](https://github.com/semuconsulting/PyGPSClient/blob/master/INSTALLATION.md#prereqs) for further details.
+1. 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 will take a few seconds to initialise (*up to a minute on Raspberry Pi and similar SBC*). **NB** This facility 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.
 1. To save the current configuration to a file, go to File..Save Configuration.
 1. To load a saved configuration file, go to File..Load Configuration. The default configuration file location is `$HOME/pygpsclient.json`. **NB** Any active serial or RTK connection must be stopped before loading a new configuration.
 

examples/QGIS_sqlite_gpkg_illustration.png

@@ -1,8 +1,9 @@
 #!/bin/bash
 
 # bash shell script to compile and install libspatialite
-# (mod_spatialite.so) on platforms which do not include a suitable
-# binary in their standard repos (e.g. Raspberry Pi OS).
+# (mod_spatialite.so) on Debian Linux platforms which do not
+# include a suitable binary in their standard repos
+# (e.g. Raspberry Pi OS).
 #
 # Remember to run chmod +x libspatialite_compile.sh to make this script executable.
 #
@@ -14,20 +15,45 @@
 # exit on error
 set -e
 
-# install build dependencies (we'll omit the freexl dependency)
-sudo apt install libspatial-dev
+# install build dependencies if required and available (we'll omit the freexl dependency)
+sudo apt install libspatial-dev || true
+sudo apt install libproj-dev || true
+sudo apt install libgdal-dev || true
+sudo apt install libgeos-dev || true
 # download and unzip source code
 wget https://www.gaia-gis.it/gaia-sins/libspatialite-sources/libspatialite-5.1.0.tar.gz
 tar zxvf libspatialite-5.1.0.tar.gz
 cd libspatialite-5.1.0
 # compile source and install - this will take several minutes
+# aarch64-unknown-linux-gnu is appropriate for ARM-based SBC platforms like RPi
 ./configure --build=aarch64-unknown-linux-gnu --enable-freexl=no
 make
 sudo make install-strip
 
 # typically installs mod_spatialite.so to /usr/local/lib, which
 # must be added to the LD_LIBRARY_PATH environment variable:
 #
-export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
+export LD_LIBRARY_PATH=/usr/local/lib
 
 # make this permanent via your .bashrc or .zshrc shell profile
+echo "Adding directory to PATH..."
+BASHPROF1=$HOME/.profile
+BASHPROF2=$HOME/.bashrc
+ZSHPROF1=$HOME/.zprofile
+ZSHPROF2=$HOME/.zshrc
+if test -f $BASHPROF1
+then
+PROF=$BASHPROF1
+elif test -f $BASHPROF2
+then
+PROF=$BASHPROF2
+fi
+if test -f $ZSHPROF1
+then
+PROF=$ZSHPROF1
+elif test -f $ZSHPROF2
+then
+PROF=$ZSHPROF2
+fi
+sed -i '$a# Path to mod_spatialite.so\nexport LD_LIBRARY_PATH=/usr/local/lib' $PROF
+source $PROF # this will throw an error if running as bash script in zsh shell

examples/QGIS_sqlite_illustration.png

@@ -51,7 +51,7 @@ EOF
 
 echo "Adding directory to PATH..."
 BASHPROF1=$HOME/.profile
-BASHPROF2=$HOME/.bash_rc
+BASHPROF2=$HOME/.bashrc
 ZSHPROF1=$HOME/.zprofile
 ZSHPROF2=$HOME/.zshrc
 if test -f $BASHPROF1

examples/libspatialite_compile.sh

@@ -49,10 +49,10 @@ sudo apt install build-essential gdb lcov pkg-config \
       libbz2-dev libffi-dev libgdbm-dev libgdbm-compat-dev \
       libncurses5-dev libreadline6-dev libsqlite3-dev libssl-dev \
       lzma tk-dev uuid-dev zlib1g-dev -y
-sudo apt install liblzma-dev -y
+sudo apt install liblzma-dev || true
 # liblzma-dev may be lzma-dev on some platforms
-# sudo apt install lzma-dev -y
-sudo apt install libspatialite -y
+sudo apt install lzma-dev || true
+sudo apt install libspatialite || true
 # libspatialite may not be available as standard on some platforms
 # (e.g. Rasperry PI OS) but it is relatively straightforward to
 # compile from source using the libspatialite_compile.sh script

examples/pygpsclient_debian_install.sh

@@ -40,6 +40,7 @@
     "mapzoom_disabled_b": 0,
     "gpxmaptype_s": "custom",
     "gpxmapzoom_n": 10,
+    "gpxtype_s": "track",
     "showtrack_b": 0,
     "legend_b": 1,
     "unusedsat_b": 0,

examples/python_compile.sh

@@ -39,7 +39,6 @@
     SPONSOR_URL,
 )
 from pygpsclient.helpers import check_latest
-from pygpsclient.sqllite_handler import DBINMEM, SQLVER
 from pygpsclient.strings import ABOUTTXT, COPYRIGHTTXT, DLGTABOUT, GITHUB_URL
 from pygpsclient.toplevel_dialog import ToplevelDialog
 
@@ -100,10 +99,9 @@ def _body(self):
             borderwidth=0,
         )
         tkv = Tcl().call("info", "patchlevel")
-        spv = self.__app.sqlite_handler.open(dbname=DBINMEM)
         self._lbl_python_version = Label(
             self._frm_body,
-            text=f"Python: {python_version()}  Tk: {tkv}  Spatial: {spv}",
+            text=f"Python: {python_version()}  Tk: {tkv}  Spatial: {self.__app.db_enabled}",
         )
         self._lbl_lib_versions = []
         for nam, ver in LIBVERSIONS.items():

images/app.png

@@ -86,7 +86,7 @@
 from pygpsclient.nmea_handler import NMEAHandler
 from pygpsclient.rtcm3_handler import RTCM3Handler
 from pygpsclient.sbf_handler import SBFHandler
-from pygpsclient.sqllite_handler import SQLOK, SqliteHandler
+from pygpsclient.sqllite_handler import DBINMEM, SQLOK, SqliteHandler
 from pygpsclient.stream_handler import StreamHandler
 from pygpsclient.strings import (
     CONFIGERR,
@@ -179,10 +179,11 @@ def __init__(self, master, **kwargs):  # pylint: disable=too-many-statements
         self._last_gui_update = datetime.now()
         self._socket_thread = None
         self._socket_server = None
-        self.database_enabled = False
         self._colcount = 0
         self._rowcount = 0
         self._consoledata = []
+        # check if platform supports spatialite database
+        self.db_enabled = self.sqlite_handler.open(dbname=DBINMEM)
 
         # load config from json file
         configfile = kwargs.pop("config", CONFIGFILE)
@@ -221,7 +222,11 @@ def __init__(self, master, **kwargs):  # pylint: disable=too-many-statements
 
         # open database if database recording enabled
         dbpath = self.configuration.get("databasepath_s")
-        if self.configuration.get("database_b") and dbpath != "":
+        if (
+            self.db_enabled == SQLOK
+            and self.configuration.get("database_b")
+            and dbpath != ""
+        ):
             rc = self.sqlite_handler.open(dbpath=dbpath)
             self.configuration.set("database_b", rc == SQLOK)
 
@@ -417,7 +422,8 @@ def set_connection(self, message, color=OKCOL):
 
         """
 
-        self.frm_status.set_connection(message, color=color)
+        if hasattr(self, "frm_status"):
+            self.frm_status.set_connection(message, color=color)
 
     def set_status(self, message, color=OKCOL):
         """
@@ -428,9 +434,10 @@ def set_status(self, message, color=OKCOL):
 
         """
 
-        color = INFOCOL if color == "blue" else color
-        self.frm_status.set_status(message, color)
-        self.update_idletasks()
+        if hasattr(self, "frm_status"):
+            color = INFOCOL if color == "blue" else color
+            self.frm_status.set_status(message, color)
+            self.update_idletasks()
 
     def set_event(self, evt: str):
         """