Skip to content

Commit

Permalink
lib: location: Update documentation
Browse files Browse the repository at this point in the history
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 <tommi.kangas@nordicsemi.no>
  • Loading branch information
tokangas committed Jan 8, 2025
1 parent 9abba20 commit 4433628
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions doc/nrf/libraries/modem/location.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The supported location methods are as follows:

* GNSS positioning

* Uses :ref:`gnss_interface` for getting the location.
* Uses :ref:`GNSS interface<gnss_interface>` for getting the location.
* A-GNSS and P-GPS are managed with :ref:`lib_nrf_cloud_agnss` and :ref:`lib_nrf_cloud_pgps`.
* 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.
* The data format of A-GNSS or P-GPS must be as received from :ref:`lib_nrf_cloud_agnss`.
Expand Down Expand Up @@ -379,7 +379,10 @@ The following |NCS| applications and samples use this library:
Limitations
***********

* 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.
* 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.
* The :ref:`GNSS interface<nrfxlib:gnss_interface>` should not be used directly by the application when using the Location library.
Using the GNSS interface from both the application and the Location library may lead to unexpected behavior.

Dependencies
************
Expand All @@ -397,7 +400,7 @@ This library uses the following |NCS| libraries:

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

* :ref:`nrfxlib:gnss_interface`
* :ref:`GNSS interface<nrfxlib:gnss_interface>`

It uses the following Zephyr libraries:

Expand Down

0 comments on commit 4433628

Please sign in to comment.