Skip to content

Commit 96f902b

Browse files
committed
docs: Update PGPS docs
The nRF Cloud REST API only supports 1 week of predictions now. Remove NRF_CLOUD_PGPS_PREDICTION_PERIOD choice because 240 is the only valid value in nRF Cloud. Update max value for NRF_CLOUD_PGPS_NUM_PREDICTIONS and NRF_CLOUD_PGPS_REPLACEMENT_THRESHOLD according to what is supported by nRF Cloud. Add changelog entry for nrf_cloud_pgps library changes. Signed-off-by: Gregers Gram Rygg <[email protected]>
1 parent 68440e9 commit 96f902b

File tree

6 files changed

+12
-40
lines changed

6 files changed

+12
-40
lines changed

doc/nrf/app_dev/device_guides/nrf91/nrf91_features.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,12 +315,12 @@ See :ref:`nrfxlib:gnss_int_agps_data` for more information about the retrieval o
315315
Predicted GPS (P-GPS)
316316
---------------------
317317

318-
P-GPS is a form of assistance, where the device can download up to two weeks of predicted satellite ephemerides data.
318+
P-GPS is a form of assistance, where the device can download predicted satellite ephemerides data for several days into the future.
319319
Normally, devices connect to the cellular network approximately every two hours for up-to-date satellite ephemeris information or they download the ephemeris data from the acquired satellites.
320320
P-GPS enables devices to determine the exact orbital location of the satellite without connecting to the network every two hours with a trade-off of reduced accuracy of the calculated position over time.
321321
Note that P-GPS requires more memory compared to regular A-GNSS.
322322

323-
Also, note that due to satellite clock inaccuracies, not all functional satellites will have ephemerides data valid for two weeks in the downloaded P-GPS package.
323+
Also, note that due to satellite clock inaccuracies, not all functional satellites will have ephemerides data valid when nearing the end of the prediction period in the downloaded P-GPS package.
324324
This means that the number of satellites having valid predicted ephemerides reduces in number roughly after ten days.
325325
Hence, the GNSS module needs to download the ephemeris data from the satellite broadcast if no predicted ephemeris is found for that satellite to be able to use the satellite.
326326

doc/nrf/glossary.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -751,7 +751,7 @@ Glossary
751751
The process of securely generating and storing credentials in a device, then uploading a device ID and device certificate to a cloud account so that the device is ready to connect to the cloud.
752752

753753
Predicted GPS (P-GPS)
754-
A form of assistance provided to devices trying to obtain a :term:`Global Navigation Satellite System (GNSS)` fix, where the device can download up to two weeks of predicted satellite Ephemerides data.
754+
A form of assistance provided to devices trying to obtain a :term:`Global Navigation Satellite System (GNSS)` fix, where the device can download predicted satellite Ephemerides data for several days into the future.
755755
It enables devices to determine the exact orbital location of the satellite without connecting to the network every two hours with a trade-off of reduced accuracy of the calculated position over time.
756756
It is available through :term:`nRF Cloud`.
757757

doc/nrf/libraries/networking/nrf_cloud_pgps.rst

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,15 @@ To get a position fix, a :term:`Global Navigation Satellite System (GNSS)` modul
1818

1919
Predicted GPS (P-GPS) is a form of assistance that reduces the :term:`Time to First Fix (TTFF)`, the time needed by a GNSS module to estimate its position.
2020
It is provided through :term:`nRF Cloud` services.
21-
In P-GPS, nRF Cloud provides data containing information about the estimated orbits (`Ephemerides <Ephemeris_>`_) of the 32 GPS satellites for up to two weeks.
21+
In P-GPS, nRF Cloud provides data containing information about the estimated orbits (`Ephemerides <Ephemeris_>`_) of the 32 GPS satellites for multiple days into the future.
2222
Each set of ephemerides predictions is valid for a specific four-hour period within the set of all provided predictions.
2323
A device using P-GPS downloads the ephemeris predictions from the cloud, stores them in its flash memory, and later injects them into the GNSS module when needed.
2424

2525
P-GPS is designed for devices that are frequently disconnected from the cloud but need periodic GNSS fixes as quickly as possible to save power.
2626
This is possible because a device does not need to download ephemerides from the satellite broadcast.
2727
However, P-GPS should not be used for general use cases that already work with :term:`Assisted GNSS (A-GNSS)` only.
2828

29-
.. note::
30-
When using two-week ephemeris prediction sets, the TTFF towards the end of the second week increases due to the accumulated errors in the predictions and the decreases in the number of satellite ephemerides in the later prediction periods.
31-
32-
P-GPS requires a cloud connection approximately once a week to download new predictions, depending on the configuration settings.
29+
P-GPS requires a cloud connection to download new predictions.
3330
With A-GNSS, new ephemerides are needed on average every two hours, or if the fix interval is longer, whenever GNSS is started.
3431

3532
.. note::
@@ -52,7 +49,6 @@ Configure one of the following options to control the network transport for down
5249

5350
Configure these additional options to refine the behavior of P-GPS:
5451

55-
* :kconfig:option:`CONFIG_NRF_CLOUD_PGPS_PREDICTION_PERIOD`
5652
* :kconfig:option:`CONFIG_NRF_CLOUD_PGPS_NUM_PREDICTIONS`
5753
* :kconfig:option:`CONFIG_NRF_CLOUD_PGPS_REPLACEMENT_THRESHOLD`
5854
* :kconfig:option:`CONFIG_NRF_CLOUD_PGPS_DOWNLOAD_FRAGMENT_SIZE`

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,10 @@ Multiprotocol Service Layer libraries
454454
Libraries for networking
455455
------------------------
456456

457-
|no_changes_yet_note|
457+
* :ref:`lib_nrf_cloud_pgps` library:
458+
459+
* Updated the range for the :kconfig:option:`CONFIG_NRF_CLOUD_PGPS_NUM_PREDICTIONS` and :kconfig:option:`CONFIG_NRF_CLOUD_PGPS_REPLACEMENT_THRESHOLD` Kconfig options to values supported by nRF Cloud.
460+
* Removed the ``CONFIG_NRF_CLOUD_PGPS_PREDICTION_PERIOD`` Kconfig choice and related options (``CONFIG_NRF_CLOUD_PGPS_PREDICTION_PERIOD_120_MIN`` and ``CONFIG_NRF_CLOUD_PGPS_PREDICTION_PERIOD_240_MIN``).
458461

459462
Libraries for NFC
460463
-----------------

subsys/net/lib/nrf_cloud/Kconfig.nrf_cloud_pgps

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -25,32 +25,9 @@ config NRF_CLOUD_PGPS_REQUEST_UPON_INIT
2525
if only some of the predictions are in storage,
2626
or if the replacement threshold is reached.
2727

28-
choice NRF_CLOUD_PGPS_PREDICTION_PERIOD
29-
prompt "Desired time between predictions"
30-
default NRF_CLOUD_PGPS_PREDICTION_PERIOD_240_MIN
31-
help
32-
This value is used when requesting predicted GPS data from the
33-
cloud. More frequent predictions will result in more accurate
34-
ephemeris values for any given time, but will take more storage
35-
space in flash.
36-
37-
config NRF_CLOUD_PGPS_PREDICTION_PERIOD_120_MIN
38-
bool "120 min prediction period"
39-
help
40-
Each prediction is used to cover 120 minutes. May increase fix
41-
accuracy compared to 240 minute prediction period, but doubles
42-
the amount of data transferred and storage space needed in flash.
43-
44-
config NRF_CLOUD_PGPS_PREDICTION_PERIOD_240_MIN
45-
bool "240 min prediction period"
46-
help
47-
Each prediction is used to cover 240 minutes.
48-
49-
endchoice
50-
5128
config NRF_CLOUD_PGPS_NUM_PREDICTIONS
5229
int "Desired number of predictions"
53-
range 2 84
30+
range 2 42
5431
default 42
5532
help
5633
This value, together with the prediction period, determines the
@@ -60,7 +37,7 @@ config NRF_CLOUD_PGPS_NUM_PREDICTIONS
6037

6138
config NRF_CLOUD_PGPS_REPLACEMENT_THRESHOLD
6239
int "Number of predictions remaining before fetching more"
63-
range 0 82
40+
range 0 40
6441
default 0
6542
help
6643
When set to 0, no attempt will be made to update the prediction
@@ -175,7 +152,7 @@ config NRF_CLOUD_PGPS_PARTITION_SIZE
175152
hex "Size of flash partition for P-GPS data storage"
176153
default 0x15000
177154
help
178-
This must be at least 2048 bytes times NRF_COUND_PGPS_NUM_PREDICTIONS.
155+
This must be at least 2048 bytes times NRF_CLOUD_PGPS_NUM_PREDICTIONS.
179156

180157
config NRF_CLOUD_PGPS_PARTITION_ALIGN
181158
hex "Align P-GPS partition to flash block boundary"

subsys/net/lib/nrf_cloud/common/src/nrf_cloud_pgps.c

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,7 @@ LOG_MODULE_REGISTER(nrf_cloud_pgps, CONFIG_NRF_CLOUD_GPS_LOG_LEVEL);
3535
#define DOWNLOAD_PROTOCOL "https://"
3636
#define PGPS_DEBUG 0 /* set to 1 for extra logging */
3737

38-
#if defined(CONFIG_NRF_CLOUD_PGPS_PREDICTION_PERIOD_120_MIN)
39-
#define PREDICTION_PERIOD 120
40-
#else
4138
#define PREDICTION_PERIOD 240
42-
#endif
4339
#define REPLACEMENT_THRESHOLD CONFIG_NRF_CLOUD_PGPS_REPLACEMENT_THRESHOLD
4440
#define FRAGMENT_SIZE CONFIG_NRF_CLOUD_PGPS_DOWNLOAD_FRAGMENT_SIZE
4541
#define PREDICTION_MIDPOINT_SHIFT_SEC (120 * SEC_PER_MIN)

0 commit comments

Comments
 (0)