Releases: homewizard/api-documentation
2025.05.01
API 2.1.0 has been made available via the beta-program. This version adds support for the control API for the Plug-In Battery via a P1 Meter. Read more about this in the documentation and the beta announcement.
What's Changed
- Add refer to beta-program by @DCSBL in #182
- Add documentation about battery control API by @DCSBL in #183
Full Changelog: 2025.01.31...2025.05.01
Contributors
Assets 2
2025.01.31
The API has been bumped to 2.0.1. This API is specific to the Plug-In Battery, which had an issue that energy_import_kwh and energy_export_kwh where invalid.
Thanks to @Devke (Tweakers) for noticing this.
What's Changed
- Remove deprecation policy by @DCSBL in #161
- Adjust getting started guide to be more generic by @DCSBL in #162
- Add changelog for API 2.0.1 by @DCSBL in #163
Full Changelog: 2025.01.21...2025.01.31
2025.01.21
Summary
With this release, we mark the v2 API as "released." This means that version 2.0.0 is now fixed, and from now on, only bug fixes or non-breaking changes will be introduced. If we introduce a breaking change, it will be released as version 3.x.x. You can use the v2 API for production-ready releases.
While v2 support is not available for all devices, we won't start the deprecation period yet. However, we recommend using the v2 API for new designs, as the v1 API will eventually be removed.
What's Changed
- Fix typo in reboot description by @fvdm in #145
- Battery has no support for /api/telegram by @DCSBL in #146
- Set HWE-BAT as supported in v2, in v1 documentation by @DCSBL in #147
- Fix system endpoint cURL examples by @andrea-hw in #151
- Fix curl example for identify endpoint by @andrea-hw in #150
- Improve beta-indication of v2 support in P1 by @DCSBL in #152
- Fix cURL command for disabling v1 API by @andrea-hw in #154
- Update status code for v1 API disabled by @andrea-hw in #153
- Use correct example for authorization_requested by @DCSBL in #155
- Remove beta-label for v2 API by @DCSBL in #156
- Include API releases in changelog by @DCSBL in #157
- Drop wi-fi from brand names by @DCSBL in #158
- Add Plug-In Battery to introduction text by @DCSBL in #159
Dependencies
New Contributors
- @fvdm made their first contribution in #145
- @andrea-hw made their first contribution in #151
Full Changelog: 2025.01.07...2025.01.21
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
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
