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.

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

samples: cellular: rename from nrf9160 #11500

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
47 changes: 23 additions & 24 deletions .github/test-spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
- "subsys/nrf_security/**/*"
- "!subsys/nrf_security/doc/**/*"
- "!subsys/nrf_security/*.rst"
- "samples/nrf9160/lwm2m_client/**/*"
- "samples/cellular/lwm2m_client/**/*"

"CI-audio-test":
- "applications/nrf5340_audio/**/*"
Expand Down Expand Up @@ -92,18 +92,17 @@
- "lib/nrf_modem_lib/**/*"
- "lib/pdn/**/*"
- "lib/sms/**/*"
- "samples/nrf9160/at_client/**/*"
- "samples/nrf9160/at_monitor/**/*"
- "samples/nrf9160/ciphersuites/**/*"
- "samples/nrf9160/coap_client/**/*"
- "samples/nrf9160/download/**/*"
- "samples/nrf9160/fmfu_smp_svr/**/*"
- "samples/nrf9160/http_update/**/*"
- "samples/nrf9160/https_client/**/*"
- "samples/nrf9160/modem_*/**/*"
- "samples/nrf9160/pdn/**/*"
- "samples/nrf9160/sms/**/*"
- "samples/nrf9160/udp/**/*"
- "samples/cellular/at_client/**/*"
- "samples/cellular/at_monitor/**/*"
- "samples/cellular/ciphersuites/**/*"
- "samples/cellular/coap_client/**/*"
- "samples/cellular/download/**/*"
- "samples/cellular/http_update/**/*"
- "samples/cellular/https_client/**/*"
- "samples/cellular/modem_*/**/*"
- "samples/cellular/mqtt_simple/**/*"
- "samples/cellular/pdn/**/*"
- "samples/cellular/sms/**/*"
- "subsys/net/lib/download_client/**/*"

"CI-lwm2m-test":
Expand All @@ -112,7 +111,7 @@
- "lib/bin/**/*"
- "lib/lte_link_control/**/*"
- "lib/nrf_modem_lib/**/*"
- "samples/nrf9160/lwm2m_carrier/**/*"
- "samples/cellular/lwm2m_carrier/**/*"

"CI-boot-dfu-test":
- "include/bl*"
Expand All @@ -124,9 +123,9 @@
- "cmake/*"
- "lib/lte_link_control/**/*"
- "modules/mcuboot/**/*"
- "samples/nrf9160/*fota/**/*"
- "samples/nrf9160/fmfu_smp_svr/**/*"
- "samples/nrf9160/http_update/**/*"
- "samples/cellular/*fota/**/*"
- "samples/cellular/fmfu_smp_svr/**/*"
- "samples/cellular/http_update/**/*"
- "samples/nrf5340/netboot/*"
- "samples/bootloader/**/*"
- "scripts/bootloader/**/*"
Expand Down Expand Up @@ -213,9 +212,9 @@
- "lib/date_time/**/*"
- "drivers/sensor/sensor_sim/**/*"
- "applications/asset_tracker_v2/**/*"
- "samples/nrf9160/udp/**/*"
- "samples/nrf9160/aws_iot/**/*"
- "samples/nrf9160/azure_iot_hub/**/*"
- "samples/cellular/udp/**/*"
- "samples/cellular/aws_iot/**/*"
- "samples/cellular/azure_iot_hub/**/*"

"CI-apps-test":
- "applications/machine_learning/**/*"
Expand Down Expand Up @@ -423,7 +422,7 @@
- "lib/pdn/**/*"
- "lib/sms/**/*"
- "lib/supl/**/*"
- "samples/nrf9160/modem_shell/**/*"
- "samples/cellular/modem_shell/**/*"
- "subsys/net/lib/download_client/**/*"
- "subsys/net/lib/fota_download/**/*"
- "subsys/net/lib/nrf_cloud/**/*"
Expand Down Expand Up @@ -457,8 +456,8 @@
- "lib/modem_jwt/**/*"
- "lib/modem_key_mgmt/**/*"
- "lib/supl/**/*"
- "samples/nrf9160/gnss/**/*"
- "samples/nrf9160/location/**/*"
- "samples/cellular/gnss/**/*"
- "samples/cellular/location/**/*"
- "subsys/net/lib/nrf_cloud/**/*"
- "subsys/net/lib/rest_client/**/*"

Expand All @@ -473,7 +472,7 @@

"CI-cloud-test":
- "include/net/nrf_cloud*"
- "samples/nrf9160/nrf_cloud_*/**/*"
- "samples/cellular/nrf_cloud_*/**/*"
- "subsys/net/lib/nrf_cloud/**/*"
- any:
- "subsys/nrf_security/**/*"
Expand Down
22 changes: 11 additions & 11 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -153,17 +153,17 @@ Kconfig* @tejlmand
/samples/nfc/ @grochu
/samples/nrf_rpc/ @doki-nordic @KAGA164
/samples/nrf5340/empty_app_core/ @doki-nordic
/samples/nrf9160/ @rlubos @lemrey
/samples/nrf9160/azure_* @jtguggedal @simensrostad @coderbyheart
/samples/nrf9160/battery/ @MirkoCovizzi
/samples/nrf9160/location/ @trantanen @jhirsi @tokangas
/samples/nrf9160/lwm2m_client/ @rlubos @SeppoTakalo @jarlamsa @jheiskan81 @juhaylinen
/samples/nrf9160/modem_shell/ @trantanen @jhirsi @tokangas
/samples/nrf9160/nidd/ @stig-bjorlykke
/samples/nrf9160/nrf_cloud_* @plskeggs @jayteemo @glarsennordic
/samples/nrf9160/nrf_provisioning/ @SeppoTakalo @juhaylinen
/samples/nrf9160/modem_trace_flash/ @gregersrygg @balaji-nordic
/samples/nrf9160/sms/ @trantanen @tokangas
/samples/cellular/ @rlubos @lemrey
/samples/cellular/azure_* @jtguggedal @simensrostad @coderbyheart
/samples/cellular/battery/ @MirkoCovizzi
/samples/cellular/location/ @trantanen @jhirsi @tokangas
/samples/cellular/lwm2m_client/ @rlubos @SeppoTakalo @jarlamsa @jheiskan81 @juhaylinen
/samples/cellular/modem_shell/ @trantanen @jhirsi @tokangas
/samples/cellular/nidd/ @stig-bjorlykke
/samples/cellular/nrf_cloud_* @plskeggs @jayteemo @glarsennordic
/samples/cellular/nrf_provisioning/ @SeppoTakalo @juhaylinen
/samples/cellular/modem_trace_flash/ @gregersrygg @balaji-nordic
/samples/cellular/sms/ @trantanen @tokangas
/samples/openthread/ @rlubos @edmont @canisLupus1313 @mariuszpos
/samples/nrf_profiler/ @pdunaj
/samples/peripheral/radio_test/ @KAGA164 @maje-emb
Expand Down
2 changes: 1 addition & 1 deletion doc/_utils/redirects.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""

Check warning on line 1 in doc/_utils/redirects.py

View workflow job for this annotation

GitHub Actions / call-workflow / Run license checks on patch series (PR)

License Problem

Any license is allowed for this file, but it is recommended to use a more suitable one.
Copyright (c) 2022 Nordic Semiconductor
SPDX-License-Identifier: Apache-2.0

Expand Down Expand Up @@ -179,7 +179,7 @@
("samples/samples_matter","samples/matter"),
("samples/samples_nfc","samples/nfc"),
("samples/samples_nrf5340","samples/nrf5340"),
("samples/samples_nrf9160","samples/nrf9160"),
("samples/samples_nrf9160","samples/cellular"),
("samples/samples_other","samples/other"),
("samples/samples_tfm","samples/tfm"),
("samples/samples_thread","samples/thread"),
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/config_and_build/programming.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ After completing the :ref:`manual <build_environment_cli>` or :ref:`automatic <g

.. code-block:: console

cd nrf/samples/nrf9160/at_client
cd nrf/samples/cellular/at_client

#. Build the application using the west command.
The build target is specified by the parameter *build_target* in the west command as follows:
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/device_guides/nrf91.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Working with nRF91 Series
:local:
:depth: 2

The |NCS| provides support for developing on the `nRF9160 System in Package (SiP) <nRF9160 product website_>`_ using the `nRF9160 DK (PCA10090) <nRF9160 DK product page_>`_ and the `Thingy:91 (PCA20035) <Thingy\:91 product page_>`_, and offers :ref:`samples <nrf9160_samples>` dedicated to these devices.
The |NCS| provides support for developing on the `nRF9160 System in Package (SiP) <nRF9160 product website_>`_ using the `nRF9160 DK (PCA10090) <nRF9160 DK product page_>`_ and the `Thingy:91 (PCA20035) <Thingy\:91 product page_>`_, and offers :ref:`samples <cellular_samples>` dedicated to these devices.
For more details on the SiP, see the `nRF9160 product website`_ and the `nRF9160 Product Specification`_.

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/device_guides/working_with_nrf/nrf91/nrf9160.rst
Original file line number Diff line number Diff line change
Expand Up @@ -406,4 +406,4 @@ It is also possible to change the size of the partition with :kconfig:option:`CO
Available drivers, libraries, and samples
*****************************************

See the :ref:`drivers`, :ref:`libraries`, and :ref:`nRF9160 samples <nrf9160_samples>` sections and the respective repository folders for up-to-date information.
See the :ref:`drivers`, :ref:`libraries`, and :ref:`samples <cellular_samples>` sections and the respective repository folders for up-to-date information.
2 changes: 1 addition & 1 deletion doc/nrf/includes/lwm2m_carrier_library.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ See the library's documentation for more information and configuration options.
To enable the LwM2M carrier library, add the parameter ``-DOVERLAY_CONFIG=overlay-carrier.conf`` to your build command.

The CA root certificates that are needed for modem FOTA are not provisioned in the |application_sample_name|.
You can flash the :ref:`lwm2m_carrier` sample to write the certificates to modem before flashing the |application_sample_name|, or use the :ref:`at_client_sample` sample as explained in :ref:`Preparing the nRF9160: LwM2M Client sample for production <lwm2m_client_provisioning>`.
You can flash the :ref:`lwm2m_carrier` sample to write the certificates to modem before flashing the |application_sample_name|, or use the :ref:`at_client_sample` sample as explained in :ref:`preparing the Cellular: LwM2M Client sample for production <lwm2m_client_provisioning>`.
It is also possible to modify the |application_sample_name| project itself to include the certificate provisioning, as demonstrated in the :ref:`lwm2m_carrier` sample.

.. code-block:: c
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/libraries/bin/lwm2m_carrier/app_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Configuration
To run the library in an application, you must implement the application with the API of the library.
Enable the library by setting the :kconfig:option:`CONFIG_LWM2M_CARRIER` Kconfig option to ``y``.

The :ref:`lwm2m_carrier` sample project configuration (:file:`nrf/samples/nrf9160/lwm2m_carrier/prj.conf`) contains all the configurations that are needed by the LwM2M carrier library.
The :ref:`lwm2m_carrier` sample project configuration (:file:`nrf/samples/cellular/lwm2m_carrier/prj.conf`) contains all the configurations that are needed by the LwM2M carrier library.

To overwrite the carrier default settings, you can provide the initialization parameter :c:type:`lwm2m_carrier_config_t` with the Kconfig options specified in the following sections.
You can also use the provided :ref:`lwm2m_carrier_shell` to quickly get started and experiment with the API.
Expand Down
4 changes: 2 additions & 2 deletions doc/nrf/libraries/networking/nrf_cloud_pgps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ There are three ways to define this storage location:
This partition can optionally be located in external flash for the nRF9160 development kit version 0.14.0 and later.
This conserves space in the main flash for storing code or other data.

To use an external flash partition, enable the following options in your project's configuration file or place them in a configuration overlay file (for example :file:`samples/nrf9160/nrf_cloud_mqtt_multi_service/overlay_pgps_ext_flash.conf`):
To use an external flash partition, enable the following options in your project's configuration file or place them in a configuration overlay file (for example :file:`samples/cellular/nrf_cloud_mqtt_multi_service/overlay_pgps_ext_flash.conf`):

* :kconfig:option:`CONFIG_SPI`
* :kconfig:option:`CONFIG_SPI_NOR`
Expand Down Expand Up @@ -123,7 +123,7 @@ There are three ways to define this storage location:
};

This is typically placed in a file within your application's source folder in a :file:`boards` subfolder.
See an example provided in the file :file:`samples/nrf9160/nrf_cloud_mqtt_multi_service/boards/nrf9160dk_nrf9160_ns_0_14_0.overlay`.
See an example provided in the file :file:`samples/cellular/nrf_cloud_mqtt_multi_service/boards/nrf9160dk_nrf9160_ns_0_14_0.overlay`.

* To use the MCUboot secondary partition as storage, enable the :kconfig:option:`CONFIG_NRF_CLOUD_PGPS_STORAGE_MCUBOOT_SECONDARY` option.

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/libraries/others/supl_os_client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ API callback functions
Callback functions are needed to achieve platform independence.
If your application uses the SUPL client library, you must implement these callback functions.
For an example of the implementation, see the :ref:`gnss_sample` sample.
The implementation is located in the :file:`samples/nrf9160/gnss/src/` directory.
The implementation is located in the :file:`samples/cellular/gnss/src/` directory.
The various callback functions implemented in the SUPL client library and their purposes are listed below.

A-GPS handler
Expand Down
6 changes: 3 additions & 3 deletions doc/nrf/releases_and_maturity/known_issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1870,8 +1870,8 @@ Unstable NFC tag samples
NFC tag samples are unstable when exhaustively tested (performing many repeated read and/or write operations).
NFC tag data might be corrupted.

nRF9160 samples
===============
Cellular samples
================

.. rst-class:: v1-4-1 v1-4-0 v1-3-2 v1-3-1 v1-3-0

Expand All @@ -1883,7 +1883,7 @@ NCSDK-5666: LTE Sensor Gateway
.. rst-class:: v1-2-0

GPS sockets and SUPL client library stops working
The `nRF9160: GPS with SUPL client library <https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.2.0/nrf/samples/nrf9160/gps/README.html>`_ sample stops working if :ref:`supl_client` support is enabled, but the SUPL host name cannot be resolved.
The `nRF9160: GPS with SUPL client library <https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.2.0/nrf/samples/cellular/gps/README.html>`_ sample stops working if :ref:`supl_client` support is enabled, but the SUPL host name cannot be resolved.

**Affected platforms:** nRF9160

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ nRF9160
* :ref:`nrf_coap_client_sample` sample - Updated the default server URL to ``californium.eclipseprojects.io``.
* nRF9160: Simple MQTT sample - Updated the default server URL to ``mqtt.eclipseprojects.io``.
* Extracted the certificate, button, and LED handling functionality from :ref:`http_application_update_sample` sample to :file:`samples/nrf9160/http_update/common`, to share them with :ref:`http_modem_delta_update_sample` sample.
* Moved the :ref:`http_application_update_sample` sample from :file:`samples/nrf9160/http_application_update/` to :file:`samples/nrf9160/http_update/application_update`.
* Moved the :ref:`http_application_update_sample` sample from ``samples/nrf9160/http_application_update/`` to ``samples/nrf9160/http_update/application_update``.
* :ref:`lib_download_client` library:

* Reintroduced the optional TCP timeout (enabled by default) on the TCP socket that is used for the download.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ In addition to documentation related to the changes listed above, the following
* Removed the weather station sample page for Matter.
The sample has been upgraded to application.

* :ref:`nrf9160_samples`:
* nRF9160 samples:

* :ref:`http_full_modem_update_sample` - Updated with the description of its customization options for firmware files.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@ nRF9160 samples
It is now handled by the :ref:`lib_nrf_cloud` library.

* Renamed the nRF9160: nRF Cloud REST cellular position sample to :ref:`nrf_cloud_rest_cell_pos_sample` sample.
Sample files are moved from :file:`samples/nrf9160/nrf_cloud_rest_cell_pos` to :file:`samples/nrf9160/nrf_cloud_rest_cell_location`.
Sample files are moved from ``samples/nrf9160/nrf_cloud_rest_cell_pos`` to ``samples/nrf9160/nrf_cloud_rest_cell_location``.

Trusted Firmware-M (TF-M) samples
---------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -956,7 +956,7 @@ Documentation
* The :ref:`ug_nrf9160` guide, relevant application and sample documentation with a section about :ref:`external flash <nrf9160_external_flash>`.
* The :ref:`nrf_modem_lib_readme` library documentation with a section about :ref:`modem trace flash backend <modem_trace_flash_backend>`.
* The :ref:`mod_memfault` library documentation has been moved from :ref:`lib_others` to :ref:`lib_debug`.
* The :ref:`mqtt_sample` sample documentation has been moved from :ref:`nrf9160_samples` to :ref:`networking_samples`.
* The :ref:`mqtt_sample` sample documentation has been moved from nRF9160 samples to :ref:`networking_samples`.
* The :ref:`ug_thingy53` guide by adding a section on :ref:`building Wi-Fi applications <thingy53_build_pgm_targets_wifi>`.
* The :ref:`ug_bt_mesh_configuring` page with additional configuration options used to configure the behavior and performance of a Bluetooth mesh network.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,8 +231,10 @@ Cryptography samples

* Added the :ref:`crypto_ecjpake` sample demonstrating usage of EC J-PAKE.

nRF9160 samples
---------------
Cellular samples (renamed from nRF9160 samples)
-----------------------------------------------

* Renamed nRF9160 samples to cellular samples and are now found in the :file:`samples/cellular` folder.

* Added the :ref:`battery` sample to show how to use the :ref:`modem_battery_readme` library.

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/samples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ General information about samples in the |NCS|
:caption: Subpages:

samples/bl
samples/cellular
samples/crypto
samples/debug
samples/edge
Expand All @@ -34,7 +35,6 @@ General information about samples in the |NCS|
samples/net
samples/nfc
samples/nrf5340
samples/nrf9160
samples/pmic
samples/tfm
samples/thread
Expand Down
12 changes: 12 additions & 0 deletions doc/nrf/samples/cellular.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cellular_samples:

Cellular samples
################

.. toctree::
:maxdepth: 1
:caption: Subpages
:glob:

../../../samples/cellular/*/README
../../../samples/cellular/http_update/*/README
12 changes: 0 additions & 12 deletions doc/nrf/samples/nrf9160.rst

This file was deleted.

2 changes: 1 addition & 1 deletion doc/nrf/templates/library_template_README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Template: Library

* Give the library a concise name that also corresponds to the folder name.

If the library targets a specific protocol or device, add it in the title before the library name (for example, "NFC:" or "nRF9160:").
If the library targets a specific protocol or device, add it in the title before the library name (for example, "NFC:").
Do not include the word "library" in the title.
Use the provided stock phrases and includes when possible.

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/templates/sample_README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Template: Sample

.. note::
* Give the sample a concise name that corresponds to the folder name.
If the sample targets a specific protocol or device, add it in the title before the sample name (for example, "NFC:" or "nRF9160:").
If the sample targets a specific protocol or device, add it in the title before the sample name (for example, "NFC:" or "Cellular:").
Do not include the word "sample" in the title.
* Put the documentation inside the sample folder and use the file name :file:`README.rst`.
* Use the provided stock phrases and includes when possible.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _at_client_sample:

nRF9160: AT Client
##################
Cellular: AT Client
###################

.. contents::
:local:
Expand Down Expand Up @@ -35,7 +35,7 @@ For more information on the AT commands, see the `AT Commands Reference Guide`_.
Building and running
********************

.. |sample path| replace:: :file:`samples/nrf9160/at_client`
.. |sample path| replace:: :file:`samples/cellular/at_client`

.. include:: /includes/build_and_run_ns.txt

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
sample:
name: at_client Sample
tests:
sample.nrf9160.at_client:
sample.cellular.at_client:
build_only: true
integration_platforms:
- nrf9160dk_nrf9160_ns
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _at_monitor_sample:

nRF9160: AT monitor
###################
Cellular: AT monitor
####################

.. contents::
:local:
Expand Down Expand Up @@ -33,7 +33,7 @@ Once the device registers with the network, the sample reads the modem PSM mode
Building and running
********************

.. |sample path| replace:: :file:`samples/nrf9160/at_monitor`
.. |sample path| replace:: :file:`samples/cellular/at_monitor`

.. include:: /includes/build_and_run_ns.txt

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
sample:
name: AT monitor sample
tests:
sample.nrf9160.at_monitor:
sample.cellular.at_monitor:
build_only: true
integration_platforms:
- nrf9160dk_nrf9160_ns
Expand Down
File renamed without changes.
Loading