Introduction
With the HomeWizard Energy platform, you can gain insights into your energy usage. Use the HomeWizard P1 Meter to access real-time data directly from your smart meter, the HomeWizard Energy Socket to get energy insights from all your devices, the HomeWizard kWh Meter to measure devices such as solar panels, and the HomeWizard Water Meter to gain insights into your water usage. With the open API, you can integrate the data directly into your system of choice.
HomeWizard Energy API
The HomeWizard P1 Meter, Energy Socket, kWh Meter, Watermeter, and Plug-In Battery (referred to as "device") each have a local API that allows you to retrieve the latest measurements or control the device. You can access this API as long as you are connected to the same Wi-Fi network as the device and the API is enabled in the HomeWizard Energy app. This API is designed for integrating your device with personal automation, home automation, or data graphing systems. It is not possible to retrieve historical data through the local API, as this data is not stored on the device itself.
Terms and Conditions
- License - The HomeWizard Energy API is licensed, not sold. HomeWizard grants the user a non-exclusive license (with no right to sub-license) to the HomeWizard Energy API for personal, non-commercial use.
- Usage - The user may not directly or indirectly use the HomeWizard Energy API to sell, lease, loan or generate a revenue from a product, system or software using the API
- Support - The usage of the HomeWizard Energy API is officially supported by HomeWizard, however HomeWizard can not supply customer service regarding the implementation of the API in your own or third party applications.
API v2
The HomeWizard Energy API is moving to v2, which is a more secure and feature-rich version of the API. In v2 of the API, we have added the following 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.
Read more about the new version of the API here.
First Steps
To understand the basics of the API, you can read the getting-started guide and explore v1 or v2 to learn about all the available features.
Devices and API Versions
The following table shows which devices are supported by the API and which API version they support.
| Device | Device type | API v1 | API v2 |
|---|---|---|---|
| P1 Meter | HWE-P1 | Supported | Requires Firmware 6.00 In beta |
| Energy Socket | HWE-SKT | Supported | In development |
| Watermeter (Only when powered over USB) | HWE-WTR | Supported | In development |
| kWh Meter (1 phase) | HWE-KWH1 and SDM230-wifi | Supported | In development |
| kWh Meter (3 phase) | HWE-KWH3 and SDM630-wifi | Supported | In development |
| Energy Display | HWE-DSP | Not planned | In development |
| Plug-In Battery | HWE-BAT | Not planned | Supported |
The v2 API is available for P1 Meter devices with firmware version 6.00 and higher. This version is currently only available for owners of the Plug-In Battery.
Beta Program
You can help test the new firmware by joining the beta program. This allows you to try out and test the latest features and improvements before they are released to the public. You can also provide feedback and report any issues you encounter during testing. This helps us improve the firmware and make it more stable for all users.
If you are interested, read more about the beta program here.
We are Hiring
Do you like technology, sustainability, and working in a team? We are looking for enthusiastic cloud engineers, embedded hardware and/or software engineers, marketers, community managers, support staff, graduates, and interns to strengthen our Energy team! We would like to welcome you to our fast-growing company in Noordwijk (Leiden region). Sounds fun? Send us an email with your CV and motivation at jobs@homewizard.com or start a conversation with one of the developers on LinkedIn.