Python: Asynchronous client for Combined Energy API
Provides an async Python 3.11+ interface for the http://combined.energy/ monitoring platform API.
Note this API client is reverse engineered from observing requests being made in the web-application. Please report any failures to read data, this is likely to occur for readings as I am only able to create entries for devices that I have.
Installation
Install from PyPI
python3 -m pip install combined-energy-api
Usage
import asyncio
from combined_energy import CombinedEnergy
from combined_energy.helpers import ReadingsIterator
async def main():
"""
Example using Combined Energy API client.
"""
async with CombinedEnergy(
mobile_or_email="user@example.com",
password="YOUR_COMBINED_ENERGY_PASSWORD",
installation_id=9999,
) as combined_energy:
status = await combined_energy.communication_status()
print(status)
# To generate a stream of readings use the iterator, this example fetches
# data in 5 minute increments
async for readings in ReadingsIterator(combined_energy, increment=300):
print(readings)
await asyncio.sleep(300)
asyncio.run(main())
Development Environment
You will need:
- Python 3.11+
- poetry
- pre-commit
Ensure pre-commit is installed into your git repository with pre-commit install.
Metadata
Release files for combined-energy-api 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| combined_energy_api-1.0.1.tar.gz | 18.2 kB | Without provenance | Details for combined_energy_api-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| combined_energy_api-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for combined_energy_api-1.0.1-py3-none-any.whl |
Total release size: 30.2 kB
Release files / combined_energy_api-1.0.1.tar.gz
| Download URL | combined_energy_api-1.0.1.tar.gz |
|---|---|
| Size | 18.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f265a053ed1b122e176845d6248e7d77c5021a175d3d4589046ba57a901f8abb
|
|
BLAKE2b-256 checksum How to use checksums |
b727cb7d27f834b57d8893c8f9c894764521c7a6ac16bbb6f4e59cb967f667c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.22
|
Release files / combined_energy_api-1.0.1-py3-none-any.whl
| Download URL | combined_energy_api-1.0.1-py3-none-any.whl |
|---|---|
| Size | 12.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2f5bf22d8513d1d3dc80c4aba0ab20f393b77a139ead07ae0bb6c709aa759f49
|
|
BLAKE2b-256 checksum How to use checksums |
0d4b179c234931e3efb2028c2f900fde094debe12fa6dfa2b22f1ae5fad3966a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.22
|
Security for combined-energy-api 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.