Skip to content

Commit 1e9e632

Browse files
committed
readme: add device configure add-on
1 parent 25171bc commit 1e9e632

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This repository is not a fork of [mender](https://github.com/mendersoftware/mend
2020

2121
Robustness is ensured with *atomic* image-based deployments using a dual A/B partition layout on the MCU. This makes it always possible to roll back to a working state, even when losing power at any time during the update process.
2222

23-
The project currently support firmware upgrade which is the main interest, and inventory key-value pair management. It will also provide in a near future some other Mender features that could make sense on MCU.
23+
The project currently support firmware upgrade which is the main interest, Device Inventory and Device Configure add-ons. It will also provide in a near future some other Mender features that could make sense on MCU.
2424

2525
![Mender logo](https://github.com/mendersoftware/mender/raw/master/mender_logo.png)
2626

@@ -102,6 +102,7 @@ The source code is separate into three main directories:
102102
* `mender-tls`: provide TLS support.
103103
* `add-ons` contains source files of the mender add-ons:
104104
* `mender-inventory`: provide inventory key/value pairs to display inventory data on the mender server. This add-on is highly recommended and should be included by default. It is proposed as an add-on only to give the possibility to reduce the final code size for user who don't need it.
105+
* `mender-configure`: provide configuration key/value pairs to manage devide configuration from the mender server. Build options of this add-on permit to save the configuration in the storage area.
105106

106107
The `include` directory contains the header files that define the prototypes for each module of the library. They are common to all platforms and projects and they define the API to be used or implemented.
107108

@@ -113,16 +114,17 @@ The final code size of the mender-mcu-client library depends of your configurati
113114

114115
| | Code size (-Og) | Code size (-Os) |
115116
|:---------------------|:----------------|:----------------|
116-
| mender-client (core) | 22KB | 20KB |
117-
| mender-inventory | 2KB | 2KB |
117+
| mender-client (core) | 24KB | 21KB |
118+
| mender-inventory | 3KB | 2KB |
119+
| mender-configure | 4KB | 4KB |
118120

119121

120122
## Roadmap
121123

122124
The following features are currently in the pipeline. Please note that I haven't set dates in this roadmap because I develop this in my free time, but you can contribute with Pull Requests:
123125

124126
* Support update of [modules](https://docs.mender.io/artifact-creation/create-a-custom-update-module) to perform other kind of updates that could be specific to one project: files, images, etc.
125-
* Integration of other nice to have Mender APIs as new add-ons: [Device Configure](https://docs.mender.io/api/#device-api-device-configure), [Device Monitor](https://docs.mender.io/api/#devices-api-device-monitor), remote console...
127+
* Integration of other nice to have Mender APIs as new add-ons: [Device Monitor](https://docs.mender.io/api/#devices-api-device-monitor), remote console...
126128
* Support new board and prove it is cross-platform and that it is able to work on small MCU too: STM32F7, ATSAMD51...
127129
* Integration of ATECC608B secure element to perform TLS authentication.
128130
* Support other RTOS (particularly Azure RTOS) and bare metal platforms.

0 commit comments

Comments
 (0)