doc: releases: hawkbit: add infos about changes #83788
Open
+29
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
add infos about changes and improvements in the hawkbit subsystem. Signed-off-by: Fin Maaß <[email protected]>
fabiobaltieri
approved these changes
Jan 10, 2025
kartben
requested changes
Jan 14, 2025
| :kconfig:option:`CONFIG_SMF_ANCESTOR_SUPPORT` are now required to be enabled to use the | ||
| hawkBit subsystem. | ||
|
|
||
| * The hawkBit subsystem now uses supports hawkBit instances, that run as a multi tenant system |
There was a problem hiding this comment.
Suggested change
| * The hawkBit subsystem now uses supports hawkBit instances, that run as a multi tenant system | |
| * The hawkBit subsystem now supports hawkBit instances, that run as a multi tenant system |
Comment on lines
+355
to
+376
| * The hawkBit subsystem now uses the State Machine Framework internally. | ||
| The Kconfig symbols :kconfig:option:`CONFIG_SMF` and | ||
| :kconfig:option:`CONFIG_SMF_ANCESTOR_SUPPORT` are now required to be enabled to use the | ||
| hawkBit subsystem. | ||
|
|
||
| * The hawkBit subsystem now uses supports hawkBit instances, that run as a multi tenant system | ||
| and require the tenant to be configurable and don't use the default tenant ``default``. This | ||
| enables the use of some solutions, that require this. The Kconfig symbol | ||
| :kconfig:option:`CONFIG_HAWKBIT_TENANT` can be used to set the tenant name. | ||
|
|
||
| * The hawkBit subsystem now supports callbacks on specific events. The Kconfig symbol | ||
| :kconfig:option:`CONFIG_HAWKBIT_EVENT_CALLBACKS` can be used to enable this feature. | ||
| See .. doxygengroup:: hawkbit__event for more information or check out the source code of | ||
| :zephyr:code-sample:`hawkbit-api` for more information. | ||
|
|
||
| * The hawkBit subsystem now supports the save and restore of the download progress. When | ||
| enabled, the download progress is periodically saved to non-volatile storage. If a download | ||
| is interrupted, it can be resumed from the last saved point rather than starting over, | ||
| saving bandwidth and time. The Kconfig symbol :kconfig:option:`CONFIG_HAWKBIT_SAVE_PROGRESS` | ||
| can be used to enable this feature. | ||
| Use :kconfig:option:`CONFIG_HAWKBIT_SAVE_PROGRESS_INTERVAL` to set the interval in percent | ||
| when the progress is saved. |
There was a problem hiding this comment.
I think this is too verbose for release notes -- why don't you make this part of the hawkbit docs instead, so that it "sticks" more. Those 4 pretty large paragraphs should be pretty much one sentence each instead, linking to relevant sections of the documentation
* Adopted the State Machine Framework internally to improve maintainability and extensibility (or just drop the "improviing..." part if it's too cheesy / unnecessary)
* Added support for multi-tenancy.
* Added support for registering callbacks on specific events
* Added support for storing partially downloaded update packages to non-volatile storage and resuming from the last save point.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add infos about changes and improvements
in the hawkbit subsystem.