Asynchronous Python client for the Autarco Inverters
Project description
Asynchronous Python client for the Autarco Inverters (External API).
About
A python package with which you can read the data of your Autarco
Inverter(s). This is done by making a request to the My Autarco
platform, for this you will need the email
and password
.
The data on the platform is updated every 5 minutes.
Public key
You can find this in the url after logging in,
example: https://my.autarco.com/site/{public_key}
Or by using the get_account
function, and use the public_key
attribute.
Installation
pip install autarco
Usage
import asyncio
from autarco import Autarco
async def main():
"""Show example on getting Autarco data."""
async with Autarco(
email="test@autarco.com",
password="password",
) as client:
account_sites = await client.get_account()
inverters = await client.get_inverters(account_sites[0].public_key)
battery = await client.get_battery(account_sites[0].public_key)
solar = await client.get_solar(account_sites[0].public_key)
site = await client.get_site(account_sites[0].public_key)
print(inverters)
print(battery)
print(solar)
print(site)
if __name__ == "__main__":
asyncio.run(main())
More examples can be found in the examples folder.
Datasets
You can read the following with this package:
- Account data with all the sites you have access to.
- Inverter(s) data with the power output, energy output, grid status and health status.
- Solar data with the power production, energy production of today, this month and total.
- Battery data with insights into your batteries.
- Site general information about a specific site.
- Statistics of the inverter(s) with power and energy data.
CLICK HERE! to see all dataset details
Account
With all the sites you have access to.
Name | Type | Description |
---|---|---|
site_id |
str |
The unique identifier of the site. |
public_key |
str |
The public key of the site. |
system_name |
str |
The name of the site system. |
retailer |
str |
The name of the retailer. |
health |
str |
The health status of the site. |
Inverter(s)
Name | Type | Description |
---|---|---|
serial_number |
str |
The serial number of the inverter. |
out_ac_power |
int |
The power output of the inverter in W. |
out_ac_energy_total |
float |
The total energy output of the inverter in kWh. |
grid_turned_off |
bool |
If the grid is turned off. |
health |
str |
The health status of the inverter. |
Solar
Name | Type | Description |
---|---|---|
power_production |
int |
The current power production in W. |
energy_production_today |
float |
The energy production of today in kWh. |
energy_production_month |
float |
The energy production of this month in kWh. |
energy_production_total |
float |
The total energy production in kWh. |
Battery
Name | Type | Description |
---|---|---|
flow_now |
int |
The current battery flow in W. |
net_charged_now |
int |
The current net charged battery in W. |
state_of_charge |
int |
The current state of charge of the battery in %. |
discharged_today |
int |
How much energy the battery has discharged today in kWh. |
discharged_month |
int |
How much energy the battery has discharged this month in kWh. |
discharged_total |
int |
How much energy the battery has discharged in total in kWh. |
charged_today |
int |
How much energy the battery has charged today in kWh. |
charged_month |
int |
How much energy the battery has charged this month in kWh. |
charged_total |
int |
How much energy the battery has charged in total in kWh. |
Site
Name | Type | Description |
---|---|---|
public_key |
str |
The public key of the site. |
name |
str |
The name of the site. |
address |
dict |
The address of the site. (street, zip code, city and country) |
timezone |
str |
The timezone of the site. |
created_at |
date |
The creation date of the site. |
has_consumption_meter |
bool |
If the site has a consumption meter. |
has_battery |
bool |
If the site has a battery. |
Statistics
It is possible to retrieve inverter(s) statistical data from the API, a distinction has been made into two types:
Power
Parameters to get the power statistics of the site.
- query_range (default:
day
) - The range of the query, can beday
orweek
.
Name | Type | Description |
---|---|---|
graphs .pv_power |
dict |
The power statistics for each inverter. |
You can generate a better list with the property generate_power_stats_inverter
of the Stats
object.
Energy
Parameters to get the energy statistics of the site.
- query_range (default:
month
) - The range of the query, can bemonth
,year
ortotal
.
Name | Type | Description |
---|---|---|
graphs .pv_energy |
dict |
The energy statistics for each inverter. |
You can generate a better list with the property generate_energy_stats_inverter
of the Stats
object.
Contributing
This is an active open-source project. We are always open to people who want to use the code or contribute to it.
We've set up a separate document for our contribution guidelines.
Thank you for being involved! :heart_eyes:
Setting up development environment
The simplest way to begin is by utilizing the Dev Container feature of Visual Studio Code or by opening a CodeSpace directly on GitHub. By clicking the button below you immediately start a Dev Container in Visual Studio Code.
This Python project relies on Poetry as its dependency manager, providing comprehensive management and control over project dependencies.
You need at least:
- Python 3.11+
- Poetry
Install all packages, including all development requirements:
poetry install
Poetry creates by default an virtual environment where it installs all necessary pip packages, to enter or exit the venv run the following commands:
poetry shell
exit
Setup the pre-commit check, you must run this inside the virtual environment:
pre-commit install
Now you're all set to get started!
As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:
poetry run pre-commit run --all-files
To run just the Python tests:
poetry run pytest
To update the syrupy snapshot tests:
poetry run pytest --snapshot-update
License
MIT License
Copyright (c) 2022-2024 Klaas Schoute
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.