Package: omnikinverter
Asynchronous Python client for the Omnik Inverter.AboutA python package with which you can read the data from your Omnik Inverter. Keep in mind that this repository uses webscraping, this isnota 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 arehere.Supported modelsBrandModelDatasourceOmnikOmniksol 1000TLJSOmnikOmniksol 1500TLJSOmnikOmniksol 2000TLJSOmnikOmniksol 2000TL2JSONOmnikOmniksol 2500TLHTMLOmnikOmniksol 3000TLTCPOmnikOmniksol 4000TL2JSGinlongSolis-DLS-WiFiJSON/HTMLHosola1500TLJSHosalaBright 2500MTL-SJSBosswerkBW-MI300HTMLBosswerkBW-MI600HTMLSofar3600TLMHTMLSofar2200TLJSHuayuHY-600-ProHTMLInstallationpipinstallomnikinverterUsageimportasynciofromomnikinverterimportOmnikInverterasyncdefmain():"""Show example on getting Omnik Inverter data."""asyncwithOmnikInverter(host="example_host",source_type="javascript",username="omnik",password="inverter",)asclient:inverter=awaitclient.inverter()device=awaitclient.device()print(inverter)print(device)if__name__=="__main__":asyncio.run(main())For thesource typeyou can choose between:javascript(default),json,htmlandtcp.DataYou can read the following data with this package:InverterSerial NumberInverter ModelFirmware Version - MainFirmware Version - SlaveAlarm CodeRated Power (W)Current Power Production (W)Day Energy Production (kWh)Total Energy Production (kWh)On thetcpsource 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.DeviceSignal Quality (only with JS)Firmware VersionIP AddressUse casesThis python package is used in the following projects, among others:home-assistant-omnik-inverterby Robbin JanssenContributingThis 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 ourcontribution guidelines.Thank you for being involved! :heart_eyes:Setting up development environmentThe simplest way to begin is by utilizing theDev Containerfeature 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 onPoetryas its dependency manager,
providing comprehensive management and control over project dependencies.You need at least:Python 3.11+PoetryInstall all packages, including all development requirements:poetryinstallPoetry creates by default an virtual environment where it installs all
necessary pip packages, to enter or exit the venv run the following commands:poetryshellexitSetup the pre-commit check, you must run this inside the virtual environment:pre-commitinstallNow you're all set to get started!As this repository uses thepre-commitframework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:poetryrunpre-commitrun--all-filesTo run just the Python tests:poetryrunpytestLicenseMIT LicenseCopyright (c) 2021-2023 Klaas SchoutePermission 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.