Skip to content

Commit 639d878

Browse files
doc: develop: manifests: external: add mender-mcu
Introduce documentation for using mender-mcu as an external module in Zephyr. Signed-off-by: Daniel Skinstad Drabitzius <[email protected]>
1 parent 4a69c1b commit 639d878

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
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+
18+
mender-mcu is licensed under the Apache-2.0 license.
19+
20+
Requirements
21+
************
22+
23+
* cJSON for JSON parsing
24+
25+
Usage with Zephyr
26+
*****************
27+
28+
To pull in mender-mcu as a Zephyr :ref:`module <modules>`, either add it as a West project in the ``west.yaml``
29+
file or pull it in by adding a submanifest (e.g. ``zephyr/submanifests/mender-mcu.yaml``) file
30+
with the following content and run ``west update``:
31+
32+
.. code-block:: yaml
33+
34+
manifest:
35+
projects:
36+
- name: mender-mcu
37+
url: https://github.com/mendersoftware/mender-mcu
38+
revision: main
39+
path: modules/mender-mcu # adjust the path as needed
40+
41+
For more detailed instructions and API documentation, refer to the `mender-mcu documentation`_.
42+
The `Zephyr reference project`_ provides an example reference integration.
43+
44+
References
45+
**********
46+
47+
.. target-notes::
48+
49+
.. _mender-mcu:
50+
https://github.com/mendersoftware/mender-mcu
51+
52+
.. _mender-mcu documentation:
53+
https://docs.mender.io/operating-system-updates-zephyr
54+
55+
.. _Zephyr reference project:
56+
https://github.com/mendersoftware/mender-mcu-integration
57+

0 commit comments

Comments
 (0)