pywibeee 0.1.7

Installation

Install from PyPI (dependencies are installed automatically):

pip install pywibeee --upgrade

Or install the latest source:

pip install git+https://github.com/fquinto/pywibeee

Usage

The library exposes an async client, WibeeeAPI, built on aiohttp:

import asyncio

import aiohttp

from pywibeee import WibeeeAPI


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        api = WibeeeAPI(session, "192.168.1.150")

        info = await api.async_fetch_device_info()
        print(info.model, info.mac_addr, info.firmware_version)

        data = await api.async_fetch_sensors_data()
        print(data["fase1"]["vrms"], data["fase4"]["p_activa"])


asyncio.run(main())

Highlights:

• async_fetch_device_info() — model, MAC address, firmware version, and device ID. The whole discovery is bounded by an overall deadline (default 15 seconds, deadline parameter) and raises TimeoutError when exceeded.

• async_fetch_sensors_data() — all sensor readings from status.xml, organized per phase (fase1..``fase3``, fase4 = total).

• async_check_connection() — quick check that the host is a WiBeee device.

• async_reboot() / async_reset_energy() — device actions.

• async_configure_push_server() / async_get_push_server_config() — configure or read the device’s push destination.

• async_fetch_device_diagnostics() — configuration variables for diagnostics.

• Each HTTP request has a 10-second timeout (configurable) with optional retries; failed fetches are logged at debug level and return None.

Tests

pip install -e ".[test]"
pytest

The suite covers XML parsing, HTTP errors, retries, the discovery deadline, push server configuration, device actions, and diagnostics. It runs in CI on Python 3.10, 3.12, and 3.14.

Features

• Autodiscover the host (IP) of the meter on the network.

• Get version, model, device name, info, status, and sensor list.

• Actions: reboot (via command or web), reset energy counters, configure push server.

• Output formats: xml, json, plain text, file.

Usage

pywibeee -h

usage: pywibeee [-h] [-version] (--host HOST | --auto) [-p PORT] [-t SETTIMEOUT]
                [-o {xml,json,plain,file}]
                (-a {reboot,rebootweb,resetenergy,configureserver} | -g {model,version,status,info,sensors,devicename})
                [--serverip SERVERIP] [--serverport SERVERPORT]

CLI for WiBeee (old Mirubee) meter

optional arguments:
  -h, --help            show this help message and exit
  -version, --version   show program's version number and exit
  --host HOST           The host (or the IP) of the meter.
  --auto                Autodiscover host function, look IP on net.
  -p PORT, --port PORT  set port (default 80)
  -t SETTIMEOUT, --settimeout SETTIMEOUT
                        set timeout in seconds (default 10.0)
  -o FORMAT, --output FORMAT
                        xml|json|plain|file
  -a ACTION, --action ACTION
                        reboot|rebootweb|resetenergy|configureserver
  -g GET, --get GET     model|version|status|info|sensors|devicename
  --serverip SERVERIP   Server IP for push config (use with -a configureserver)
  --serverport SERVERPORT
                        Server port for push config (default 8600)

Enjoy! :)

Examples

$ pywibeee --host 192.168.1.150 --get status
{"response": {"model": "WBB", "webversion": "3.4.614", "time": "1570484447",
"fase1_vrms": "228.70", "fase1_irms": "1.59", "fase1_p_activa": "264.34", ...}}

$ pywibeee --host 192.168.1.150 --get model
{"response": {"model": "WBB", "model_description": "Wibeee BOX"}}

$ pywibeee --host 192.168.1.150 -g info
{"response": {"model": "WBB", "model_description": "Wibeee BOX",
"webversion": "3.4.614", "host": "192.168.1.150", "devicename": "WIBEEE"}}

$ pywibeee --auto -g sensors
{"vrms": ["Vrms", "V", "mdi:sine-wave"], "irms": ["Irms", "A", "mdi:flash-auto"], ...}

$ pywibeee --host 192.168.1.150 -a configureserver --serverip 192.168.1.50 --serverport 8600
{"response": {"configureServer": "done (server=192.168.1.50:8600)"}}

$ pywibeee --host 192.168.1.150 -a rebootweb

$ pywibeee --host 192.168.1.150 -a resetenergy

Endpoint

GET /Wibeee/receiverAvg?mac=001ec0112233&v1=230.5&a1=277&e1=222157&vt=230.5&...

The server must respond with <<<WBAVG to acknowledge receipt.

The server can also send <<<WREBOOT to remotely reboot the device.

Push parameter mapping

Phase suffixes: 1 = L1, 2 = L2, 3 = L3, t = Total.

Example: v1 = voltage L1, at = active power total, e2 = active energy L2.

Configure push via HTTP

# Set the push server (port in hex: 8123 = 1fbb for HA default port)
curl "http://192.168.1.150/configura_server?ipServidor=192.168.1.50&URLServidor=192.168.1.50&portServidor=1fbb"

# Reset the device to apply changes
curl "http://192.168.1.150/config_value?reset=true"

Other useful HTTP endpoints

# Harmonics data
curl http://192.168.1.150/services/user/harmonics.xml

# Waveform data (per phase)
curl http://192.168.1.150/services/user/wafeformsF1.xml

# Read measurement refresh rate
curl "http://192.168.1.150/services/user/values.xml?var=WIBEEE.measuresRefresh"

# Read app refresh rate
curl "http://192.168.1.150/services/user/values.xml?var=WIBEEE.appRefresh"

# Trigger WiFi scan and get results
curl "http://192.168.1.150/scan.cgi?getAllBss"
curl http://192.168.1.150/scanallresults.xml

Open ports

80/tcp  open http      Web interface, configuration, bootloader commands
502/tcp open modbus    Modbus TCP (input registers from 1009)
550/tcp open binary    OTA firmware transfer (do NOT use without full understanding)

OTA commands

• 21001A 576246696E697368426F6F746C6F6164657250726F6363657373 0D0A (hex) = WbStartBootloaderProccess

• 200119 576246696e697368426f6f746c6f6164657250726f6363657373 0D0A (hex) = WbFinishBootloaderProccess

• 0D (hex) = Enter key = get version

• 0F (hex) = read Backup Position

• 01 (hex) = reset

Models

Security

The WiBeee has no authentication on local HTTP endpoints and uses plain HTTP. Recommended precautions:

• Isolate the device on a separate VLAN or IoT network.

• Use firewall rules to restrict access to ports 80, 502, and 550.

• Do not expose the device to the internet.