python-omnikinverter: A Python repository from 9R

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

Brand	Model	Datasource
Omnik	Omniksol 1000TL	JS
Omnik	Omniksol 1500TL	JS
Omnik	Omniksol 2000TL	JS
Omnik	Omniksol 2000TL2	JSON
Omnik	Omniksol 2500TL	HTML
Omnik	Omniksol 3000TL	TCP
Omnik	Omniksol 4000TL2	JS
Ginlong	Solis-DLS-WiFi	JSON/HTML
Hosola	1500TL	JS
Hosala	Bright 2500MTL-S	JS
Bosswerk	BW-MI300	HTML
Bosswerk	BW-MI600	HTML
Sofar	3600TLM	HTML
Sofar	2200TL	JS
Huayu	HY-600-Pro	HTML

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",
        source_type="javascript",
        username="omnik",
        password="inverter",
    ) as client:
        inverter = await client.inverter()
        device = await client.device()
        print(inverter)
        print(device)


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

For the source type you can choose between: javascript (default), json, html and tcp.

Data

You can read the following data with this package:

Inverter

Serial Number
Inverter Model
Firmware Version - Main
Firmware Version - Slave
Alarm Code
Rated Power (W)
Current Power Production (W)
Day Energy Production (kWh)
Total Energy Production (kWh)

On the tcp source type you can also find:

Inverter temperature;
Voltage and current for the DC input strings (up to 3)
Voltage, current, frequency and power for all AC outputs (also up to 3)
Total number of runtime hours.

Device

Signal Quality (only with JS)
Firmware Version
IP Address

Use cases

This python package is used in the following projects, among others:

home-assistant-omnik-inverter by Robbin Janssen

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! 😍

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

License

MIT License

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.

9R/python-omnikinverter