Skip to content

Commit

Permalink
doc: working_with_nrf: squash structure for nRF91
Browse files Browse the repository at this point in the history
Reworked Working with nRF91 Series pages.
Moved their contents to separate pages.
Renamed Working with to Developing with.
NCSDK-22328.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
  • Loading branch information
greg-fer committed Apr 30, 2024
1 parent c09046c commit efb934b
Show file tree
Hide file tree
Showing 14 changed files with 613 additions and 920 deletions.
42 changes: 2 additions & 40 deletions doc/nrf/config_and_build/programming.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,47 +14,9 @@ Programming an application

To program the :ref:`output build files <app_build_output_files>` to your device, which in most of the cases will be :file:`zephyr.hex` or :file:`merged.hex`, use the steps for the development environment.

.. tabs::

.. group-tab:: nRF Connect for VS Code

You need to set up a build configuration before you program a device in the |nRFVSC|.

Complete the following steps:

1. Connect the development kit to your PC using a USB cable.
#. Power on the development kit.
#. Make sure you are familiar with :ref:`programming_hw`.
#. Open the nRF Connect extension in |VSC| by clicking its icon in the :guilabel:`Activity Bar`.
#. In the extension's :guilabel:`Actions View`, click on :guilabel:`Flash`.

For instructions about programming with the |nRFVSC|, see `How to flash an application`_.

If you want to program with custom options or scripts, read about `Binding custom tasks to actions`_ in the extension documentation.

For information about how to flash and erase in the |nRFVSC|, read about the `Application-specific flash options`_.

.. group-tab:: Command line

Complete the following steps:

1. Connect the development kit to your PC using a USB cable.
#. Power on the development kit.
#. Make sure you are familiar with :ref:`programming_hw`.
#. Program the application to the kit using the following command:

.. code-block:: console
west flash --erase
This command erases the full flash memory before programming, which is the recommended approach.
If the application depends on other flash memory areas (for example, if it uses the :ref:`zephyr:settings_api` partition where bonding information is stored), erasing the full kit before programming ensures that these areas are updated with the new content.
You can also :ref:`program without erasing <programming_params_no_erase>`.

The ``west flash`` command automatically resets the kit and starts the application.

For more information on programming using the command line, see :ref:`Flashing <zephyr:west-flashing>` in the Zephyr documentation.
.. |exceptions_step| replace:: Make sure you are familiar with :ref:`programming_hw`.

.. include:: ../includes/vsc_build_and_run_series.txt

.. _programming_hw:

Expand Down
21 changes: 13 additions & 8 deletions doc/nrf/device_guides/nrf91.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _ug_nrf91:

Working with nRF91 Series
#########################
Developing with nRF91 Series
############################

Zephyr and the |NCS| provide support for developing cellular applications using the following nRF91 Series devices:

Expand All @@ -15,14 +15,14 @@ Zephyr and the |NCS| provide support for developing cellular applications using
- Product pages
* - :ref:`zephyr:nrf9161dk_nrf9161`
- PCA10153
- ``nrf9161dk_nrf9161_ns``
- ``nrf9161dk_nrf9161_ns`` or ``nrf9161dk_nrf9161`` (see :ref:`app_boards_spe_nspe`)
- | `Product Specification <nRF9161 Product Specification_>`_
| `User Guide <nRF9161 DK Hardware_>`_
- | `nRF9161 DK product page`_
| `nRF9161 System in Package (SiP) <nRF9161 product website_>`_
* - :ref:`zephyr:nrf9160dk_nrf9160`
- PCA10090
- ``nrf9160dk_nrf9160_ns``
- ``nrf9160dk_nrf9160_ns`` or ``nrf9160dk_nrf9160`` (see :ref:`app_boards_spe_nspe`)
- | `Product Specification <nRF9160 Product Specification_>`_
| :ref:`Getting started <ug_nrf9160_gs>`
| `User Guide <nRF9160 DK Hardware_>`_
Expand All @@ -36,7 +36,7 @@ Zephyr and the |NCS| provide support for developing cellular applications using
- | `Thingy\:91 product page`_
| `nRF9160 System in Package (SiP) <nRF9160 product website_>`_
The nRF Connect SDK also offers :ref:`samples <cellular_samples>` dedicated to these devices.
The nRF Connect SDK also offers :ref:`samples <cellular_samples>` dedicated to these devices, as well as compatible :ref:`drivers` and :ref:`libraries`.

If you want to go through a hands-on online training to familiarize yourself with cellular IoT technologies and development of cellular applications, enroll in the `Cellular IoT Fundamentals course`_ in the `Nordic Developer Academy`_.

Expand All @@ -45,7 +45,12 @@ If you want to go through a hands-on online training to familiarize yourself wit
:caption: Subpages:

working_with_nrf/nrf91/nrf91_features
working_with_nrf/nrf91/nrf9161
working_with_nrf/nrf91/nrf9160
working_with_nrf/nrf91/thingy91
working_with_nrf/nrf91/nrf91_board_controllers
working_with_nrf/nrf91/nrf91_cloud_certificate
working_with_nrf/nrf91/nrf91_updating_fw_programmer
working_with_nrf/nrf91/nrf91_building
working_with_nrf/nrf91/nrf91_programming
working_with_nrf/nrf91/nrf91_testing_at_client
working_with_nrf/nrf91/nrf91_snippet
working_with_nrf/nrf91/nrf9160_external_flash
working_with_nrf/nrf91/thingy91
Binary file not shown.
Binary file not shown.
Loading

0 comments on commit efb934b

Please sign in to comment.