|
| 1 | +.. _mgmt: |
| 2 | + |
| 3 | +Management Subsystem |
| 4 | +#################### |
| 5 | + |
| 6 | +Overview |
| 7 | +******** |
| 8 | + |
| 9 | +The management subsystem allows remote management of Zephyr-enabled devices. |
| 10 | +The following management operations are available: |
| 11 | + |
| 12 | +* Image management |
| 13 | +* File System management |
| 14 | +* Log management (currently disabled) |
| 15 | +* OS management |
| 16 | + |
| 17 | +over the following transports: |
| 18 | + |
| 19 | +* BLE (Bluetooth Low Energy) |
| 20 | +* Serial (UART) |
| 21 | + |
| 22 | +The management subsystem is based on the Simple Management Protocol (SMP) |
| 23 | +provided by `MCUmgr`_, an open source project that provides a |
| 24 | +management subystem that is portable across multiple real-time operating |
| 25 | +systems. |
| 26 | + |
| 27 | +The management subsystem is split in two different locations in the Zephyr tree: |
| 28 | + |
| 29 | +* :file:`ext/lib/mgmt/mcumgr/` contains a clean import of the MCUmgr project |
| 30 | +* :file:`subsys/mgmt/` contains the Zephyr-specific bindings to MCUmgr |
| 31 | + |
| 32 | +Additionally there is a :ref:`sample <smp_svr_sample>` that provides management |
| 33 | +functionality over BLE and serial. |
| 34 | + |
| 35 | +.. _mcumgr_cli: |
| 36 | + |
| 37 | +Command-line Tool |
| 38 | +***************** |
| 39 | + |
| 40 | +MCUmgr provides a command-line tool, :file:`mcumgr`,for managing remote devices. |
| 41 | +The tool is written in the Go programming language. |
| 42 | + |
| 43 | +Installation information can be found in the `MCUmgr command-line tool`_ |
| 44 | +section of the `MCUmgr documentation`_. A full rundown of the necessary commands |
| 45 | +to perform Device Firmware Upgrade is located in |
| 46 | +`MCUmgr command-line tool examples`_, and a practical step-by-step guide to DFU |
| 47 | +using MCUmgr can be found in :ref:`smp_svr_sample`. |
| 48 | + |
| 49 | +Bootloader integration |
| 50 | +********************** |
| 51 | + |
| 52 | +The :ref:`dfu` subsystem integrates the management subsystem with the |
| 53 | +bootloader, providing the ability to send and upgrade a Zephyr image to a |
| 54 | +device. |
| 55 | + |
| 56 | +Currently only the MCUboot bootloader is supported. See :ref:`mcuboot` for more |
| 57 | +information. |
| 58 | + |
| 59 | +.. _MCUmgr: https://github.com/apache/mynewt-mcumgr |
| 60 | +.. _MCUmgr documentation: https://github.com/apache/mynewt-mcumgr#mcumgr |
| 61 | +.. _MCUmgr command-line tool: https://github.com/apache/mynewt-mcumgr#command-line-tool |
| 62 | +.. _MCUmgr command-line tool examples: https://github.com/apache/mynewt-mcumgr-cli#examples |
0 commit comments