{"id":16237173,"url":"https://github.com/klaasnicolaas/python-omnikinverter","last_synced_at":"2025-10-25T21:47:53.475Z","repository":{"id":36975833,"uuid":"397380565","full_name":"klaasnicolaas/python-omnikinverter","owner":"klaasnicolaas","description":"☀️ Asynchronous Python client for the Omnik Inverter","archived":false,"fork":false,"pushed_at":"2025-10-13T04:59:51.000Z","size":3061,"stargazers_count":9,"open_issues_count":4,"forks_count":6,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-10-14T17:19:24.515Z","etag":null,"topics":["async","client","energy","hacktoberfest","inverter","omnik","python","solar"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klaasnicolaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"klaasnicolaas","ko_fi":"klaasnicolaas"}},"created_at":"2021-08-17T20:14:51.000Z","updated_at":"2025-10-13T00:56:17.000Z","dependencies_parsed_at":"2023-01-17T11:02:07.315Z","dependency_job_id":"be63a832-519a-4e08-a5c2-666eb0032ba8","html_url":"https://github.com/klaasnicolaas/python-omnikinverter","commit_stats":{"total_commits":548,"total_committers":9,"mean_commits":"60.888888888888886","dds":0.4361313868613139,"last_synced_commit":"494f6e800d1f809c6f6373802b1d970ac0fa5ae7"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/klaasnicolaas/python-omnikinverter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-omnikinverter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-omnikinverter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-omnikinverter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-omnikinverter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klaasnicolaas","download_url":"https://codeload.github.com/klaasnicolaas/python-omnikinverter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-omnikinverter/sbom","scorecard":{"id":562979,"data":{"date":"2025-08-11","repo":{"name":"github.com/klaasnicolaas/python-omnikinverter","commit":"389d229fccc74e0ad10624c13aa970c6a4a09d99"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":6.2,"checks":[{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/codeql.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yaml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/codeql.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/codeql.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linting.yaml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/linting.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linting.yaml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/linting.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linting.yaml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/linting.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linting.yaml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/linting.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linting.yaml:114: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/linting.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linting.yaml:119: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/linting.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linting.yaml:137: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/linting.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linting.yaml:142: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/linting.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linting.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/linting.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/linting.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/linting.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/lock.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-labels.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/pr-labels.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-drafter.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/release-drafter.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/release.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/release.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/release.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/release.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/stale.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sync-labels.yaml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/sync-labels.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync-labels.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/sync-labels.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/tests.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/tests.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/tests.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/tests.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/tests.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yaml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/tests.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yaml:75: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/tests.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typing.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/typing.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typing.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/klaasnicolaas/python-omnikinverter/typing.yaml/main?enable=pin","Info:   0 out of  25 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   7 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'pull-requests' permission set to 'read': .github/workflows/release-drafter.yaml:17","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release-drafter.yaml:16","Warn: no topLevel permission defined: .github/workflows/codeql.yaml:1","Warn: no topLevel permission defined: .github/workflows/linting.yaml:1","Warn: no topLevel permission defined: .github/workflows/lock.yaml:1","Warn: no topLevel permission defined: .github/workflows/pr-labels.yaml:1","Warn: no topLevel permission defined: .github/workflows/release-drafter.yaml:1","Warn: no topLevel permission defined: .github/workflows/release.yaml:1","Warn: no topLevel permission defined: .github/workflows/stale.yaml:1","Warn: no topLevel permission defined: .github/workflows/sync-labels.yaml:1","Warn: no topLevel permission defined: .github/workflows/tests.yaml:1","Warn: no topLevel permission defined: .github/workflows/typing.yaml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Branch-Protection","score":3,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Warn: 'branch protection settings apply to administrators' is disabled on branch 'main'","Warn: 'stale review dismissal' is disabled on branch 'main'","Warn: branch 'main' does not require approvers","Info: codeowner review is required on branch 'main'","Warn: 'last push approval' is disabled on branch 'main'","Warn: 'up-to-date branches' is disabled on branch 'main'","Info: status check found to merge onto on branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: SAST configuration detected: CodeQL","Info: all commits (30) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T14:11:52.366Z","repository_id":36975833,"created_at":"2025-08-20T14:11:52.366Z","updated_at":"2025-08-20T14:11:52.366Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279020079,"owners_count":26086806,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","client","energy","hacktoberfest","inverter","omnik","python","solar"],"created_at":"2024-10-10T13:34:46.935Z","updated_at":"2025-10-14T17:19:25.501Z","avatar_url":"https://github.com/klaasnicolaas.png","language":"Python","funding_links":["https://github.com/sponsors/klaasnicolaas","https://ko-fi.com/klaasnicolaas"],"categories":[],"sub_categories":[],"readme":"\u003c!-- Banner --\u003e\n![alt Banner of the Omnik Inverter package](https://raw.githubusercontent.com/klaasnicolaas/python-omnikinverter/main/assets/header_omnik_inverter-min.png)\n\n\u003c!-- PROJECT SHIELDS --\u003e\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE)\n\n[![GitHub Activity][commits-shield]][commits-url]\n[![PyPi Downloads][downloads-shield]][downloads-url]\n[![GitHub Last Commit][last-commit-shield]][commits-url]\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\n[![Maintainability][maintainability-shield]][maintainability-url]\n[![Code Coverage][codecov-shield]][codecov-url]\n\n[![Code Quality][code-quality-shield]][code-quality]\n[![Build Status][build-shield]][build-url]\n\nAsynchronous Python client for the Omnik Inverter.\n\n## About\n\nA 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.\n\n**NOTE**: In mid-2021, manufacturer Omnik was declared bankrupt. You can find more information about what your alternatives are [here][energiewacht].\n\n## Supported models\n\n| Brand    | Model            | Datasource |\n|----------|------------------|------------|\n| Omnik    | Omniksol 1000TL  | JS         |\n| Omnik    | Omniksol 1500TL  | JS         |\n| Omnik    | Omniksol 2000TL  | JS         |\n| Omnik    | Omniksol 2000TL2 | JSON       |\n| Omnik    | Omniksol 2500TL  | HTML       |\n| Omnik    | Omniksol 3000TL  | TCP        |\n| Omnik    | Omniksol 4000TL2 | JS         |\n| Ginlong  | Solis-DLS-WiFi   | JSON/HTML  |\n| Hosola   | 1500TL           | JS         |\n| Hosala   | Bright 2500MTL-S | JS         |\n| Bosswerk | BW-MI300         | HTML       |\n| Bosswerk | BW-MI600         | HTML       |\n| Sofar    | 3600TLM          | HTML       |\n| Sofar    | 2200TL           | JS         |\n| Huayu    | HY-600-Pro       | HTML       |\n\n## Installation\n\n```bash\npip install omnikinverter\n```\n\n## Usage\n\n```python\nimport asyncio\n\nfrom omnikinverter import OmnikInverter\n\n\nasync def main():\n    \"\"\"Show example on getting Omnik Inverter data.\"\"\"\n    async with OmnikInverter(\n        host=\"example_host\",\n        source_type=\"javascript\",\n        username=\"omnik\",\n        password=\"inverter\",\n    ) as client:\n        inverter = await client.inverter()\n        device = await client.device()\n        print(inverter)\n        print(device)\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\nFor the **source type** you can choose between: `javascript` (default), `json`, `html` and `tcp`.\n\n## Data\n\nYou can read the following data with this package:\n\n### Inverter\n\n- Serial Number\n- Inverter Model\n- Firmware Version - Main\n- Firmware Version - Slave\n- Alarm Code\n- Rated Power (W)\n- Current Power Production (W)\n- Day Energy Production (kWh)\n- Total Energy Production (kWh)\n\nOn the `tcp` source type you can also find:\n\n- Inverter temperature;\n- Voltage and current for the DC input strings (up to 3)\n- Voltage, current, frequency and power for all AC outputs (also up to 3)\n- Total number of runtime hours.\n\n### Device\n\n- Signal Quality (only with JS)\n- Firmware Version\n- IP Address\n\n## Use cases\n\nThis python package is used in the following projects, among others:\n\n- [home-assistant-omnik-inverter][omnik-inverter] by Robbin Janssen\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThe simplest way to begin is by utilizing the [Dev Container][devcontainer]\nfeature of Visual Studio Code or by opening a CodeSpace directly on GitHub.\nBy clicking the button below you immediately start a Dev Container in Visual Studio Code.\n\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\nThis Python project relies on [Poetry][poetry] as its dependency manager,\nproviding comprehensive management and control over project dependencies.\n\nYou need at least:\n\n- Python 3.11+\n- [Poetry][poetry-install]\n\n### Installation\n\nInstall all packages, including all development requirements:\n\n```bash\npoetry install\n```\n\n_Poetry creates by default an virtual environment where it installs all\nnecessary pip packages_.\n\n### Pre-commit\n\nThis repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. To setup the pre-commit check, run:\n\n```bash\npoetry run pre-commit install\n```\n\nAnd to run all checks and tests manually, use the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\n### Testing\n\nIt uses [pytest](https://docs.pytest.org/en/stable/) as the test framework. To run the tests:\n\n```bash\npoetry run pytest\n```\n\nTo update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:\n\n```bash\npoetry run pytest --snapshot-update\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2021-2025 Klaas Schoute\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[energiewacht]: https://www.energiewacht.com/hoofdsite/home/nieuws/omnik-failliet/\n[omnik-inverter]: https://github.com/robbinjanssen/home-assistant-omnik-inverter\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[build-shield]: https://github.com/klaasnicolaas/python-omnikinverter/actions/workflows/tests.yaml/badge.svg\n[build-url]: https://github.com/klaasnicolaas/python-omnikinverter/actions/workflows/tests.yaml\n[code-quality-shield]: https://github.com/klaasnicolaas/python-omnikinverter/actions/workflows/codeql.yaml/badge.svg\n[code-quality]: https://github.com/klaasnicolaas/python-omnikinverter/actions/workflows/codeql.yaml\n[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-omnikinverter.svg\n[commits-url]: https://github.com/klaasnicolaas/python-omnikinverter/commits/main\n[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-omnikinverter/branch/main/graph/badge.svg?token=VQTR24YFQ9\n[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-omnikinverter\n[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers\u0026message=Open\u0026color=blue\u0026logo=visualstudiocode\n[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-omnikinverter\n[downloads-shield]: https://img.shields.io/pypi/dm/omnikinverter\n[downloads-url]: https://pypistats.org/packages/omnikinverter\n[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-omnikinverter.svg\n[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-omnikinverter.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg\n[maintainability-shield]: https://api.codeclimate.com/v1/badges/ec5166b74a63f375d1a1/maintainability\n[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-omnikinverter/maintainability\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg\n[pypi]: https://pypi.org/project/omnikinverter/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/omnikinverter\n[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-omnikinverter.svg\n[releases]: https://github.com/klaasnicolaas/python-omnikinverter/releases\n\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-omnikinverter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklaasnicolaas%2Fpython-omnikinverter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-omnikinverter/lists"}