pygpsclient

PyGPSClient is a multi-platform graphical GNSS/GPS testing, diagnostic, and configuration application. It is written in Python and uses the tkinter GUI framework.

Key Capabilities:

• Protocol Support: NMEA, UBX (u-blox binary), SBF (Septentrio binary), UNI (Unicore binary), QGC (Quectel binary), RTCM3, SPARTN, NTRIP, and TTY (ASCII text).
• Data Stream Sources: Serial (USB/UART), Socket (TCP/UDP), binary data streams (terminal or file capture), and binary recordings (e.g., u-center *.ubx files).
• NTRIP Services: Provides an NTRIP client for both RTCM3 and SPARTN services. It can also serve as an NTRIP base station using RTK-compatible receivers (e.g., u-blox ZED-F9P, Quectel LG/LC Series, Septentrio Mosaic Series, or Unicore UM9** Series).
• Device Configuration: Supports configuration via proprietary UBX, NMEA, and ASCII TTY protocols for most u-blox, Quectel, Septentrio, Unicore, and Feyman GNSS devices.
• Data Conversion: Experimental support for RINEX conversion of raw observation, navigation, and meteorology data.

The UBX, NMEA, and TTY Configuration Dialogs allow you to send custom configuration messages or sequences to a receiver. You can define these in your JSON configuration file under the "ubxpresets_l", "nmeapresets_l", or "ttypresets_l" sections.

Format Requirements

Avoid using embedded commas or semicolons in the free-format text description part of the line.

• UBX: <description>, [<message class>, <message id>, <payload as hexadecimal string>, <msgmode>, ...]
• NMEA: <description>; [<talker>; <message id>; <payload as comma-separated string>; <msgmode>; ...]
• TTY: <description>; [<tty command>; ...]

Key Features

• Confirmation Pop-ups: If the description contains the term CONFIRM, a confirmation box will appear before the command is sent.
• Resetting Presets: To restore the initial default set of commands, insert "INIT_PRESETS" at the top of the relevant configuration section.
• Recording: You can use the Configuration Command Load/Save/Record facility to record commands sent to a receiver and automatically import them into these sections.

The RINEX Conversion Dialog converts raw observation, navigation, and meteorology data from binary datalogs into RINEX format.

Pre-Requisites

A binary datalog containing raw observation (UBX RXM-RAWX), navigation (UBX RXM-SFRBX) and/or meteorology (NMEA) data or RTCM3 ephemerides (1019, 1020, 1041-1046) messages. It is recommended to use files with at least 15-30 minutes of continuous data.

Conversion Steps

1. Select the binary datalog file using the Folder icon.
2. Choose the RINEX protocol version (3.05 or 4.02).
3. Select the output file types: O (observation), N (navigation), or M (meteorology).
4. Select the datasource for each type (e.g., UBX, RTCM3, NMEA 0183).
5. (Optional) Filter by GNSS (GPS, GAL, BDS, etc.), Observation codes (1C, 2L, 5I, etc.), or SV codes (G11, E03, C23, etc.).
6. (Optional) Use the Advanced panel to add metadata for the marker, antenna, receiver, observer, or comments.
7. Click the Start icon to process. A progress bar will indicate status, and the output filenames (*.rnx) and record counts will be displayed upon completion.

For older u-blox GNSS receivers (Generation 8 or earlier), use the legacy UBX configuration panels.

Key Features:

• Protocol Configuration panel (CFG-PRT): Sets baud rate and inbound/outbound protocols across all ports.
• Solution Rate panel (CFG-RATE): Sets the navigation solution interval in ms (e.g., 1000 for 1/second) and the measurement ratio.
• Message Rate panel (CFG-MSG): Sets message rates per port for UBX and NMEA messages. The rate is relative to the navigation solution frequency (e.g., a rate of 4 means every 4th navigation solution).
• UBX Legacy Command configuration panel: Provides structured updates for legacy CFG-* commands. 'X' (byte) type attributes can be entered as integers or hexadecimal strings (e.g., 0x1f1f0000).
• Version Panel: Displays current hardware/firmware versions (double-left-click to refresh).

Tip: Clicking anywhere in the background of a panel refreshes the displayed information with the current configuration.

Before installing PyGPSClient, ensure your system meets the following requirements:

• Python Version: Python >= 3.10 (It is highly recommended to use the official installation package from Python.org rather than pre-installed system versions).
• GUI Library: Tk (tkinter) >= 8.6.
• Display: Screen resolution >= 640 x 480 (VGA). 1920 x 1080 is ideal.
• System: A Graphical User Interface (window system/manager) must be available.

Note on Spatialite: If you require the optional spatialite database recording facility, your Python environment must support loading sqlite3 extensions (compiled with --enable-loadable-sqlite-extensions). This is standard on Windows and Linux but often requires manual configuration on MacOS. You must also have the mod_spatialite module installed and available in your PATH (or LD_LIBRARY_PATH on Linux).