update NMEA PAIR response handling

Author: semuadmin

README.md

@@ -236,9 +236,11 @@ warning ![warning icon](https://github.com/semuconsulting/PyGPSClient/blob/maste
 **Pre-Requisites:**
 
 - Receiver capable of being configured via proprietary NMEA sentences, connected to the workstation via USB or UART port.
-- The facility includes support for a wide range of Quectel LG and LC series receivers via PQTM*, PSTM* and PAIR* sentences¹. Additional types may be supported in the underlying NMEA parser library [pynmeagps](https://github.com/semuconsulting/pynmeagps) in later releases (*contributions welcome*).
+- The facility includes support for a wide range of Quectel LG and LC series receivers via `PQTM*`, `PSTM*` and `PAIR*` sentences¹ ². Additional types may be supported in the underlying NMEA parser library [pynmeagps](https://github.com/semuconsulting/pynmeagps) in later releases (*contributions welcome*).
 
-¹ Note that Quectel message support depends on the *specific model variant* and firmware version, and several models (e.g. LG290 and LC29) exist in a wide range of variants. Refer to the GNSS Protocol Guide for your *specific* variant.
+¹ Note that Quectel receivers implement a bewildering array of different configuration protocols (based on a mixture of proprietary `PQTM*`, `PSTM*` and `PAIR*` NMEA message types). Support depends on the *specific model variant and firmware version*, and several models (e.g. LG290 and LC29) exist in a wide range of variants. Refer to the GNSS Protocol Guide for your *specific* variant.
+
+² Note that several Quectel configuration commands require a Hot Restart (PQTMHOT) *or* Save (PQTMSAVEPAR or PAIR513) and Reset (PQTMSRR) before taking effect, including for example PQTMCFGCNST (Enable/Disable Constellations), PQTMCFGFIX (Configure Fix Rate), PQTMCFGSAT (Configure Satellite Masks), PQTMCFGSIGNAL (Configure Signal Masks), PAIR050 (Set Fix Rate) and PAIR864 (Set Baud Rate). Devices (e.g. some LC variants) that don't implement a software reset command may have to be physically disconnected and reconnected.
 
 **Instructions:**
 
@@ -253,8 +255,6 @@ An icon to the right of each 'SEND'
 confirmed ![confirmed icon](https://github.com/semuconsulting/PyGPSClient/blob/master/src/pygpsclient/resources/iconmonstr-check-mark-8-24.png?raw=true) or 
 warning ![warning icon](https://github.com/semuconsulting/PyGPSClient/blob/master/src/pygpsclient/resources/iconmonstr-warning-1-24.png?raw=true)).
 
-**NB:** Several Quectel LG and LC series commands require a Hot Restart (PQTMHOT) before taking effect, including PQTMCFGCNST (Enable/Disable Constellations), PQTMCFGFIX (Configure Fix Rate), PQTMCFGSAT (Configure Satellite Masks) and PQTMCFGSIGNAL (Configure Signal Masks). This is a Quectel protocol constraint, not a PyGPSClient issue.
-
 ---
 ## <a name="ttycommands">TTY Configuration Facilities</a>
 
@@ -490,7 +490,7 @@ For further details, refer to the `pygnssutils` homepage at [https://github.com/
 
 1. 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.
 
-2. Most budget USB-UART adapters (e.g. FT232, CH345, CP2102) have a bandwidth limit of around 3MB/s and may not work reliably above 115200 baud, even if the receiver supports higher baud rates. If you're using an adapter and notice significant message corruption, try reducing the baud rate to a maximum 115200.
+2. Most budget USB-UART adapters (e.g. FT232, CH345, CP2102, *including those embedded on development boards*) have a bandwidth limit of around 3MB/s (≈ 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.
 
 3. 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.
 

RELEASE_NOTES.md

@@ -4,6 +4,7 @@
 
 1. Add preset description entry field to Configuration Command Recorder import facility.
 1. Make TTY Presets dialog fully resizeable.
+1. Update NMEA config panel to recognise correct PAIR responses for some Quectel set and poll commands (e.g. a PAIR864 Set baud rate command corresponds to a PAIR865 poll response).
 
 ### RELEASE 1.6.4
 

src/pygpsclient/dynamic_config_frame.py

@@ -98,6 +98,8 @@
 )
 # alternative POLL dictionary names for where POLL command
 # doesn't correspond to SET (fudge for Quectel)
+# e.g. a PAIR864 (set baud rate) command corresponds to PAIR865 (poll baud rate)
+# (for PAIR commands, the poll is typically one digit higher than the set)
 ALT_POLL_NAMES = {
     "AIR050": "AIR051",
     "AIR058": "AIR059",
@@ -111,8 +113,8 @@
     "AIR100": "AIR101",
     "AIR104": "AIR105",
     "AIR400": "AIR401",
-    "AIR410": "AIR421",
-    "AIR420": "AIR411",
+    "AIR410": "AIR411",
+    "AIR420": "AIR421",
     "AIR432": "AIR433",
     "AIR434": "AIR435",
     "AIR436": "AIR437",
@@ -406,7 +408,7 @@ def _do_poll_cfg(self, *args, **kwargs):  # pylint: disable=unused-argument
             return
 
         msg = penddlg = pendcfg = None
-        # use alternate names for some NMEA PAIR/PQTM POLL commands
+        # use alternate name for some NMEA PAIR/PQTM POLL commands
         cfg_id = ALT_POLL_NAMES.get(self._cfg_id, self._cfg_id)
         # set any POLL arguments to specified or default values
         # e.g. portid = "1", msgname="RMC"
@@ -477,23 +479,26 @@ def _do_poll_args(self, cfg_id: str) -> dict:
             pass
         return args
 
-    def update_status(self, msg: object):
+    def update_status(self, msg: NMEAMessage | UBXMessage):
         """
         UBXHandler or NMEAHandler module has received expected command response
         and forwarded it to this module, entry widgets are pre-populated with
         current configuration values and confirmation status is updated.
 
-        :param object msg: UBXMessage or NMEAMessage response
+        :param NMEAMessage | UBXMessage msg: UBXMessage or NMEAMessage response
         """
 
+        # self.logger.debug(f"{msg.identity=}")
         ok = False
         # strip off any variant suffix from cfg_id
         # e.g. "QTMCFGUART_CURR" -> "PQTMCFGUART"
-        cfg_id = (
-            "P" + self._cfg_id.rsplit("_", 1)[0]
-            if self._protocol == NMEA
-            else self._cfg_id
-        )
+        if self._protocol == NMEA:
+            cfg_id = self._cfg_id.rsplit("_", 1)[0]
+            # use alternate name for some NMEA PAIR/PQTM POLL commands
+            # e.g. a PAIR864 (set baud rate) command corresponds to PAIR865 (poll baud rate)
+            cfg_id = "P" + ALT_POLL_NAMES.get(cfg_id, cfg_id)
+        else:
+            cfg_id = self._cfg_id
 
         # if this message identity matches an expected response
         if msg.identity in (cfg_id, ACK, NAK):

src/pygpsclient/nmea_config_dialog.py

@@ -154,6 +154,7 @@ def update_pending(self, msg: NMEAMessage):
         :param NMEAMessage msg: NMEA config message
         """
 
+        # self.logger.debug(f"{msg.identity=}")
         nmeafrm = self._pending_confs.get(msg.identity, None)
 
         if nmeafrm is not None:

src/pygpsclient/nmea_handler.py

@@ -128,6 +128,8 @@ def process_data(self, raw_data: bytes, parsed_data: NMEAMessage):
                 self._process_FMI(parsed_data)
             elif parsed_data.msgID[0:3] == "QTM" and hasattr(parsed_data, "status"):
                 self._process_QTMACK(parsed_data)
+            elif parsed_data.msgID[0:3] == "AIR":
+                self._process_AIR(parsed_data)
         except ValueError:
             pass
 
@@ -518,3 +520,18 @@ def _process_IMU(self, data: NMEAMessage):
             ims["status"] = str(getattr(data, "quality", ""))
         except (TypeError, KeyError, AttributeError):
             pass
+
+    def _process_AIR(self, data: NMEAMessage):
+        """
+        Process PAIR sentences.
+
+        Quectel LC* series configuration or poll message.
+
+        :param NMEAMessage data: PAIR* message
+        """
+
+        try:
+            if self.__app.dialog(DLGTNMEA) is not None:
+                self.__app.dialog(DLGTNMEA).update_pending(data)
+        except (TypeError, KeyError, AttributeError):
+            pass

src/pygpsclient/ubx_handler.py

@@ -413,8 +413,6 @@ def _process_NAV_SIG(self, data: UBXMessage):
                 now,
             )
 
-        # print(f"DEBUG {self.__app.gnss_status.sig_data=}")
-
     def _process_NAV_STATUS(self, data: UBXMessage):
         """
         Process NAV-STATUS sentences - Status Information.