Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lib: location: Update documentation #19727

Merged
merged 2 commits into from
Jan 8, 2025
+11 −8
Merged

lib: location: Update documentation #19727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4433628
lib: location: Update documentation
tokangas Jan 2, 2025
f2be28a
doc: Fix link text for references to GNSS interface
tokangas Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions doc/nrf/libraries/modem/location.rst
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion doc/nrf/libraries/networking/nrf_cloud_agnss.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,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>`

API documentation
*****************
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/libraries/networking/nrf_cloud_pgps.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,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 subsystem:

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/releases_and_maturity/releases/release-notes-1.6.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ Modem library
* Updated :ref:`nrf_modem` to version 1.2.1.
See the :ref:`nrfxlib:nrf_modem_changelog` for detailed information.
* Added a new function-based GNSS API with support for new GNSS features in modem firmware v1.3.0.
See :ref:`nrfxlib:gnss_interface` for more information.
See :ref:`GNSS interface<nrfxlib:gnss_interface>` for more information.

* GNSS socket API is now deprecated.

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/releases_and_maturity/releases/release-notes-1.7.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ nRF9160
* nRF9160: Asset Tracker has been deprecated in favor of :ref:`asset_tracker_v2`.
* ``at_notif`` library has been deprecated in favor of the :ref:`at_monitor_readme` library.
* ``at_cmd`` library has been deprecated in favor of Modem library's native AT interface.
* GPS driver has been deprecated in favor of the :ref:`nrfxlib:gnss_interface`.
* GPS driver has been deprecated in favor of the :ref:`GNSS interface<nrfxlib:gnss_interface>`.

nRF5
====
Expand Down
2 changes: 1 addition & 1 deletion samples/cellular/gnss/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Cellular: GNSS
:local:
:depth: 2

This sample demonstrates how to use the :ref:`nrfxlib:gnss_interface` to control the `GNSS`_ module.
This sample demonstrates how to use the :ref:`GNSS interface<nrfxlib:gnss_interface>` to control the `GNSS`_ module.
It also shows how to improve fix speed and accuracy with the :ref:`lib_nrf_cloud_agnss` library and how to use the :ref:`lib_nrf_cloud_pgps` library.
Assistance data is downloaded from nRF Cloud using `nRF Cloud's REST-based device API <nRF Cloud REST API_>`_.

Expand Down
Loading