diff --git a/.cspell.yml b/.cspell.yml index 23eaa06..e8a36af 100644 --- a/.cspell.yml +++ b/.cspell.yml @@ -24,3 +24,4 @@ words: - aiohttp # Known library - asyncio # Known library - cafile # Known term in python + - x.yyzz # Version number diff --git a/docs/versioning.mdx b/docs/versioning.mdx index 972b9ff..629f6bd 100644 --- a/docs/versioning.mdx +++ b/docs/versioning.mdx @@ -101,3 +101,24 @@ X-Api-Version: 3.0.1 {"error": "request:api-version-not-supported"} ``` + +## Firmware Versions + +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) + +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?)