Skip to content

Add documentation about firmware versioning scheme #220

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
DCSBL merged 1 commit into from
Dec 4, 2025
Merged

Add documentation about firmware versioning scheme #220

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
1 change: 1 addition & 0 deletions .cspell.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ words:
- aiohttp # Known library
- asyncio # Known library
- cafile # Known term in python
- x.yyzz # Version number
21 changes: 21 additions & 0 deletions docs/versioning.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,24 @@ X-Api-Version: 3.0.1

{"error": "request:api-version-not-supported"}
```

## Firmware Versions
Copy link

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

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

The heading should end with a period to match the existing documentation convention. Throughout this file, all major headings (##) end with periods (e.g., "## Version Scheme.", "## Requesting a Specific API Version."). Should be ## Firmware Versions.

Suggested change
## Firmware Versions
## Firmware Versions.

Copilot uses AI. Check for mistakes.

Firmware versions for HomeWizard products follow one of these formats: `x.yy` or `x.yyzz`.

- `x` is the **major** version
- `y` is the **minor** version
- `z` is the **patch** version (optional)
Comment on lines +110 to +111
Copy link

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

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

The description is ambiguous about digit representation. The format x.yyzz uses two digits for minor (yy) and two digits for patch (zz), but the bullet list suggests y and z are single entities. Consider clarifying: "In the x.yyzz format, the minor version uses two digits and the patch version uses two digits" or revising the format notation to use subscripts or clearer notation.

Suggested change
- `y` is the **minor** version
- `z` is the **patch** version (optional)
- `yy` is the **minor** version (two digits)
- `zz` is the **patch** version (optional, two digits)

Copilot uses AI. Check for mistakes.

For example:

- `1.23` → major version 1, minor version 23
- `2.1501` → major version 2, minor version 15, patch version 01

### Release Notes

You can find firmware release notes and discussions in the [Beta Discussions](https://github.com/homewizard/beta/discussions?discussions_q=) on GitHub.

### Checking for the Latest Firmware

To check if you have the latest firmware version on your HomeWizard product, follow the guide: [How do I check if I have the latest software on my HomeWizard product?](https://helpdesk.homewizard.com/en/articles/9167578-how-do-i-check-if-i-have-the-latest-software-on-my-homewizard-product?)
Loading