Skip to content

Commit 8da4d8b

Browse files
tokangasrlubos
authored andcommitted
lib: location: Update documentation
Added a limitation in the library documentation. GNSS API should not be used directly by the application when Location library is used. Doing so may lead to unexpected behavior, because GNSS may be in a different state than expected by the library. Signed-off-by: Tommi Kangas <[email protected]>
1 parent 9a923e2 commit 8da4d8b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

doc/nrf/libraries/modem/location.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The supported location methods are as follows:
3232

3333
* GNSS positioning
3434

35-
* Uses :ref:`gnss_interface` for getting the location.
35+
* Uses :ref:`GNSS interface<gnss_interface>` for getting the location.
3636
* A-GNSS and P-GPS are managed with :ref:`lib_nrf_cloud_agnss` and :ref:`lib_nrf_cloud_pgps`.
3737
* The application may also use some other source for the data and use :c:func:`location_agnss_data_process` and :c:func:`location_pgps_data_process` to pass the data to the Location library.
3838
* The data format of A-GNSS or P-GPS must be as received from :ref:`lib_nrf_cloud_agnss`.
@@ -379,7 +379,10 @@ The following |NCS| applications and samples use this library:
379379
Limitations
380380
***********
381381

382-
* The Location library can only have one application registered at a time. If there is already an application handler registered, another initialization will override the existing handler.
382+
* The Location library can only have one application registered at a time.
383+
If there is already an application handler registered, another initialization will override the existing handler.
384+
* The :ref:`GNSS interface<nrfxlib:gnss_interface>` should not be used directly by the application when using the Location library.
385+
Using the GNSS interface from both the application and the Location library may lead to unexpected behavior.
383386

384387
Dependencies
385388
************
@@ -397,7 +400,7 @@ This library uses the following |NCS| libraries:
397400

398401
It uses the following `sdk-nrfxlib`_ library:
399402

400-
* :ref:`nrfxlib:gnss_interface`
403+
* :ref:`GNSS interface<nrfxlib:gnss_interface>`
401404

402405
It uses the following Zephyr libraries:
403406

0 commit comments

Comments
 (0)