|
7 | 7 | [UBX Configuration](#ubxconfig) | |
8 | 8 | [NMEA Configuration](#nmeaconfig) | |
9 | 9 | [TTY Commands](#ttycommands) | |
| 10 | +[Load/Save/Record Commands](#recorder) | |
10 | 11 | [NTRIP Client](#ntripconfig) | |
11 | 12 | [SPARTN Client](#spartnconfig) | |
12 | 13 | [Socket Server / NTRIP Caster](#socketserver) | |
@@ -49,6 +50,7 @@ This is an independent project and we have no affiliation whatsoever with any GN |
49 | 50 |  |
50 | 51 |  |
51 | 52 |  |
| 53 | +[](https://github.com/semuconsulting/pygpsclient/actions/workflows/deploy.yml) |
52 | 54 |  |
53 | 55 |  |
54 | 56 |  |
@@ -118,7 +120,7 @@ For more comprehensive installation instructions, please refer to [INSTALLATION. |
118 | 120 | 1. File Delay - Select delay in milliseconds between individual reads when streaming from binary file (default 20 milliseconds). |
119 | 121 | 1. Tags - Enable color tags in console (see Console Widget below). |
120 | 122 | 1. Position Format and Units - Change the displayed position (D.DD / D.M.S / D.M.MM / ECEF) and unit (metric/imperial) formats. |
121 | | -1. Include C/N0 = 0 - Include or exclude satellites where carrier to noise ratio (C/N0) = 0. |
| 123 | +1. Include C/No = 0 - Include or exclude satellites where carrier to noise ratio (C/No) = 0. |
122 | 124 | 1. DataLogging - Turn Data logging in the selected format (Binary, Parsed, Hex Tabular, Hex String, Parsed+Hex Tabular) on or off. On first selection, you will be prompted to select the directory into which timestamped log files are saved. Log files are cycled when a maximum size is reached (default is 10 MB, manually configurable via `logsize_n` setting). |
123 | 125 | 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. |
124 | 126 | 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. |
@@ -160,7 +162,7 @@ For more comprehensive installation instructions, please refer to [INSTALLATION. |
160 | 162 | || Expandable banner showing key navigation status information based on messages received from receiver. To expand or collapse the banner or serial port configuration widgets, click the / buttons. **NB**: some fields (e.g. hdop/vdop, hacc/vacc) are only available from proprietary NMEA or UBX messages and may not be output by default. The minimum messages required to populate all available fields are: NMEA: GGA, GSA, GSV, RMC, UBX00 (proprietary); UBX: NAV-DOP, NAV-PVT, NAV-SAT | |
161 | 163 | || Configurable serial console widget showing incoming GNSS data streams in either parsed, binary or tabular hexadecimal formats. Double-right-click to copy contents of console to the clipboard. The scroll behaviour and number of lines retained in the console can be configured via the settings panel. Supports user-configurable color tagging of selected strings for easy identification. Color tags are loaded from the `"colortag_b":` value (`0` = disable, `1` = enable) and `"colortags_l":` list (`[string, color]` pairs) in your json configuration file (see example provided). If color is set to "HALT", streaming will halt on any match and a warning displayed. NB: color tagging does impose a small performance overhead - turning it off will improve console response times at very high transaction rates.| |
162 | 164 | || Skyview widget showing current satellite visibility and position (elevation / azimuth). Satellite icon borders are colour-coded to distinguish between different GNSS constellations. For consistency between NMEA and UBX data sources, will display GLONASS NMEA SVID (65-96) rather than slot (1-24). | |
163 | | -|| Levels view widget showing current satellite carrier-to-noise (CNo) levels for each GNSS constellation. Double-click to toggle legend. | |
| 165 | +|| Levels view widget showing current satellite carrier-to-noise (C/No) levels for each GNSS constellation. Double-click to toggle legend. | |
164 | 166 | || Map widget with various modes of display - select from "map" / "sat" (online) or "world" / "custom" (offline). Select zoom level 1 - 20. Double-click the zoom level label to reset the zoom to 10. Double-right-click the zoom label to maximise zoom to 20. Tick Track to show track (track will only be recorded while this box is checked). Double-Right-click will clear the map. Map Type = 'world': a static offline Mercator world map showing current global location. |
165 | 167 | || Map Type = 'map', 'sat' or 'hyb' (hybrid): Dynamic, online web map or satellite image via MapQuest API (*requires an Internet connection and free [Mapquest API Key](#mapquestapi)*). By default, the web map will automatically refresh every 60 seconds (*indicated by a small timer icon at the top left*). The default refresh rate can be amended by changing the `"mapupdateinterval_n":` value in your json configuration file, but **NB** the facility is not intended to be used for real-time navigation. Double-click anywhere in the map to immediately refresh. | |
166 | 168 | || Map Type = 'custom': One or more user-defined offline geo-referenced map images can be imported using the Menu..Options..Import Custom Map facility, or by manually setting the `usermaps_l` field in the json configuration file. The `usermaps_l` setting represents a list of map paths and extents in the format ["path to map image", [minlat, minlon, maxlat, maxlon]] - see [example configuration file](https://github.com/semuconsulting/PyGPSClient/blob/master/pygpsclient.json#L281). Map images must be a [supported format](https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html) and use a standard WGS84 Web Mercator projection e.g. EPSG:4326. PyGPSClient will automatically select the first map whose extents encompass the current location, based on the order in which the maps appear in `usermaps_l`. NB: The minimum and maximum viable 'zoom' levels depend on the resolution and extents of the imported image and the user's display - if the zoom bounds exceed the image extents, the Zoom spinbox will be highlighted. Offline and online zoom levels will not necessarily correspond. | |
@@ -193,7 +195,6 @@ For more comprehensive installation instructions, please refer to [INSTALLATION. |
193 | 195 | The UBX Configuration Dialog currently provides the following UBX configuration panels: |
194 | 196 |
|
195 | 197 | 1. Version panel shows current device hardware/firmware versions (*via MON-VER and MON-HW polls*). |
196 | | -1. CFG Configuration Load/Save/Record facility. This allows users to record  a sequence of UBX CFG configuration commands, and to save  this recording to a file (as binary CFG-* messages). Saved files can be reloaded  and the configuration commands replayed . This provides a means to easily reproduce a given sequence of configuration commands, or copy a saved configuration between compatible devices. The Configuration Load/Save/Record facility can accept configuration files in either binary UBX format (\*.ubx) or u-center text format (\*.txt). Files saved using the [ubxsave](#ubxsave) CLI utility (*installed via the `pygnssutils` library*) can also be reloaded and replayed. **Tip:** The contents of a binary config file can be reviewed using PyGPSClient's [file streaming facility](#filestream), *BUT* remember to set the `Msg Mode` in the Settings panel to `SET` rather than the default `GET` . |
197 | 198 | 1. Protocol Configuration panel (CFG-PRT) sets baud rate and inbound/outbound protocols across all available ports (*legacy protocols only*). |
198 | 199 | 1. Solution Rate panel (CFG-RATE) sets navigation solution interval in ms (e.g. 1000 = 1/second) and measurement ratio (ratio between the number of measurements and the number of navigation solutions, e.g. 5 = five measurements per navigation solution) (*legacy protocols only*). |
199 | 200 | 1. For each of the panels above, clicking anywhere in the panel background will refresh the displayed information with the current configuration. |
@@ -251,6 +252,13 @@ The following example illustrates a series of ASCII configuration commands being |
251 | 252 |
|
252 | 253 |  |
253 | 254 |
|
| 255 | +--- |
| 256 | +## <a name="recorder">Configuration Command Load/Save/Record Facility</a> |
| 257 | + |
| 258 | + |
| 259 | + |
| 260 | +This allows users to record  a sequence of UBX, NMEA or TTY configuration commands as they are sent to a device, and to save  this recording to a file. Saved files can be reloaded  and the configuration commands replayed . This provides a means to easily reproduce a given sequence of configuration commands, or copy a saved configuration between compatible devices. The Configuration Load facility can accept configuration files in either UBX/NMEA binary (\*.bin), TTY (\*.tty) or u-center UBX text format (\*.txt). Files saved using the [ubxsave](#ubxsave) CLI utility (*installed via the `pygnssutils` library*) can also be reloaded and replayed. **Tip:** The contents of a binary (\*.bin) config file can be reviewed using PyGPSClient's [file streaming facility](#filestream), *BUT* remember to set the `Msg Mode` in the Settings panel to `SET` rather than the default `GET` . |
| 261 | + |
254 | 262 | --- |
255 | 263 | ## <a name="ntripconfig">NTRIP Client Facilities</a> |
256 | 264 |
|
@@ -319,7 +327,7 @@ By default, the server/caster binds to the host address '0.0.0.0' (IPv4) or '::' |
319 | 327 | **SOCKET SERVER MODE** |
320 | 328 |
|
321 | 329 | 1. Select SOCKET SERVER mode and (if necessary) enter the host IP address and port. |
322 | | -1. Select 'TLS' to enable an encrypted TLS (HTTPS) connection. |
| 330 | +1. Select 'TLS' to enable an encrypted TLS connection. |
323 | 331 | 1. Check the Socket Server/NTRIP Caster checkbox to activate the server. |
324 | 332 | 1. To stop the server, uncheck the checkbox. |
325 | 333 |
|
|
0 commit comments