diff --git a/doc/_utils/redirects.py b/doc/_utils/redirects.py index 5bc2eeec8e2c..982bbb01fe9a 100644 --- a/doc/_utils/redirects.py +++ b/doc/_utils/redirects.py @@ -214,9 +214,9 @@ ("working_with_nrf/nrf53/nrf5340", "app_dev/device_guides/nrf53/index"), ("device_guides/working_with_nrf/nrf53/nrf5340", "app_dev/device_guides/nrf53/index"), ("device_guides/nrf53/index", "app_dev/device_guides/nrf53/index"), - ("ug_thingy53", "app_dev/device_guides/nrf53/index"), # Developing with Thingy:53 (removed for 2.7.0) - ("working_with_nrf/nrf53/thingy53", "app_dev/device_guides/nrf53/index"), - ("device_guides/working_with_nrf/nrf53/thingy53", "app_dev/device_guides/nrf53/index"), + ("ug_thingy53", "app_dev/device_guides/thingy53/index"), # Developing with Thingy:53 (removed for 2.7.0) + ("working_with_nrf/nrf53/thingy53", "app_dev/device_guides/thingy53/index"), + ("device_guides/working_with_nrf/nrf53/thingy53", "app_dev/device_guides/thingy53/index"), ("device_guides/nrf53/features_nrf53", "app_dev/device_guides/nrf53/features_nrf53"), # Features of nRF53 Series ("device_guides/nrf53/building_nrf53", "app_dev/device_guides/nrf53/building_nrf53"), # Building and programming with nRF53 Series ("device_guides/nrf53/fota_update_nrf5340", "app_dev/device_guides/nrf53/fota_update_nrf5340"), # FOTA updates with nRF5340 DK @@ -224,7 +224,8 @@ ("device_guides/nrf53/simultaneous_multi_image_dfu_nrf5340", "app_dev/device_guides/nrf53/simultaneous_multi_image_dfu_nrf5340"), # Simultaneous multi-image DFU with nRF5340 DK ("device_guides/nrf53/serial_recovery", "app_dev/device_guides/nrf53/serial_recovery"), # MCUboot’s serial recovery of the networking core image ("device_guides/nrf53/logging_nrf5340", "app_dev/device_guides/nrf53/logging_nrf5340"), # Getting logging output with nRF5340 DK - ("device_guides/nrf53/thingy53_application_guide", "app_dev/device_guides/nrf53/thingy53_application_guide"), # Application guide for Thingy:53 + ("device_guides/nrf53/thingy53_application_guide", "app_dev/device_guides/thingy53/thingy53_application_guide"), # Application guide for Thingy:53 + ("app_dev/device_guides/nrf53/thingy53_application_guide", "app_dev/device_guides/thingy53/thingy53_application_guide"), ("device_guides/working_with_nrf/nrf53/qspi_xip_guide", "app_dev/device_guides/nrf53/qspi_xip_guide_nrf5340"), # External execute in place (XIP) configuration on the nRF5340 SoC ("device_guides/nrf53/qspi_xip_guide_nrf5340", "app_dev/device_guides/nrf53/qspi_xip_guide_nrf5340"), ("ug_nrf52", "app_dev/device_guides/nrf52/index"), # Developing with nRF52 Series (landing) diff --git a/doc/_zoomin/ncs.tags.yml b/doc/_zoomin/ncs.tags.yml index e49e73f05e62..fb2e0a200624 100644 --- a/doc/_zoomin/ncs.tags.yml +++ b/doc/_zoomin/ncs.tags.yml @@ -213,8 +213,7 @@ mapping_topics: - nrf/app_dev/device_guides/nrf53/*.html: ["nrf53-series"] - nrf/app_dev/device_guides/nrf53/features_nrf53.html: ["nrf5340", "thingy53", "development-kits", "prototyping-platforms"] - - nrf/app_dev/device_guides/nrf53/building_nrf53.html: ["nrf5340", "thingy53", "development-kits", - "prototyping-platforms", + - nrf/app_dev/device_guides/nrf53/building_nrf53.html: ["nrf5340", "development-kits", "nrf-connect-vsc"] - nrf/app_dev/device_guides/nrf53/fota_update_nrf5340.html: ["nrf5340", "development-kits"] - nrf/app_dev/device_guides/nrf53/multi_image_nrf5340.html: ["nrf5340", "development-kits"] @@ -222,9 +221,8 @@ mapping_topics: "development-kits"] - /nrf/app_dev/device_guides/nrf53/serial_recovery.html: ["nrf5340", "development-kits"] - /nrf/app_dev/device_guides/nrf53/logging_nrf5340.html: ["nrf5340", "development-kits"] - - nrf/app_dev/device_guides/nrf53/thingy53_application_guide.html: ["thingy53", - "prototyping-platforms"] - nrf/app_dev/device_guides/nrf53/qspi_xip_guide_nrf5340.html: ["nrf5340", "development-kits"] + - nrf/app_dev/device_guides/thingy53/*.html: ["thingy53", "prototyping-platforms", "nrf53-series"] - nrf/app_dev/device_guides/nrf52/*.html: ["nrf52-series", "development-kits", "nrf52840", "nrf52833", "nrf52832", "nrf52820", "nrf52811", "nrf52810", "nrf52805"] diff --git a/doc/nrf/app_dev.rst b/doc/nrf/app_dev.rst index d849f59c0778..eb5c556479e4 100644 --- a/doc/nrf/app_dev.rst +++ b/doc/nrf/app_dev.rst @@ -32,6 +32,7 @@ For detailed integration instructions of specific technologies and components, c app_dev/device_guides/nrf52/index app_dev/device_guides/thingy91x/index app_dev/device_guides/thingy91/index + app_dev/device_guides/thingy53/index app_dev/device_guides/pmic/index app_dev/device_guides/fem/index app_dev/device_guides/wifi_coex diff --git a/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst b/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst index 54149837fd8e..3535700b4316 100644 --- a/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst +++ b/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst @@ -147,134 +147,3 @@ To program the nRF5340 DK from the command line, use either west (which uses nrf .. note:: The ``--verify`` command confirms that the writing operation has succeeded. - -.. _thingy53_building_pgming: - -Building and programming with Thingy:53 -*************************************** - -You can program the Nordic Thingy:53 by using the images obtained by building the code in the |NCS| environment. - -To set up your system to be able to build a firmware image, follow the :ref:`installation` guide for the |NCS|. - -.. _thingy53_build_pgm_targets: - -Board targets -============= - -The board targets of interest for Thingy:53 in the |NCS| are listed in the following table: - -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -|Component | Board target | -+================================+==================================================================================================================================+ -| nRF5340 SoC - Application core |``thingy53/nrf5340/cpuapp`` for :ref:`Cortex-M Security Extensions (CMSE) disabled ` | -| | | -| |``thingy53/nrf5340/cpuapp/ns`` for :ref:`CMSE enabled ` | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| nRF5340 SoC - Network core |``thingy53/nrf5340/cpunet`` | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -The |NCS| uses :ref:`ug_multi_image` for Thingy:53 by default. -When you choose ``thingy53/nrf5340/cpuapp`` or ``thingy53/nrf5340/cpuapp/ns`` as the board target when building a sample or application, you will generate firmware for both the application core and network core: - -* The application core firmware consists of MCUboot bootloader and an application image. -* The network core firmware consists of network core bootloader (B0n) and application firmware of the network core. - -The build process generates firmware in two formats: - -* Intel Hex file (:file:`merged.hex` and :file:`merged_CPUNET.hex`) - Used with an external debug probe. - These file contains bootloaders and applications for each core. -* Binary files (:file:`zephyr.signed.bin`), containing signed application firmwares for the application and network core, respectively. - For convenience, the binary files are bundled in :file:`dfu_application.zip`, together with a manifest that describes them. - You can use the binary files or the combined zip archive to update application firmware for both cores, with either MCUboot serial recovery or OTA DFU using Bluetooth LE. - -For more information about files generated as output of the build process, see :ref:`app_build_output_files`. - -See the following sections for details regarding building and programming the firmware for Thingy:53 in various environments. -See :ref:`thingy53_app_update` for more detailed information about updating firmware on Thingy:53. - -.. _thingy53_build_pgm_targets_wifi: - -Building Wi-Fi applications on Thingy:53 ----------------------------------------- - -.. building_wi_fi_applications_on_thingy_53_start - -You can use the Nordic Thingy:53 with the nRF7002 Expansion Board (EB) for Wi-Fi development. -Connect the nRF7002 EB to the **P9** connector on Thingy:53. - -To build for the nRF7002 EB with Thingy:53, use the ``thingy53/nrf5340/cpuapp`` board target with the CMake ``SHIELD`` variable set to ``nrf7002eb``. -For example, you can use the following command when building on the command line: - -.. code-block:: - - west build -b thingy53/nrf5340/cpuapp -- -DSHIELD=nrf7002eb - -.. building_wi_fi_applications_on_thingy_53_end - -For the compatible Wi-Fi samples in the |NCS|, see the :ref:`wifi_samples` section. - -.. _thingy53_build_pgm_vscode: - -Building and programming using |VSC| -==================================== - -Complete the following steps to build and program using the |nRFVSC|: - -.. |sample_path_vsc| replace:: :file:`nrf/samples/bluetooth/peripheral_lbs` - -.. |vsc_sample_board_target_line| replace:: select ``thingy53/nrf5340/cpuapp`` as the board target - -.. include:: /includes/vsc_build_and_run.txt - -3. Program the sample or application: - - a. Connect the Nordic Thingy:53 to the debug out port on a 10-pin external debug probe, for example nRF5340 DK, using a 10-pin JTAG cable. - #. Connect the external debug probe to the PC using a USB cable. - #. Make sure that the Thingy:53 and the external debug probe are powered on. - #. Click :guilabel:`Flash` in the :guilabel:`Actions View`. - -.. _thingy53_build_pgm_command_line: - -Building and programming on the command line -============================================ - -You must :ref:`build_environment_cli` before you start building an |NCS| project on the command line. - -To build and program the source code from the command line, complete the following steps: - -1. |open_terminal_window_with_environment| -#. Go to the specific directory for the sample or application. - - For example, the directory path is :file:`ncs/nrf/applications/machine_learning` when building the source code for the :ref:`nrf_machine_learning_app` application. - -#. Make sure that you have the required version of the |NCS| repository by pulling the ``sdk-nrf`` repository on GitHub as described in :ref:`dm-wf-get-ncs` and :ref:`dm-wf-update-ncs` sections. -#. Get the rest of the dependencies using west: - - .. code-block:: console - - west update - -#. Build the sample or application code as follows: - - .. parsed-literal:: - :class: highlight - - west build -b *board_target* -d *destination_directory_name* - - The board target should be ``thingy53/nrf5340/cpuapp`` or ``thingy53/nrf5340/cpuapp/ns`` when building samples for the application core. - The proper child image for ``thingy53/nrf5340/cpunet`` will be built automatically. - See :ref:`thingy53_build_pgm_targets` for details. - -#. Program the sample or application: - - a. Connect the Nordic Thingy:53 to the debug out port on a 10-pin external debug probe, for example nRF5340 DK, using a 10-pin JTAG cable. - #. Connect the external debug probe to the PC using a USB cable. - #. Make sure that the Nordic Thingy:53 and the external debug probe are powered on. - #. Use the following command to program the sample or application to the device: - - .. code-block:: console - - west flash - - The device resets and runs the programmed sample or application. diff --git a/doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst b/doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst index 21cb578c5fad..fdfc70d09af3 100644 --- a/doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst +++ b/doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst @@ -16,7 +16,6 @@ For additional information, refer to the following resources: * `nRF53 Series`_ for the technical documentation on the nRF53 Series chips and associated kits. * :ref:`installation` and :ref:`configuration_and_build` documentation to install the |NCS| and learn more about its development environment. -* :ref:`ug_thingy53_gs` for getting started with the Thingy:53. Dual-core architecture ********************** @@ -34,7 +33,6 @@ The separation of application and network functionalities simplifies firmware up This architecture is ideal for devices requiring significant data processing alongside continuous wireless connectivity. - .. _ug_nrf5340_intro_net_core: Network core diff --git a/doc/nrf/app_dev/device_guides/nrf53/index.rst b/doc/nrf/app_dev/device_guides/nrf53/index.rst index ce0c00c9c3c9..a4d32e31a2ba 100644 --- a/doc/nrf/app_dev/device_guides/nrf53/index.rst +++ b/doc/nrf/app_dev/device_guides/nrf53/index.rst @@ -1,7 +1,6 @@ .. _ug_nrf53: .. _nrf53_working: .. _ug_nrf5340: -.. _ug_thingy53: Developing with nRF53 Series ############################ @@ -29,10 +28,6 @@ Zephyr and the |NCS| provide support and contain board definitions for developin - ``nrf5340_audio_dk/nrf5340/cpuapp``, ``nrf5340_audio_dk/nrf5340/cpuapp/ns``, ``nrf5340_audio_dk/nrf5340/cpunet`` - | `Hardware Specification `_ | :ref:`nrf53_audio_app` - * - :ref:`zephyr:thingy53_nrf5340` - - PCA20053 - - ``thingy53/nrf5340/cpuapp``, ``thingy53/nrf5340/cpuapp/ns``, ``thingy53/nrf5340/cpunet`` - - `Hardware Specification `_ .. note:: The nRF5340 PDK has been deprecated with the introduction of the production-level nRF5340 DK. @@ -46,10 +41,6 @@ It is meant for use with for :ref:`nrf53_audio_app`, which integrate the LE Audi Given their complexity, the applications use custom building and programming procedures. Refer to their documentation for more information. -The Nordic Thingy:53 is a battery-operated prototyping platform for IoT Systems. -The Nordic Thingy:53 integrates the nRF5340 SoC that supports Bluetooth® Low Energy, IEEE 802.15.4 based protocols and Near Field Communication (NFC). -The nRF5340 is augmented with the nRF21540 RF FEM (Front-end Module) Range extender that has an integrated power amplifier (PA)/low-noise amplifier (LNA) and nPM1100 Power Management IC (PMIC) that has an integrated dual-mode buck regulator and battery charger. - .. toctree:: :maxdepth: 2 :caption: Subpages: @@ -61,5 +52,4 @@ The nRF5340 is augmented with the nRF21540 RF FEM (Front-end Module) Range exten simultaneous_multi_image_dfu_nrf5340 serial_recovery logging_nrf5340 - thingy53_application_guide qspi_xip_guide_nrf5340 diff --git a/doc/nrf/app_dev/device_guides/thingy53/building_thingy53.rst b/doc/nrf/app_dev/device_guides/thingy53/building_thingy53.rst new file mode 100644 index 000000000000..b0cac7e44922 --- /dev/null +++ b/doc/nrf/app_dev/device_guides/thingy53/building_thingy53.rst @@ -0,0 +1,130 @@ +.. _thingy53_building_pgming: + +Building and programming with Thingy:53 +####################################### + +.. contents:: + :local: + :depth: 2 + +You can program the Nordic Thingy:53 by using the images obtained by building the code in the |NCS| environment. + +To set up your system to be able to build a firmware image, follow the :ref:`installation` guide for the |NCS|. + +.. _thingy53_build_pgm_targets: + +Board targets +************* + +The board targets of interest for Thingy:53 in the |NCS| are listed in the following table: + ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +|Component | Board target | ++================================+==================================================================================================================================+ +| nRF5340 SoC - Application core |``thingy53/nrf5340/cpuapp`` for :ref:`Cortex-M Security Extensions (CMSE) disabled ` | +| | | +| |``thingy53/nrf5340/cpuapp/ns`` for :ref:`CMSE enabled ` | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| nRF5340 SoC - Network core |``thingy53/nrf5340/cpunet`` | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + +The |NCS| uses :ref:`ug_multi_image` for Thingy:53 by default. +When you choose ``thingy53/nrf5340/cpuapp`` or ``thingy53/nrf5340/cpuapp/ns`` as the board target when building a sample or application, you will generate firmware for both the application core and network core: + +* The application core firmware consists of MCUboot bootloader and an application image. +* The network core firmware consists of network core bootloader (B0n) and application firmware of the network core. + +The build process generates firmware in two formats: + +* Intel Hex file (:file:`merged.hex` and :file:`merged_CPUNET.hex`) - Used with an external debug probe. + These file contains bootloaders and applications for each core. +* Binary files (:file:`zephyr.signed.bin`), containing signed application firmwares for the application and network core, respectively. + For convenience, the binary files are bundled in :file:`dfu_application.zip`, together with a manifest that describes them. + You can use the binary files or the combined zip archive to update application firmware for both cores, with either MCUboot serial recovery or OTA DFU using Bluetooth LE. + +For more information about files generated as output of the build process, see :ref:`app_build_output_files`. + +See the following sections for details regarding building and programming the firmware for Thingy:53 in various environments. +See :ref:`thingy53_app_update` for more detailed information about updating firmware on Thingy:53. + +.. _thingy53_build_pgm_targets_wifi: + +Building Wi-Fi applications on Thingy:53 +======================================== + +You can use the Nordic Thingy:53 with the nRF7002 Expansion Board (EB) for Wi-Fi development. +Connect the nRF7002 EB to the **P9** connector on Thingy:53. + +To build for the nRF7002 EB with Thingy:53, use the ``thingy53/nrf5340/cpuapp`` board target with the CMake ``SHIELD`` variable set to ``nrf7002eb``. +For example, you can use the following command when building on the command line: + +.. code-block:: + + west build -b thingy53/nrf5340/cpuapp -- -DSHIELD=nrf7002eb + +For the compatible Wi-Fi samples in the |NCS|, see the :ref:`wifi_samples` section. + +.. _thingy53_build_pgm_vscode: + +Building and programming using |VSC| +************************************ + +Complete the following steps to build and program using the |nRFVSC|: + +.. |sample_path_vsc| replace:: :file:`nrf/samples/bluetooth/peripheral_lbs` + +.. |vsc_sample_board_target_line| replace:: select ``thingy53/nrf5340/cpuapp`` as the board target + +.. include:: /includes/vsc_build_and_run.txt + +3. Program the sample or application: + + a. Connect the Nordic Thingy:53 to the debug out port on a 10-pin external debug probe, for example nRF5340 DK, using a 10-pin JTAG cable. + #. Connect the external debug probe to the PC using a USB cable. + #. Make sure that the Thingy:53 and the external debug probe are powered on. + #. Click :guilabel:`Flash` in the :guilabel:`Actions View`. + +.. _thingy53_build_pgm_command_line: + +Building and programming on the command line +******************************************** + +You must :ref:`build_environment_cli` before you start building an |NCS| project on the command line. + +To build and program the source code from the command line, complete the following steps: + +1. |open_terminal_window_with_environment| +#. Go to the specific directory for the sample or application. + + For example, the directory path is :file:`ncs/nrf/applications/machine_learning` when building the source code for the :ref:`nrf_machine_learning_app` application. + +#. Make sure that you have the required version of the |NCS| repository by pulling the ``sdk-nrf`` repository on GitHub as described in :ref:`dm-wf-get-ncs` and :ref:`dm-wf-update-ncs` sections. +#. Get the rest of the dependencies using west: + + .. code-block:: console + + west update + +#. Build the sample or application code as follows: + + .. parsed-literal:: + :class: highlight + + west build -b *board_target* -d *destination_directory_name* + + The board target should be ``thingy53/nrf5340/cpuapp`` or ``thingy53/nrf5340/cpuapp/ns`` when building samples for the application core. + The proper child image for ``thingy53/nrf5340/cpunet`` will be built automatically. + See :ref:`thingy53_build_pgm_targets` for details. + +#. Program the sample or application: + + a. Connect the Nordic Thingy:53 to the debug out port on a 10-pin external debug probe, for example nRF5340 DK, using a 10-pin JTAG cable. + #. Connect the external debug probe to the PC using a USB cable. + #. Make sure that the Nordic Thingy:53 and the external debug probe are powered on. + #. Use the following command to program the sample or application to the device: + + .. code-block:: console + + west flash + + The device resets and runs the programmed sample or application. diff --git a/doc/nrf/app_dev/device_guides/nrf53/images/thingy53_antenna_connections.svg b/doc/nrf/app_dev/device_guides/thingy53/images/thingy53_antenna_connections.svg similarity index 100% rename from doc/nrf/app_dev/device_guides/nrf53/images/thingy53_antenna_connections.svg rename to doc/nrf/app_dev/device_guides/thingy53/images/thingy53_antenna_connections.svg diff --git a/doc/nrf/app_dev/device_guides/thingy53/index.rst b/doc/nrf/app_dev/device_guides/thingy53/index.rst new file mode 100644 index 000000000000..9a1fab579fa1 --- /dev/null +++ b/doc/nrf/app_dev/device_guides/thingy53/index.rst @@ -0,0 +1,34 @@ +.. _ug_thingy53: + +Developing with Thingy:53 +######################### + +.. |nrf_series| replace:: devices of the nRF53 Series + +.. include:: /includes/guides_complementary_to_app_dev.txt + +Zephyr and the |NCS| provide support and contain board definitions for developing on the following nRF53 Series devices: + +.. list-table:: + :header-rows: 1 + + * - DK + - PCA number + - Board targets + - Documentation + * - :ref:`zephyr:thingy53_nrf5340` + - PCA20053 + - ``thingy53/nrf5340/cpuapp``, ``thingy53/nrf5340/cpuapp/ns``, ``thingy53/nrf5340/cpunet`` + - | :ref:`ug_thingy53_gs` + | `Hardware Specification `_ + +The Nordic Thingy:53 is a battery-operated prototyping platform for IoT Systems. +The Nordic Thingy:53 integrates the nRF5340 SoC that supports Bluetooth® Low Energy, IEEE 802.15.4 based protocols and Near Field Communication (NFC). +The nRF5340 is augmented with the nRF21540 RF FEM (Front-end Module) Range extender that has an integrated power amplifier (PA)/low-noise amplifier (LNA) and nPM1100 Power Management IC (PMIC) that has an integrated dual-mode buck regulator and battery charger. + +.. toctree:: + :maxdepth: 2 + :caption: Subpages: + + building_thingy53 + thingy53_application_guide diff --git a/doc/nrf/app_dev/device_guides/nrf53/thingy53_application_guide.rst b/doc/nrf/app_dev/device_guides/thingy53/thingy53_application_guide.rst similarity index 99% rename from doc/nrf/app_dev/device_guides/nrf53/thingy53_application_guide.rst rename to doc/nrf/app_dev/device_guides/thingy53/thingy53_application_guide.rst index 6e94ad7e512c..e720e5f23edc 100644 --- a/doc/nrf/app_dev/device_guides/nrf53/thingy53_application_guide.rst +++ b/doc/nrf/app_dev/device_guides/thingy53/thingy53_application_guide.rst @@ -162,7 +162,6 @@ Thingy:53 supports network core upgrade out of the box. :start-after: fota_upgrades_over_ble_additional_information_start :end-before: fota_upgrades_over_ble_additional_information_end - .. _thingy53_app_external_flash: External flash