Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: releases: hawkbit: add infos about changes #83788

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: releases: hawkbit: add infos about changes #83788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/releases/migration-guide-4.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,10 @@ Flash map
hawkBit
=======

* 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.

MCUmgr
======

Expand Down
25 changes: 25 additions & 0 deletions doc/releases/release-notes-4.1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,31 @@ Libraries / Subsystems

* Management

* hawkBit

* 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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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.
Comment on lines +355 to +376
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


* Logging

* Modem modules
Expand Down
Loading