Releases: homewizard/api-documentation
2025.01.07
Summary
The documentation for the HomeWizard Plug-In Battery has been published! This API uses the new v2 API and is available as soon the Battery is in your house. With this API, you can gain insights into the battery's energy characteristics, check the current state of charge, and view the number of cycles.
Tip
At this moment, it is not possible to control the battery's behavior. We are working on a firmware update to enable this functionality.
What's Changed
- Added HomeWizard Plug-In Battery API description @DCSBL in #143
- Add description for v2 error handling by @DCSBL in #128
- Mark optional parameters actually as optional by @DCSBL in #142
Full Changelog: 2024.11.12...2025.01.07
Contributors
Assets 2
2024.11.12
Summary
The preliminary documentation of the new v2 API has been published! This API adds has the following new features:
- HTTPS - Your data is securely transmitted.
- Always available - No need to turn on the API in the app.
- Authorization - Only the devices you trust can access the API.
- WebSocket support - Get real-time push based updates.
Warning
The HomeWizard Energy API v2 and its documentation are in beta and subject to change.
Use this form to request access to the beta firmware containing the v2 API.
What's Changed
- Add local API v2 documentation #120
Full Changelog: 2024.03.26...2024.11.12
2024.03.26
Summary
We have released the latest Watermeter and Energy Socket firmware to general public. Please read 2024.03.19 and 2024.03.12 to learn what is new.
What's Changed
- Remove beta-labels from firmware by @DCSBL in #76
- Add latest firmwares version to versioning by @DCSBL in #77
Full Changelog: 2024.03.19...2024.03.26
2024.03.19
Summary
The features 'Identity' and 'system' are now available in the newest firmware version. This version is currently in beta and is tested by a small group of users. The firmware will be released to all users when the beta phase is completed.
What's Changed
- Add support for 'identify' and 'system' for HWE-WTR by @DCSBL in #72
- Adjust headers and model numbers to make style more consistent by @DCSBL in #73
Dependencies
- Bump follow-redirects from 1.15.5 to 1.15.6 by @dependabot in #71
Full Changelog: 2024.03.12...2024.03.19
2024.03.12
Summary
We have released an updated version of the Energy Socket. With this release new we also release new firmware that exposes more measurements. See the updated documentation.
What's Changed
- Set correct name for TXT record
product_typeby @DCSBL in #46 - Add documentation about new Energy Socket and its datapoints by @DCSBL in #67
- Remove hard-coded changelog and reference to GitHub Releases by @DCSBL in #68
Other changes
- Remove duplicate header by @DCSBL in #59
- Adjust documentation to use correct name for 'kWh' by @DCSBL in #61
- Fix typo by @DCSBL in #62
- Remove reference to older firmware version for HWE-KWH by @DCSBL in #66
Dependencies
- Bump clsx from 2.0.0 to 2.1.0 by @dependabot in #51
- Bump @docusaurus/types from 3.1.0 to 3.1.1 by @dependabot in #49
- Bump eslint from 8.53.0 to 8.56.0 by @dependabot in #48
- Bump @typescript-eslint/parser from 6.11.0 to 6.20.0 by @dependabot in #50
- Bump @docusaurus/module-type-aliases from 3.1.0 to 3.1.1 by @dependabot in #47
- Bump @typescript-eslint/parser from 6.11.0 to 6.21.0 by @dependabot in #52
- Add github-actions as dependabot ecosystem by @DCSBL in #53
- Bump prettier from 3.1.0 to 3.2.5 by @dependabot in #54
- Bump @typescript-eslint/eslint-plugin from 6.0.0 to 6.21.0 by @dependabot in #57
- Bump @typescript-eslint/eslint-plugin from 6.21.0 to 7.0.0 by @dependabot in #64
- Bump @mdx-js/react from 3.0.0 to 3.0.1 by @dependabot in #63
- Bump eslint from 8.56.0 to 8.57.0 by @dependabot in #65
- Bumb @Docusaurus to 3.1.1 by @DCSBL in #69
Full Changelog: 2024.01.30...2024.03.12
2024.01.30
What's Changed
- Add documentation about new kWh Meter model by @DCSBL in #43
- New kWh firmware is now available by @DCSBL in #44
Full Changelog: 2024.01.19...2024.01.30
2024.01.19
What's Changed
Other less-important changes
- Enable "edit" references to allow edits via GitHub by @DCSBL in #15
- Refer to GitHub Subscriptions in changelog by @DCSBL in #17
- Add search by Algolia by @DCSBL in #21
- Add WWHA reference and extra info on the main-page by @DCSBL in #27
- Bumb docusaurus to 3.1.0 by @DCSBL in #34
New Contributors
- @DCSBL made their first contribution in #1
- @bverhoeven made their first contribution in #8
- @dependabot made their first contribution in #28
Full Changelog: 2023.11.15...2024.01.19
Contributors
Assets 2
2023.11.15
Documentation has been re-written in Markdown and is now generated by Docusaurus. This helps us to further optimize the documentation and allows you easily suggest changes.
2023.01.24
SDM230-wifi and SDM630-wifi now support api/v1/system.The Energy meter should run version 3.00 or later, the device will be updated automatically.
This release was created before using GitHub Releases, metadata like date and commit can be invalid.
2023.01.03
- HWE-P1 has now support for
api/v1/systemandapi/v1/identify.The P1 meter should run version 4.00 or later, the device will be updated automatically. - Added documentation about updated
api/v1/dataendpoint. This adds support for more data points in HWE-P1
This release was created before using GitHub Releases, metadata like date and commit can be invalid.