Skip to main content

Getting Started

Connect your device to Wi-Fi​

Connect your device to Wi-Fi with the HomeWizard Energy app. Make sure to connect your energy device with the same network as the device that makes use of the API.

Enabling the API​

To access the data from an Energy device, you have to enable the API. You can do this in the HomeWizard Energy app. Go to Settings > Meters > Your meter, and turn on Local API.

Getting the data​

After enabling the API, you can try to read some data from your device.

  • Find the IP address of your meter. You can find this in your router or do this programmatically with mDNS.
  • In your internet browser, open http://{IP_ADDRESS}/api/v1/data.
  • If everything is set up correctly, you should now see some text. This is the most recent measurement formatted as JSON. You can use a tool such as JSON Parser Online to get a structured version of the result.

To understand each value, please read endpoints.

Supported devices​

The supported devices are listed below. The device type is used as identifier within the API.

DeviceDevice type
Wi-Fi P1 meterHWE-P1
Wi-Fi Energy SocketHWE-SKT
Wi-Fi Watermeter (Only when powered over USB)HWE-WTR
Wi-Fi kWh Meter (1 phase)HWE-KWH1 and SDM230-wifi
Wi-Fi kWh Meter (3 phase)HWE-KWH3 and SDM630-wifi

Data update frequency​

The API always returns the most recent data. The update frequency depends on the device and, in case of the HWE-P1, the smart meter that it is connected to. With a SMR 5.0 meter, this is every second for power and every 5 minutes for gas. If the smart meter version is lower than SMR 5.0, this is every 10 seconds for power and every 60 minutes for gas. You can find the SMR version of your smart meter on the smart meter itself or via the Recent measurement endpoint. There is no limit to the time between each request on the local API, however, we advise not to retrieve data more often than every 500ms.