Read data from CheckWatts EnergyInBalance WEB API
Project description
pyCheckwatt
Python package for communicating with CheckWatt EnergyInBalance targeted for Home Assistant integrations and other use-cases.
Warning
This library is provided as-is and is not supported or approved by CheckWatt. CheckWatt can implement breaking changes at any time that renders this module useless. The module may not be updated promptly, or not at all if the changes are not possible to reverse engineer.
Status
The library is experimental and pulls basic info from EnergyInBalance. Use with care as it loads the servers of CheckWatt
Example
The following example will login to EnergyInBalance and retrieve information.
Create a file called example.py
that looks like this:
"""Example-module for pyCheckwatt."""
import argparse
import json
from pycheckwatt import CheckwattManager
async def main(show_details=False):
"""Fetch username and password from environment variables."""
username = "EIB username"
password = "EiB password"
# Create the async class
async with CheckwattManager(username, password) as check_watt_instance:
try:
# Login to EnergyInBalance and check kill switch
if await check_watt_instance.login():
# Fetch customer detail
await check_watt_instance.get_customer_details()
# Do a sample
print("Customer Details\n================")
print(check_watt_instance.registered_owner)
print("\nSystem\n======")
print("Charge peak AC", check_watt_instance.battery_peak_data[0])
print("Charge peak DC", check_watt_instance.battery_peak_data[1])
print("Discharge peak AC", check_watt_instance.battery_peak_data[2])
print("Discharge peak DC", check_watt_instance.battery_peak_data[3])
print(check_watt_instance.battery_make_and_model)
print(check_watt_instance.electricity_provider)
print("\nLogbook Entries\n===============")
for entry in check_watt_instance.logbook_entries:
print(entry)
print("\nComments\n========")
print(check_watt_instance.comments)
await check_watt_instance.get_fcrd_today_net_revenue()
await check_watt_instance.get_fcrd_year_net_revenue()
await check_watt_instance.get_fcrd_month_net_revenue()
print("\nFCR-D\n=====")
print(f"FCR-D State: {check_watt_instance.fcrd_state}")
print(f"FCR-D Discharge: {check_watt_instance.fcrd_percentage_up}% of {check_watt_instance.fcrd_power}kW")
print(f"FCR-D Charge: {check_watt_instance.fcrd_percentage_down}% of {check_watt_instance.fcrd_power}kW")
print(f"FCR-D Response: {check_watt_instance.fcrd_percentage_response} seconds")
print(f"FCR-D Date: {check_watt_instance.fcrd_timestamp}")
print("\nRevenue\n=======")
print(
"{:<24} {:>6} {:>0}".format(
"Daily average:",
int(check_watt_instance.fcrd_daily_net_average),
"kr",
)
)
print(
"{:<24} {:>6} {:>0}".format(
"Month estimate:",
int(check_watt_instance.fcrd_month_net_estimate),
"kr",
)
)
print(
"{:<24} {:>6} {:>0}".format(
"Month revenue:",
int(check_watt_instance.fcrd_month_net_revenue),
"kr",
)
)
print(
"{:<24} {:>6} {:>0}".format(
"Year revenue:",
int(check_watt_instance.fcrd_year_net_revenue),
"kr",
)
)
print(
"{:<24} {:>6} {:>0}".format(
"Today revenue:",
int(check_watt_instance.fcrd_today_net_revenue),
"kr",
)
)
await check_watt_instance.get_ems_settings()
print("\nEMS Setting\n===========")
print(check_watt_instance.ems_settings)
await check_watt_instance.get_power_data()
print("\nEnergy\n======")
print(f"Solar: {check_watt_instance.total_solar_energy/1000} kWh")
print(f"Charging: {check_watt_instance.total_charging_energy/1000} kWh")
print(
f"Discharging: {check_watt_instance.total_discharging_energy/1000} kWh" # noqa: E501
)
print(f"Import: {check_watt_instance.total_import_energy/1000} kWh")
print(f"Export: {check_watt_instance.total_export_energy/1000} kWh")
if show_details:
print("\nCustomer Details\n===============")
print(json.dumps(check_watt_instance.customer_details, indent=2))
except Exception as e:
print(f"An error occurred: {e}")
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="Checkwatt Information")
parser.add_argument(
"-d", "--details", action="store_true", help="Show system details"
)
args = parser.parse_args()
import asyncio
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
loop.run_until_complete(main(args.details))
Create a virtual environment and install pyCheckwatt:
$ python -m venv venv
$ ./venv/Scripts/activate
$ pip install pycheckwatt
Run the example code:
$ python example.py
Watch the output:
Customer Details
================
First name Surname(Street number postal code city)
System
======
Charge peak AC 15.0
Charge peak DC 15.0
Discharge peak AC 15.0
Discharge peak DC 15.0
Growatt APX 30 kWh/Could not get any information about your battery
Bixia AB via E.ON Energidistribution AB
Logbook Entries
===============
[ FCR-D ACTIVATED ] email@email.com --11111-- 97,5/0,6/96,0 % (15 kW) 2022-01-28 00:03:42 API-BACKEND
[ FCR-D DEACTIVATE ] DOWN 50,19 Hz 46,0 % (15 kW) 2022-01-22 12:00:25 API-BACKEND
[ FCR-D ACTIVATED ] email@email.com --11111-- 98,2/0,8/97,0 % (15 kW) 2022-01-18 00:02:28 API-BACKEND
[ FCR-D DEACTIVATE ] UP 49,84 Hz 0,0 % (15 kW) 2022-01-09 23:09:03 API-BACKEND
Comments
========
Kund har utökat till 20 kWh / 20 kW.
System
======
Charge peak AC 15.0
Charge peak DC 15.0
Discharge peak AC 15.0
Discharge peak DC 15.0
Could not get any information about your battery
Bixia AB via E.ON Energidistribution AB
Revenue
=======
Daily average: 48 kr
Month estimate: 1504 kr
Month revenue: 145 kr
Year revenue: 4008 kr
Today revenue: 39 kr
EMS Setting
===========
Currently optimized (CO)
Energy
======
Solar: 779.365 kWh
Charging: 719.286 kWh
Discharging: 185.699 kWh
Import: 1684.686 kWh
Export: 668.539 kWh
Acknowledgements
This module was developed as a team effort by the following contributors.
This integration could not have been made without the excellent work done by the Home Assistant team.
If you like what have been done here and want to help I would recommend that you firstly look into supporting Home Assistant.
You can do this by purchasing some swag from their store or paying for a Nabu Casa subscription. None of this could happen without them.
Licenses
The integration is provided as-is without any warranties and published under The MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pycheckwatt-0.2.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dec66aae2ff48b3ddc5981b9a07e96ff3771e6b38df45d3fc46cb8a06f95479c |
|
MD5 | c1bb00dae2aa17df3138c5922ab31454 |
|
BLAKE2b-256 | d11ee0234ae3be0cd1b3bd9e8cb7206509e84aeccd57e9b336440a786110a980 |