Skip to content

Shared docs: update description of Release vs. Development builds #108

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

Merged
barsnick merged 2 commits into from
Jun 4, 2026
Merged

Shared docs: update description of Release vs. Development builds #108

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11fa578
Firmware: modify image type description
barsnick Jun 3, 2026
8a051b3
Firmware: drop rauc signing key section
barsnick Jun 3, 2026
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
41 changes: 11 additions & 30 deletions firmware_upgrade.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,36 +47,17 @@ Release Images vs Development Images

There are two types of firmware images available for chargebyte devices:

- Release images: These images are tested and verified by chargebyte and are recommended for
production use. The image size is optimized for production use and contains only the necessary
components.
- Development images: These images are used for development purposes and are not tested or verified
by chargebyte. They are intended for developers who want to implement and test new features or
applications before they are released. The image size is larger than the release image and
contains additional development tools and libraries that are not necessary for production use.

.. note::
Before installation of a chargebyte EVerest image, please check whether you are installing a
developer or release image. In order to update the firmware with a chargebyte EVerest developer
image, the developer key must be set in the :code:`"/etc/rauc"` directory to pass the internal
validation process of the RAUC firmware update mechanism. The image type can be identified by the
file name.
Copy link
Copy Markdown
Member

@lategoodbye lategoodbye Jun 3, 2026

Choose a reason for hiding this comment

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

Please keep this section for the rare cases of Truffle to EVerest migration.

Copy link
Copy Markdown
Contributor

@FaHaGit FaHaGit Jun 3, 2026

Choose a reason for hiding this comment

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

You're right; that's important hint if you're updating from the legacy Truffle stack. However, EVerest uses the developer key for both image types (release and developer). Therefore, the text should be updated accordingly so that customers don't mistakenly reconfigure the key when using the EVerest release image.

Copy link
Copy Markdown
Contributor

@FaHaGit FaHaGit Jun 3, 2026

Choose a reason for hiding this comment

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

Maybe this note should be directly described in section "Updating from chargebyte’s proprietary charging stack to EVerest-based charging stack"

Copy link
Copy Markdown
Contributor Author

@barsnick barsnick Jun 3, 2026

Choose a reason for hiding this comment

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

I agree with Fabian. This only ever applies to Charge Control C, as the other platforms never had a legacy stack, and EVerest builds always (for the time being) use the development signing key.

I propose to keep this change, and modify CCC in #109.

Copy link
Copy Markdown
Member

@lategoodbye lategoodbye Jun 3, 2026

Choose a reason for hiding this comment

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

I'm fine with the suggestion


Depending on the image type, the key must be adapted as follows:

Change to developer key:

.. code-block:: bash

cd /etc/rauc
ln -sf i2se-devel.crt keyring.pem

Change to release key:

.. code-block:: bash

cd /etc/rauc
ln -sf i2se-release.crt keyring.pem
- **Release images** are optimized for deployment and contain only the components required to run
the system. Their smaller size reduces download and installation times and leaves more storage
space available on the target device for customer-specific applications, services, and data.
These images are tested and verified by chargebyte and are recommended as the basis for deployed
systems.

- **Development images** contain the same runtime environment as release images, but additionally
include development packages such as libraries and header files. They are intended primarily for
development workflows that use the target filesystem as a sysroot for cross-compilation and for
building customized software components. Because of the additional development content, these
images are significantly larger than release images.

Device Access
-------------
Expand Down