Skip to content

Fix documentation #364

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
b-rowan merged 2 commits into from
Sep 8, 2025
Merged

Fix documentation #364

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a04eca5
Replace RAUC-related URLs in README
easybe Sep 8, 2025
27908d5
Replace hw_model with hw_boardname in README
easybe Sep 8, 2025
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ The software packages managed by gooseBit are either stored on the local filesys

## Assumptions

- Devices use [SWUpdate](https://swupdate.org) or [RAUC](https://github.com/rauc/rauc) + [RAUC hawkBit Updater](https://github.com/rauc/rauc-hawkbit-updater) for managing software updates.
- Devices send certain attributes (`sw_version`, `hw_model`, `hw_revision`).
- Devices use [SWUpdate](https://swupdate.org) or [RAUC](https://rauc.io) + [RAUC hawkBit Updater](https://rauc-hawkbit-updater.readthedocs.io) for managing software updates.
- Devices send certain attributes (`sw_version`, `hw_boardname`, `hw_revision`).
- Semantic versions are used.
- With RAUC and multiple hardware revisions, `compatible` in `manifest.raucm` is set to something like `my-board-rev4.2` or `Some Board 2b`.

Expand All @@ -74,7 +74,7 @@ The software packages managed by gooseBit are either stored on the local filesys

When a device connects to gooseBit for the first time, it is automatically added to the device registry. The server will then request the device's configuration data, including:

- `hw_model` and `hw_revision`: Used to match compatible software.
- `hw_boardname` and `hw_revision`: Used to match compatible software.
- `sw_version`: Indicates the currently installed software version.

The registry tracks each device's status, including the last online timestamp, installed software version, update state, and more.
Expand Down
Loading