|
| 1 | +.. _external_module_mender_mcu: |
| 2 | + |
| 3 | +mender-mcu |
| 4 | +########## |
| 5 | + |
| 6 | +Introduction |
| 7 | +************ |
| 8 | + |
| 9 | +`mender-mcu`_ enables robust firmware updates on resource-constrained devices by integrating with Zephyr. It |
| 10 | +implements an Update Module interface, which allows a module to define the specifics of how to handle an update. |
| 11 | +mender-mcu provides a default Update Module that integrates with MCUboot to provide A/B updates. This allows |
| 12 | +microcontroller units (MCUs) to perform atomic, fail-safe OTA updates with automatic rollback on failure, similar |
| 13 | +to Mender's updates for Linux devices. |
| 14 | + |
| 15 | +The client communicates with the Mender server to report device inventory and identity, checks for |
| 16 | +available updates, downloads new firmware, and coordinates with the Update Module to install updates safely. |
| 17 | +Mender server is available as an open-source version licensed under the Apache-2.0 license, and an enterprise |
| 18 | +version licensed under a commercial license, available through commercial plans for on-prem hosting and hosted |
| 19 | +Mender, a fully managed service. |
| 20 | + |
| 21 | +mender-mcu is licensed under the Apache-2.0 license. |
| 22 | + |
| 23 | +Requirements |
| 24 | +************ |
| 25 | + |
| 26 | +* cJSON for JSON parsing |
| 27 | + |
| 28 | +Usage with Zephyr |
| 29 | +***************** |
| 30 | + |
| 31 | +To pull in mender-mcu as a Zephyr :ref:`module <modules>`, either add it as a West project in the ``west.yaml`` |
| 32 | +file or pull it in by adding a submanifest (e.g. ``zephyr/submanifests/mender-mcu.yaml``) file |
| 33 | +with the following content and run ``west update``: |
| 34 | + |
| 35 | +.. code-block:: yaml |
| 36 | +
|
| 37 | + manifest: |
| 38 | + projects: |
| 39 | + - name: mender-mcu |
| 40 | + url: https://github.com/mendersoftware/mender-mcu |
| 41 | + revision: main |
| 42 | + path: modules/mender-mcu # adjust the path as needed |
| 43 | +
|
| 44 | +For more detailed instructions and API documentation, refer to the `mender-mcu documentation`_. |
| 45 | +The `Zephyr reference project`_ provides an example reference integration. |
| 46 | + |
| 47 | +References |
| 48 | +********** |
| 49 | + |
| 50 | +.. target-notes:: |
| 51 | + |
| 52 | +.. _mender-mcu: |
| 53 | + https://github.com/mendersoftware/mender-mcu |
| 54 | + |
| 55 | +.. _mender-mcu documentation: |
| 56 | + https://docs.mender.io/operating-system-updates-zephyr |
| 57 | + |
| 58 | +.. _Zephyr reference project: |
| 59 | + https://github.com/mendersoftware/mender-mcu-integration |
0 commit comments