add unicore support

Author: semuadmin

RELEASE_NOTES.md

@@ -1,5 +1,9 @@
 # PyGPSClient Release Notes
 
+### RELEASE 1.6.3
+
+1. Add support for Unicore UNI binary data output messages via `pyunigps>=0.1.2` and `pygnssutils>=1.1.22`.
+
 ### RELEASE 1.6.2
 
 1. Add support for Unicore Secondary Antenna and Attitude (IMU) NMEA sentences e.g. UM98n "GGAH", "HPD" (requires pynmeagps>=1.1.0).

pyproject.toml

@@ -49,7 +49,7 @@ classifiers = [
     "Topic :: Scientific/Engineering :: GIS",
 ]
 
-dependencies = ["requests>=2.28.0", "Pillow>=9.0.0", "pygnssutils>=1.1.21"]
+dependencies = ["requests>=2.28.0", "Pillow>=9.0.0", "pygnssutils>=1.1.22"]
 
 [project.scripts]
 pygpsclient = "pygpsclient.__main__:main"

src/pygpsclient/_version.py

@@ -8,4 +8,4 @@
 :license: BSD 3-Clause
 """
 
-__version__ = "1.6.2"
+__version__ = "1.6.3"

src/pygpsclient/app.py

@@ -48,13 +48,14 @@
 from types import NoneType
 
 from pygnssutils import GNSSMQTTClient, GNSSNTRIPClient, MQTTMessage
-from pygnssutils.gnssreader import (  # UNI_PROTOCOL, # TODO
+from pygnssutils.gnssreader import (
     NMEA_PROTOCOL,
     POLL,
     QGC_PROTOCOL,
     RTCM3_PROTOCOL,
     SBF_PROTOCOL,
     UBX_PROTOCOL,
+    UNI_PROTOCOL,
 )
 from pygnssutils.socket_server import ClientHandler, ClientHandlerTLS, SocketServer
 from pynmeagps import NMEAMessage
@@ -63,6 +64,7 @@
 from pysbf2 import SBFMessage
 from pyspartn import SPARTNMessage
 from pyubx2 import UBXMessage
+from pyunigps import UNIMessage
 from serial import SerialException, SerialTimeoutException
 
 from pygpsclient._version import __version__ as VERSION
@@ -97,7 +99,6 @@
     STATUSPRIORITY,
     TTY_PROTOCOL,
     UNDO,
-    UNI_PROTOCOL,
 )
 from pygpsclient.gnss_status import GNSSStatus
 from pygpsclient.helpers import (
@@ -913,8 +914,8 @@ def process_data(self, raw_data: bytes, parsed_data: object, marker: str = ""):
             msgprot = SBF_PROTOCOL
         elif isinstance(parsed_data, QGCMessage):
             msgprot = QGC_PROTOCOL
-        # elif isinstance(parsed_data, UNIMessage):
-        #     msgprot = UNI_PROTOCOL
+        elif isinstance(parsed_data, UNIMessage):
+            msgprot = UNI_PROTOCOL
         elif isinstance(parsed_data, UBXMessage):
             msgprot = UBX_PROTOCOL
         elif isinstance(parsed_data, RTCMMessage):

src/pygpsclient/globals.py

@@ -53,7 +53,6 @@
 PNTCOL = "#FF8000"  # default plot point color
 
 # Protocols to be used in protocol mask (others defined in pygnssutils.gnss_reader.py)
-UNI_PROTOCOL = 32  # provisional - awaiting pygnssutils.gnssreader updates for Unicore
 SPARTN_PROTOCOL = 256
 MQTT_PROTOCOL = 512
 TTY_PROTOCOL = 1024
@@ -251,8 +250,8 @@
 TOPIC_RXM = "/pp/ubx/0236/ip"
 TRACK = "track"
 TRACEMODE_WRITE = "write"
-TTYOK = ("OK", "$R:")
-TTYERR = ("ERROR", "$R?")
+TTYOK = ("OK", "$R:", "RESPONSE: OK")
+TTYERR = ("ERROR", "$R?", "RESPONSE: PARSING FAILD")
 TTYMARKER = "TTY<<"
 UBXPRESETS = "ubxpresets"
 UBXSIMULATOR = "ubxsimulator"

src/pygpsclient/helpers.py

@@ -59,6 +59,7 @@
     atttyp,
 )
 from pyubx2 import version as UBXVERSION
+from pyunigps import version as UNIVERSION
 from requests import get
 
 from pygpsclient._version import __version__ as VERSION
@@ -107,6 +108,7 @@
     "pygnssutils": PGVERSION,
     "pyubx2": UBXVERSION,
     "pysbf2": SBFVERSION,
+    "pyunigps": UNIVERSION,
     "pyqgc": QGCVERSION,
     "pynmeagps": NMEAVERSION,
     "pyrtcm": RTCMVERSION,

src/pygpsclient/settings_child_frame.py

@@ -456,11 +456,11 @@ def _do_layout(self):
         self._chk_nmea.grid(column=1, row=0, padx=0, pady=0, sticky=W)
         self._chk_ubx.grid(column=2, row=0, padx=0, pady=0, sticky=W)
         self._chk_rtcm.grid(column=3, row=0, padx=0, pady=0, sticky=W)
-        self._chk_sbf.grid(column=1, row=1, padx=0, pady=0, sticky=W)
-        self._chk_qgc.grid(column=2, row=1, padx=0, pady=0, sticky=W)
-        self._chk_spartn.grid(column=3, row=1, padx=0, pady=0, sticky=W)
-        self._chk_tty.grid(column=1, row=2, padx=0, pady=0, sticky=W)
-        # self._chk_unicore.grid(column=2, row=2, padx=0, pady=0, sticky=W) # TODO
+        self._chk_unicore.grid(column=1, row=1, padx=0, pady=0, sticky=W)
+        self._chk_sbf.grid(column=2, row=1, padx=0, pady=0, sticky=W)
+        self._chk_qgc.grid(column=3, row=1, padx=0, pady=0, sticky=W)
+        self._chk_spartn.grid(column=1, row=2, padx=0, pady=0, sticky=W)
+        self._chk_tty.grid(column=2, row=2, padx=0, pady=0, sticky=W)
         self._lbl_consoledisplay.grid(column=0, row=3, padx=2, pady=2, sticky=W)
         self._spn_conformat.grid(
             column=1, row=3, columnspan=2, padx=1, pady=2, sticky=W
@@ -536,6 +536,7 @@ def reset(self):
         self._prot_ubx.set(cfg.get("ubxprot_b"))
         self._prot_sbf.set(cfg.get("sbfprot_b"))
         self._prot_qgc.set(cfg.get("qgcprot_b"))
+        self._prot_unicore.set(cfg.get("uniprot_b"))
         self._prot_rtcm.set(cfg.get("rtcmprot_b"))
         self._prot_spartn.set(cfg.get("spartnprot_b"))
         self._prot_tty.set(cfg.get("ttyprot_b"))
@@ -588,7 +589,7 @@ def _on_update_qgcprot(self, var, index, mode):
 
     def _on_update_uniprot(self, var, index, mode):
         """
-        Action on updating unicoreprot.
+        Action on updating uniprot.
         """
 
         if not self._prot_tty.get():

src/pygpsclient/stream_handler.py

@@ -47,12 +47,13 @@ class to read and parse incoming data from the receiver. It places
 from tkinter import Frame, Label, Tk
 
 from certifi import where as findcacerts
-from pygnssutils import (  # UNI_PROTOCOL # TODO
+from pygnssutils import (
     NMEA_PROTOCOL,
     QGC_PROTOCOL,
     RTCM3_PROTOCOL,
     SBF_PROTOCOL,
     UBX_PROTOCOL,
+    UNI_PROTOCOL,
     GNSSError,
     GNSSReader,
 )
@@ -322,8 +323,8 @@ def _errorhandler(err: Exception):
             | UBX_PROTOCOL
             | SBF_PROTOCOL
             | QGC_PROTOCOL
-            | RTCM3_PROTOCOL,
-            # | UNI_PROTOCOL,  # TODO
+            | RTCM3_PROTOCOL
+            | UNI_PROTOCOL,
             quitonerror=ERR_LOG,
             bufsize=DEFAULT_BUFSIZE,
             msgmode=settings["msgmode"],