alphaesscloud-api

API to AlphaeSS cloud

Requirements

python3
python-requests

Installation

git clone https://github.com/ckarrie/alphaesscloud-api/

Usage example

cd alphaesscloud-api
python3

Example 1: Login, set SOC cap, stop charging

import alphaesscloud_api as ae
client = ae.AlphaClient("my@email.com", "mypassword")
client.login()
client.fetch_system_list()
for sys_id, sys_obj in client.systems.items():
    sys_data = sys_obj.fetch_settings()
    sys_obj.set_soc_cap(min_soc=26, max_soc=100)  # set SOC to 26-100%
    for cp_id, cp_obj in sys_obj.charging_piles.items():
        cp_obj.stop_charging()

Example 2: Charge AlphaESS battery and start charging EV

from alphaesscloud_api import AlphaClient, const
import time
client = AlphaClient("my@email.com", "mypassword")
client.login(load_settings=True)

charging_current = 6

for _, system in client.systems.items():
    system.fetch_last_power_data()
    for _, charging_pile in system.charging_piles.items():
        print(charging_pile.charging_mode, const.CHARGING_MODES.get(charging_pile.charging_mode))
        if charging_pile.charging_mode != const.CHARGING_MODE_MAX:
            charging_pile.change_charging_mode(mode=const.CHARGING_MODE_MAX)
            print("Set charging mode to", const.CHARGING_MODES.get(const.CHARGING_MODE_MAX))
        charging_pile.change_charging_current(ampere=charging_current)
        charging_pile.start_charging()
    

while True:
    charging_pile.fetch_charging_status()
    system.fetch_last_power_data()
    print(f"Wallbox Power {system.energy_data['chargingpile_sum_power']}W")    
    time.sleep(10)
    

while True:
    system.fetch_last_power_data()
    if system.energy_data['bat_soc'] >= 100.0:
        charging_pile.change_charging_mode(mode=const.CHARGING_MODE_SLOW)

Goals

charge AlphaESS battery and EV battery at the same time using PV only
- in ECO Mode (1) this does not work, because it only charges the car if the AlphaESS battery SOC reaches 100%
- in MAX Mode (4) this works, if you calculate the available Ampere for AlphaESS battery and House Load:
  - 2kW for AlphaESS battery: 2000W/(3x230V) = 3A per Phase
  - 2kW for House Load: 2000W/(3x230V) = 3A per Phase
  - AlphaChargingPile.change_charging_current(ampere) with ampere = PV(A) - 6A
Solar to grid in the morning to stabilize/reduce the load in grid
- untested but should work in theory: AlphaSystem.set_soc_cap(max_soc=26)

Code reference/documentation

`AlphaClient`

Represents a user account

`AlphaClient(username, password)`

Set plain login credentials

`AlphaClient.login(load_settings=False)`

Method to generate required get/post headers, load_settings=True loads System settings

`AlphaClient.fetch_system_list()`

Required method to fill attribute AlphaClient.systems

`AlphaClient.systems`

Dict of AlphaESS systems for this user (key = system id, value = AlphaSystem instance)

`AlphaSystem`

Represents a AlphaESS System

`AlphaSystem.fetch_settings()`

Required method to fill attribute AlphaSystem.charging_piles and set model names and version numbers

`AlphaSystem.set_soc_cap(min_soc=20, max_soc=100)`

Set min and max State of Charge for the battery

`AlphaChargingPile`

Represents a charging pile (aka Wallbox)

`AlphaChargingPile.stop_charging()`

stops charging on that pile

`AlphaChargingPile.start_charging()`

starts charging on that pile

`AlphaChargingPile.fetch_charging_status()`

returns text representation of current charging state

`AlphaChargingPile.change_charging_mode(mode)`

sets charging mode:

1: SLOW
2: NORMAL
3: FAST
4: MAX

`AlphaChargingPile.change_charging_current(ampere, watts)`

ampere between 6 and 16
watts between 4140 (=6A) and 11040 (=16A)
works only if AlphaChargingPile.change_charging_mode(mode=4)

Supported

System:
- Set SOC (min/max) via AlphaSystem.set_soc_cap
EV Charger / Wallbox:
- Set Charging Mode
  - 1: SLOW aka "ECO-Ladung > Langsamladung"
  - 2: NORMAL aka "ECO-Ladung > Schonladung"
  - 3: FAST aka "ECO-Ladung > Schnelladung"
  - 4: MAX aka "Kundenspezifische Ladeleistung", use AlphaChargingPile.change_charging_current for Ampere per Phase
- Start and stop charging
- Get Charging Status

Special Thanks to

@vdwals - see CharlesGillanders/homeassistant-alphaESS#70