autarco 2.0.0

Description:

autarco 2.0.0

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="[email protected]",
password="password",
) as client:
account_sites = await client.get_account()

inverters = await client.get_inverters(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(solar)
print(site)


if __name__ == "__main__":
asyncio.run(main())

More examples can be found in the examples folder.
Data
You can read the following data with this package:
Account
With all the sites you have access to.

Site ID
Public Key
System Name
Retailer Name
Health Status

Inverter(s)

Serial Number
Out AC - Power (W)
Out AC - Energy Total (kWh)
Grid Turned Off (bool)
Health Status

Solar

Current Power Production (W)
Energy Production - Today (kWh)
Energy Production - Month (kWh)
Energy Production - Total (kWh)

Site

Public Key
Name
Address (dict)

Street
Zip Code
City
Country


Timezone
Created At (date)
Has consumption meter (bool)
Has battery (bool)

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.