Skip to main content

A python library to retrieve energy statistics from your Alpha ESS inverter by polling the Alpha ESS web API.

Project description

alphaess

This Python library logs in to cloud.alphaess.com and retrieves data on your Alpha ESS inverter, photovoltaic panels, and battery if you have one.

Usage

Create a new Alpha ESS instance, log in, retrieve a list of Alpha ESS systems and request energy statistics of one of those Alpha ESS systems.

API

Currently this package uses an API that I reverse engineered the API from the Alpha ESS web app. This is an internal API subject to change at any time by Alpha ESS.

Methods

There are four public methods in this module

authenticate(username, password) - attempts to authenticate to the ALpha ESS API with a username and password combination, returns True or False depending on successful authentication or not

getdata() - having successfully authenticated attempts to get statistical energy data on all registered Alpha ESS systems - will return None if there are issues retrieving data from the Alpha ESS API.

setbatterycharge(serial, enabled, cp1start, cp1end, cp2start, cp2end, chargestopsoc) - having successfully authenticated set battery grid charging settings for the SN.

setbatterydischarge(serial, enabled, dp1start, dp1end, dp2start, dp2end, dischargecutoffsoc) - having successfully authenticated set battery discharge settings for the SN.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alphaess-0.0.8.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alphaess-0.0.8-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file alphaess-0.0.8.tar.gz.

File metadata

  • Download URL: alphaess-0.0.8.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for alphaess-0.0.8.tar.gz
Algorithm Hash digest
SHA256 f2f857224be3d28250cf0f18ea60dcee0773b14af7961f00571295323c7e8660
MD5 415d10f13924251d33caea7593fd6f5e
BLAKE2b-256 b7c035704e4cddad65b3ad2f30d609a64a3234d276b60126db5af7c614c6bcde

See more details on using hashes here.

File details

Details for the file alphaess-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: alphaess-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for alphaess-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 82908c0511a021b0ff8d0ae2dc9b1f8d958e01891dec1bf417d2ff82822fdb82
MD5 059bd7c02d2cfaeacda978a983db307b
BLAKE2b-256 71322f857cc5a780a505b1ea994b5b48e283cc4b7c21fc32d528bf45e8411658

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page