Skip to content

Commit d69f732

Browse files
committed
update readme
1 parent 8d48086 commit d69f732

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

.vscode/tasks.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@
164164
"problemMatcher": [],
165165
"dependsOrder": "sequence",
166166
"dependsOn": [
167-
"Create Venv",
167+
//"Create Venv",
168168
"Install Deploy Dependencies",
169169
"Install Optional Dependencies",
170170
"Clean",

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,8 @@ The NTRIP Configuration utility allows users to receive and process NTRIP RTK Co
277277

278278
**Instructions:**
279279

280-
1. Enter the required NTRIP server URL (or IP address) and port (defaults to 2101). For SSL/TLS (HTTPS) connections (*typically on ports \*443 or 2102*), tick the TLS checkbox. Tick the Self-Sign checkbox to tolerate self-signed TLS certification (*typically for test or demonstration services*). For services which require authorisation, enter your assigned login username and password.
280+
1. Enter the required NTRIP server URL (or IP address) and port (defaults to 2101). For SSL/TLS (HTTPS) connections (*typically on ports \*443 or 2102*), tick the TLS checkbox. Tick the Self-Sign checkbox to tolerate self-signed TLS certification (*typically for test or demonstration services*); the path to the self-sign TLS certificate can be set via environment variable `PYGNSSUTILS_CRTPATH`; the default is `$HOME\pygnssutils.crt`.
281+
1. For services which require authorisation, enter your assigned login username and password.
281282
1. Select the Data Type (defaults to RTCM, but can be set to SPARTN).
282283
1. To retrieve the sourcetable, leave the mountpoint field blank and click connect (*response may take a few seconds*). The required mountpoint may then be selected from the list, or entered manually. Where possible, `PyGPSClient` will automatically identify the closest mountpoint to the current location.
283284
1. For NTRIP services which require client position data via NMEA GGA sentences, select the appropriate sentence transmission interval in seconds. The default is 'None' (no GGA sentences sent). A value of 10 or 60 seconds is typical.
@@ -321,6 +322,7 @@ By default, the server/caster binds to the host address '0.0.0.0' (IPv4) or '::'
321322
```shell
322323
openssl req -x509 -newkey rsa:4096 -keyout pygnssutils.pem -out pygnssutils.pem -sha256 -days 3650 -nodes
323324
```
325+
The TLS Client will only require the certificate from this file, which can be set via environment variable `PYGNSSUTILS_CRTPATH`; the default is `$HOME\pygnssutils.crt`.
324326

325327
**Instructions:**
326328

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Welcome to PyGPSClient's documentation!
1010
:maxdepth: 2
1111
:caption: Contents:
1212

13+
modules.rst
1314

1415
Indices and tables
1516
==================

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ classifiers = [
4949
"Topic :: Scientific/Engineering :: GIS",
5050
]
5151

52-
dependencies = ["requests>=2.28.0", "Pillow>=9.0.0", "pygnssutils>=1.1.20"]
52+
dependencies = ["requests>=2.28.0", "Pillow>=9.0.0", "pygnssutils>=1.1.21"]
5353

5454
[project.scripts]
5555
pygpsclient = "pygpsclient.__main__:main"

0 commit comments

Comments
 (0)