mender-mcu is a fork of the mender-mcu-client project, created to extend its functionality and provide continued support from Northern.tech, the creators of Mender. This project is currently under construction, with the primary goal of enhancing the original work while integrating it more closely with Northern.tech's suite of products.
This repository is a work in progress. As we continue development, features and functionality may evolve significantly. We are actively working on expanding the capabilities of the original mender-mcu-client to better support a wider range of use cases.
While working on the first release of the project, we consider the main branch to be experimental,
while the stable versions can be found in separate Git branches like vX.Y-alias.
The decision to fork the original mender-mcu-client was made to:
- Extend Functionality: Introduce new features and enhancements that align with the broader Mender ecosystem.
- Provide Official Support: Ensure that the project receives the necessary attention and resources from Northern.tech to meet the needs of the community and enterprise users.
Since the project is under active development, we recommend watching the repository or checking back regularly for updates. Detailed documentation and usage instructions will be provided as the project progresses.
For using mender-mcu for the first time, we strongly recommend you start with our Zephyr reference
application.
It can be found in the repository
mender-mcu-integration. The policy is
that the reference application's main branch will follow the latest stable branch of mender-mcu
(this repository).
In the mender-mcu-repository you will find:
- A reference
westworkspace for Zephyr OS builds, includingCMakeandKConfigconfigurations. - Sample application for how to use
mender-mcuAPIs. - A list of boards that we have so far tested.
We recommend starting there to understand how we have designed our solution and then coming back here for more in-depth information.
The main API is exposed in mender-client.h. The most notable parts are:
-
Identity callback. The user needs to provide a callback that will return the identity. In most cases, this would be reading a unique device number like a MAC address. Read more about Mender identity in Mender Docs.
-
Network connect / Network release callbacks. In systems where the network is not always available, the client will invoke the network connect callback before doing operations that require connectivity (for example, checking for an update). Once network operations are completed, the network release callback will be invoked. They can be set to
NULLif the network is assumed to be always ready. -
Restart callback. To be called to trigger a device reset, for example after a fatal error.
-
Inventory setting. There is an explicit call to set the inventory. This will update the internal inventory of the client and sent to the Mender Server in the next inventory report.
See the source code for more.
Mender MCU models the Update Modules API which we have been using in the regular Mender client for years. Refer to the Update Modules chapter in Mender Docs for an introduction. In Mender MCU, the modules are not "executables" but rather rather a custom C function that is integrated with the client to handle each type of update.
As stated above, an Update Module for Mender MCU is set of customizable C functions. Concretely, once created, all Update Modules are identified by a C struct in mender-zephyr-image-update-module.h. The most important part of the struct is the array of callbacks, one to be called for each state.
See the state machine workflow diagram to learn about the flow between each state. An Update Module does not need to implement all of them, only the ones that are relevant for a particular type of update.
We provide the zephyr-image Update Module, which implements the update process for a Zephyr OS
update integrated with MCUboot. Its source code
can be inspected for inspiration and a better understanding of the expected behavior of each state.
After writing the code, you need to register the Update Module into the Mender MCU. See the register
update module function in mender-client.h.
- CMake
- libcurl
- cJSON
Example for Ubuntu/Debian:
sudo apt install cmake libcurl4-openssl-dev libcjson-dev pkg-config
- Configure the build:
cmake -C cmake/CMake_posix_defaults.txt -B build tests/smoke
- Build the client:
cmake --build build --parallel $(nproc --all)
You can now run and connect the client to e.g. hosted Mender:
export MAC_ADDRESS=<mac_address>
export DEVICE_TYPE=<device_type>
export TENANT_TOKEN=<tenant_token>
export ARTIFACT_NAME=<artifact_name>
./build/mender-mcu-client.elf --mac_address=$MAC_ADDRESS --device_type=$DEVICE_TYPE --tenant_token=$TENANT_TOKEN --artifact_name=$ARTIFACT_NAME
The mac address is an arbitrary identifier. You can use anything as long as it is unique for each device.
The tenant token can be found under My organization in hosted Mender, where it's called Organization token.
Create an artifact (remember to disable compression):
./mender-artifact write module-image -T zephyr-image --compression none --artifact-name <artifact_name> --device-type <device_type> --file <file_name>
The device_type in the artifact has to match the device_type used when running the client.
After creating and uploading the artifact to the server, you should be able to deploy it to the device.
We welcome and ask for your contribution. If you would like to contribute to Mender, please read our guide on how to best get started contributing code or documentation.
Mender is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
The mender-mcu project is a fork from Joel Guittet's
mender-mcu-client licensed under the Apache
License, Version 2.0. See
LICENSE
We take security very seriously. If you come across any issue regarding security, please disclose the information by sending an email to [email protected]. Please do not create a new public issue. We thank you in advance for your cooperation.
- Join the Mender Hub discussion forum
- Follow us on Twitter. Please feel free to tweet us questions.
- Fork us on Github
- Create an issue in the bugtracker
- Email us at [email protected]
- Connect to the #mender IRC channel on Libera