autarco 0.2.0

Asynchronous Python client for the Autarco Inverters

Python - Autarco Client

Asynchronous Python client for the Autarco Inverters.

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_public_key method, that will return your key.

Installation

pip install autarco

Usage

import asyncio

from autarco import Autarco


async def main():
    """Show example on getting Autarco data."""
    async with Autarco(
        email="[e-mail]",
        password="password",
    ) as client:
        public_key = await client.get_public_key()

        inverters = await client.all_inverters(public_key)
        solar = await client.solar(public_key)
        account = await client.account(public_key)
        print(inverters)
        print(solar)
        print(account)


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

Data

You can read the following data with this package:

Inverter(s)

• Serial Number
• Current Power Production (W)
• Total Energy Production (kWh)
• Health Status

Solar

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

Account

• Public Key (str)
• Name (str)
• City (str)
• State (str)
• Country (str)
• Timezone (str)

Setting up development environment

This Python project is fully managed using the Poetry dependency manager.

You need at least:

• Python 3.9+
• 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

License

MIT License

Copyright (c) 2022 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.