Skip to content

Commit

Permalink
doc: add mcumgr docs
Browse files Browse the repository at this point in the history
Adds the mcumgr docs removed from Zephyr

Signed-off-by: Anna Wojdylo <anna.wojdylo@nordicsemi.no>
  • Loading branch information
annwoj authored and nordicjm committed Sep 24, 2024
1 parent 45b0325 commit 3e7049e
Show file tree
Hide file tree
Showing 7 changed files with 526 additions and 3 deletions.
520 changes: 520 additions & 0 deletions doc/nrf/app_dev/bootloaders_dfu/dfu_tools_mcumgr_cli.rst

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions doc/nrf/app_dev/bootloaders_dfu/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,4 @@ To learn more, refer to the following documentation pages:

mcuboot_nsib/bootloader_mcuboot_nsib
qspi_xip_split_image
dfu_tools_mcumgr_cli
2 changes: 1 addition & 1 deletion doc/nrf/app_dev/device_guides/nrf53/serial_recovery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To upload the networking image, use the following command::
./mcumgr image upload <build_dir_path>/zephyr/net_core_app_update.bin -e -n 3 -c serial_conn

``serial_conn`` is the serial connection configuration.
For more information on MCUmgr image management, see :ref:`zephyr:image_mgmt`.
For more information on MCUmgr image management, see :ref:`dfu_tools_mcumgr_cli_image_mgmt`.

To enable the serial recovery of the network core while the multi-image update is not enabled in the MCUboot, set the following options:

Expand Down
1 change: 1 addition & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
.. _`Zephyr issue #69546`: https://github.com/zephyrproject-rtos/zephyr/issues/69546

.. _`sdk-mcuboot`: https://github.com/nrfconnect/sdk-mcuboot
.. _`MCUboot design`: https://github.com/mcu-tools/mcuboot/blob/main/docs/design.md
.. _`MCUboot repository`: https://github.com/mcu-tools/mcuboot
.. _`MCUboot Kconfig option`: https://github.com/nrfconnect/sdk-mcuboot/blob/main/boot/zephyr/Kconfig#L370

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/protocols/bt/bt_mesh/dfu_over_bt_mesh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For the complete list of commands, see the :ref:`zephyr:bluetooth_mesh_shell_dfd

The commands can be executed in two ways:

* Through the shell management subsystem of MCU manager (for example, using the nRF Connect Device Manager mobile application on Android or :ref:`Mcumgr command-line tool <zephyr:mcumgr_cli>`).
* Through the shell management subsystem of MCU manager (for example, using the nRF Connect Device Manager mobile application on Android or :ref:`Mcumgr command-line tool <dfu_tools_mcumgr_cli>`).
* By accessing the :ref:`zephyr:shell_api` module over UART.

Provisioning and configuring the devices
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1003,6 +1003,7 @@ Documentation

* The :ref:`ug_app_dev` section, which includes pages from the :ref:`configuration_and_build` section and from the removed Device configuration guides section.
* The :ref:`peripheral_sensor_node_shield` page.
* The :ref:`dfu_tools_mcumgr_cli` page after it was removed from the Zephyr repository.

* Restructured the :ref:`app_bootloaders` documentation and combined the DFU and bootloader articles.
Additionally, created a new bootloader :ref:`bootloader_quick_start`.
Expand Down
2 changes: 1 addition & 1 deletion samples/bluetooth/mesh/dfu/distributor/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Follow the description in the :ref:`dfu_over_bt_mesh` guide on how to perform th

The commands can be executed in two ways:

* Through the shell management subsystem of MCU manager (for example, using the nRF Connect Device Manager mobile application or :ref:`Mcumgr command-line tool <zephyr:mcumgr_cli>`).
* Through the shell management subsystem of MCU manager (for example, using the nRF Connect Device Manager mobile application or :ref:`Mcumgr command-line tool <dfu_tools_mcumgr_cli>`).
* By accessing the :ref:`zephyr:shell_api` module over RTT.

.. _ble_mesh_dfu_distributor_fw_image_upload:
Expand Down

0 comments on commit 3e7049e

Please sign in to comment.