Skip to content

luuuis/hass_wibeee

 
 

Repository files navigation

hacs_badge GitHub release (latest by date) GitHub all releases

Home Assistant: Wibeee (and Mirubee) energy monitor custom component

Wibeee logo

Features

Integrates CIRCUTOR Wibeee/Mirubee energy monitoring devices into Home Assistant. Works with single and three-phase versions.

Sensors

Provides the following sensors, one for each clamp using _L1/_L2/_L3 suffixes.

Sensor Unit Description
wibeee_<mac_addr>_active_energy Wh Active Energy
wibeee_<mac_addr>_active_energy_produced Wh Active Energy Produced
wibeee_<mac_addr>_active_energy_consumed Wh Active Energy Consumed
wibeee_<mac_addr>_active_power W Active Power
wibeee_<mac_addr>_apparent_power VA Apparent Power
wibeee_<mac_addr>_capacitive_reactive_energy VArCh Capacitive Reactive Energy
wibeee_<mac_addr>_capacitive_reactive_power VArC Capacitive Reactive Power
wibeee_<mac_addr>_frequency Hz Frequency
wibeee_<mac_addr>_inductive_reactive_energy VArLh Inductive Reactive Energy
wibeee_<mac_addr>_inductive_reactive_power VArL Inductive Reactive Power
wibeee_<mac_addr>_current A Current
wibeee_<mac_addr>_power_factor PF Power Factor
wibeee_<mac_addr>_phase_voltage V Phase Voltage

In three-phase devices the _L4 sensors contain the total readings across all phases.

Installation

Use HACS (preferred) or follow the manual instructions below.

Installation using HACS

  1. Open Integrations inside the HACS configuration.
  2. Click the + button in the bottom right corner, select Wibeee (and Mirubee) energy monitor and then Install this repository in HACS.
  3. Once installation is complete, restart Home Assistant
Manual installation instructions

Manual installation

  1. Download hass_wibeee.zip from the latest release in https://github.com/luuuis/hass_wibeee/releases/latest
  2. Unzip into <hass_folder>/config/custom_components
    $ unzip hass_wibeee.zip -d <hass_folder>/custom_components/wibeee
  3. Restart Home Assistant

Configuration

Go to the Integrations page, click Add Integration and select the Wibeee integration or click the following button.

Open your Home Assistant instance and start setting up a new integration.

Configuration - Home Assistant 2021-12-29 01-08-21

Enter the device's IP address and the integration will detect the meter's type before adding the relevant sensors to Home Assistant.

Configuration - Home Assistant 2021-12-29 01-09-26

Optionally, configure extra template sensors for grid consumption and feed-in to use with Home Energy Management. See SENSOR_EXAMPLES.md for suggested sensors that will help you get the most out of the integration.

💡 Configuring Local Push (optional, advanced)

Local Push is highly recommended for increased stability and performance. Normally the integration will poll your devices to refresh the sensors but this should not be done too frequently to avoid overloading the device's remote API, which can cause the device to hang. With some extra configuration on the device it is possible to set up Local Push support, meaning that the device will push the sensor data to Home Assistant with high frequency (about every 10 seconds but more or less frequently as necessary).

  1. In the integration's configuration under Cloud service to upload data to select one of the available options that causes the integration to listen on port 8600 for Local Push updates from your Wibeee device.

    • Choose Local only and the integration will listen for local push updates and will store them locally,
    • Choose Wibeee Nest and the integration will listen for local push updates and will send them to Wibeee Nest after storing them locally,
    • and similar for other Cloud services such as Iberdrola and SolarProfit.

    Wibee integration polling interval configuration Wibee integration local push configuration

    The polling interval should be set much higher when Local Push is in use. Updates are sent by the Wibeee device with high frequency so there is no reason for a short polling interval that will overload the device.

  2. Open the device UI and in Advanced Options update the Server section to contain the IP address of your Home Assistant.

    Wibeee Web UI

    Default: Server URL is nest-ingest.wibeee.com and Server Port is 80
    After: Server URL the IP address of your HA instance and Server Port is 8600

    Click Apply to make Wibeee restart, after which it should start pushing data to the Wibeee integration within Home Assistant.

If everything was done correctly sensor data should now update every second in Home Assistant and Wibeee Nest.

Example View in Home Assistant

Wibeee Device view in Home Assistant

Active Power graph in Home Assistant