omnikinverter 0.2.2

Asynchronous Python client for the Omnik Inverter

Python - Omnik Inverter Client

Asynchronous Python client for the Omnik Inverter.

About

A python package with which you can read the data from your Omnik Inverter. Keep in mind that this repository uses webscraping, this is not a neat way of data processing but due to the lack of a local API this is the only option.

NOTE: In mid-2021, manufacturer Omnik was declared bankrupt. You can find more information about what your alternatives are here.

Supported models

• Omnik2000TL2

Installation

pip install omnikinverter

Usage

import asyncio

from omnikinverter import OmnikInverter


async def main():
    """Show example on getting Omnik Inverter data."""
    async with OmnikInverter(host="example_host") as client:
        inverter = await client.inverter()
        print(inverter)


if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

Data

You can read the following data with this package:

• Serial Number
• Inverter Model
• Firmware Version
• Current Power Production (W)
• Day Energy Production (kWh)
• Total Energy Production (kWh)

Setting up development environment

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

• Python 3.8+
• Poetry

Create a virtualenv and enter it:

python3 -m venv venv
source venv/bin/activate

To install all packages, including all development requirements:

poetry install
pre-commit install

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) 2021 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.