HW Hooks

hw-hooks previously known as hw2energyid is small tool that triggers webhooks based on data gathered from HomeWizard devices to synchronize your data with your EnergyID dashboard. Since HomeWizard devices API are only available within your local network, using an EnergyID App to synchronize the data is not possible.
hw-hooks helps bridge the gap by reading the data from your local network and sending them to EnergyID.

Prerequisites

EnergyID

Important

hw-hooks no longer supports the legacy EnergyID webhook (URL + key). It now uses EnergyID's current incoming webhook, which is claimed interactively on first run. The legacy webhook is being sunset by EnergyID on 30 September 2026.

There is nothing to install on the EnergyID website, but you need provisioning credentials before the first run:

1. Open https://app.energyid.eu/integrations/webhook-in.
2. In the Provisioning credentials box, click the + button in the top right corner.
3. Copy the generated key and secret and pass them to hw-hooks as --provisioning-key and --provisioning-secret (see Usage below).

Note

These two options are only needed on the first run. hw-hooks stores them in config/config.json and reuses them on subsequent runs.

On that first run, hw-hooks links the device to one of your records:

1. hw-hooks prints a claim URL and a claim code in the console.
2. Open the URL, select the record you want to link the device to (e.g.: Home), and enter the claim code.
3. hw-hooks keeps polling until the device is claimed, then starts sending data.

Node

To run the tool, you will also need to have NodeJS installed

Usage

You can either run the tool in the console using the NPM script or use the Docker image.

NPM Script

Open a terminal/console and run the following script:

npx hw-hooks --meter=<meter host or ip> --provisioning-key=<key> --provisioning-secret=<secret>

After the first run, the credentials are stored in config/config.json and only --meter is required:

npx hw-hooks --meter=<meter host or ip> <options>

The device id/name/firmware version are read from the meter and are, together with the claimed connection info, persisted to config/config.json so they're reused on subsequent runs.

Options

Option	Alias	Optional	Description
--meter	-m -p --p1	No	The name or IP address of the Homewizard meter
--provisioning-key	-k	Yes*	EnergyID provisioning key (required on first run, stored in config afterwards)
--provisioning-secret	-s	Yes*	EnergyID provisioning secret (required on first run, stored in config afterwards)
--offset	-o	Yes	Add an offset to the meter's value (to compensate for consumption before installation)
--dry-run	-d	Yes	Dry run. No data will be sent to EnergyID
--recurring	-r	Yes	Read the meter every 5 minutes and send following EnergyID's upload interval
--log-level	-l	Yes	Minimum level: trace, debug, info, warn, error, fatal, or silent (default: info)
--help	-h	Yes	Show help
--version	-v	Yes	Show version number

* Required unless already stored in config/config.json from a previous run.

Docker

First, you need to retreive the IP address of your Homewizard meter.

Note

The hostname is formatted as -<last 6 characters of serial>, so devices with serial AABBCCDDEEFF the hostname is as following:

Device	Example hostname
P1 meter	p1meter-DDEEFF
Energy Socket	energysocket-DDEEFF
Watermeter	watermeter-DDEEFF
kWh meter (single phase)	kwhmeter-DDEEFF
kWh meter (three phase)	kwhmeter-DDEEFF

Open a terminal/console and run the following script:

ping <product-name>-<last 6 charachter of serial>

Create a docker compose file with the following content:

version: '3'

services:
  hw-hooks:
    image: ghcr.io/th3s4mur41/hw-hooks
    environment:
      - meter=<the IP address of the Meter device>
    # Only needed until the device is claimed, they are stored in config/config.json afterwards
    secrets:
      - provisioning_key
      - provisioning_secret
    volumes:
      - ./config:/app/config
      - ./logs:/app/logs
    network_mode: host
    dns:
      - 1.1.1.1

secrets:
  provisioning_key:
    file: ./secrets/provisioning_key
  provisioning_secret:
    file: ./secrets/provisioning_secret

Create the two secret files next to the compose file, each containing only the corresponding value:

mkdir -p secrets
printf '%s' '<your EnergyID provisioning key>' > secrets/provisioning_key
printf '%s' '<your EnergyID provisioning secret>' > secrets/provisioning_secret

Note

The dns section is required to resolve the EnergyID webhook URL. If you are using a different DNS server, replace

Important

Mount ./config:/app/config so the provisioning credentials and claimed connection info survive restarts (otherwise the device has to be re-claimed on every restart). This also lets you edit config/energyid-mapping.json to customize which meter fields are sent to EnergyID. Mount ./logs:/app/logs to retain logs across container recreation.

On first start, watch the container logs (docker compose logs -f) for the claim URL and code, as described in Prerequisites.

Environment Variable	Optional	Description
meter	No	The IP address of the Homewizard meter
provisioning_key	Yes*	EnergyID provisioning key, prefer the provisioning_key Docker secret
provisioning_secret	Yes*	EnergyID provisioning secret, prefer the provisioning_secret Docker secret
LOG_LEVEL	Yes	Minimum log level when --log-level is not supplied (default: info)
LOG_FILE_ENABLED	Yes	Write rotating daily files to /app/logs (default: true in Docker)

* Required unless already stored in the mounted config/config.json from a previous run.

Logs are written as JSON to the container output and, by default in Docker, to /app/logs/hw-hooks.log. File logs rotate daily, are compressed after rotation, and retain the most recent seven files.

Examples

Note
hw-hooks currently only supports synchronizing electricity and water readings

P1 Meter

The HomeWizard P1 Meter connects into the P1 port on your smart meter and shows your electricity and gas usage.

The P1 meter can be discoverd on your network using Multicast DNS (mDNS).
The name of the device is 'hw-p1meter-' followed by the last six charachters of its serial number.

Note
To find the serial number, open your HomeWizard Energy App.
Then go to Settings > Meters > P1 meter

Now that you have all the data you need. Open a terminal/console and run the following script:

npx hw-hooks --meter=hw-p1meter-<last 6 charachter of serial>

E.g.: The command with your data should look similar to this:

npx hw-hooks --meter=hw-p1meter-65d8c7

Water Meter

The HomeWizard Water Meter reads your analog water meter.

The Water meter can be discoverd on your network using Multicast DNS (mDNS).
The name of the device is 'watermeter-' followed by the last six charachters of its serial number.

Now that you have all the data you need. Open a terminal/console and run the following script:

npx hw-hooks --meter=watermeter-<last 6 charachter of serial>

E.g.: The command with your data should look similar to this:

npx hw-hooks --meter=watermeter-65d8c7 --offset=22.334

Links

homewizard dicovery docs
EnergyID Webhook Docs