Skip to content

Releases: homewizard/api-documentation

2025.12.04

04 Dec 13:17
2d601c5

Choose a tag to compare

We’ve released API Version 2.2.0 via the beta update of the P1 Meter. This version introduces support for permissions in the api/batteries API. This allows you to control whether your batteries can charge or discharge. Additionally, you can now retrieve the number of connected batteries using the battery_count parameter in this endpoint.

What's Changed

  • Add documentation about firmware versioning scheme by @DCSBL in #220
  • Update documentation for API 2.2.0 by @DCSBL in #219

Full Changelog: 2025.10.09...2025.12.04

2025.10.09

09 Oct 10:55
01cd677

Choose a tag to compare

P1 Meter firmware 6 is now available for all P1 Meters. This firmware will be gradually installed to all devices, making API v2 available for all P1 Meters. Users can install this version manually via the HomeWizard Energy app.

The references to version 6 being only available for users with a plug-in battery are removed from the documentation.

What's Changed

  • Fix header formatting in introduction.mdx by @DCSBL in #206
  • Remove references of P1 Meter 6.00xx being in beta by @DCSBL in #212

Full Changelog: 2025.09.15...2025.10.09

2025.09.15

15 Sep 09:20
35054bc

Choose a tag to compare

With the public release of kWh Meter 5.0011, API 2.1.0 is now 'Supported' and out of beta. Besides this the documentation has been restyled to match new HomeWizard identity.

What's Changed

New Contributors

Full Changelog: 2025.05.01...2025.09.15

2025.05.01

01 May 11:38
e3ffa63

Choose a tag to compare

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

2025.01.31

31 Jan 09:26
c3f8d87

Choose a tag to compare

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

21 Jan 12:28
5870cae

Choose a tag to compare

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

Full Changelog: 2025.01.07...2025.01.21

2025.01.07

07 Jan 10:21
a10dd18

Choose a tag to compare

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

12 Nov 10:38
033bff9

Choose a tag to compare

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

26 Mar 08:46
ce84caf

Choose a tag to compare

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

19 Mar 10:24
2fe06cc

Choose a tag to compare

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

Full Changelog: 2024.03.12...2024.03.19