{"id":16237185,"url":"https://github.com/klaasnicolaas/python-gridnet","last_synced_at":"2025-06-20T01:08:00.737Z","repository":{"id":36962989,"uuid":"414995501","full_name":"klaasnicolaas/python-gridnet","owner":"klaasnicolaas","description":"⚡ Asynchronous Python client for Net2Grid devices","archived":false,"fork":false,"pushed_at":"2025-06-17T02:37:34.000Z","size":2719,"stargazers_count":8,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-17T03:29:18.888Z","etag":null,"topics":["api","async","client","energy","hacktoberfest","local","net2grid","python"],"latest_commit_sha":null,"homepage":"https://www.net2grid.com/hardware","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},"funding":{"github":"klaasnicolaas","ko_fi":"klaasnicolaas"}},"created_at":"2021-10-08T13:22:14.000Z","updated_at":"2025-06-17T02:37:37.000Z","dependencies_parsed_at":"2023-09-27T02:54:45.811Z","dependency_job_id":"c1a04280-2e62-47a5-a701-0e1c1c89191a","html_url":"https://github.com/klaasnicolaas/python-gridnet","commit_stats":{"total_commits":540,"total_committers":3,"mean_commits":180.0,"dds":"0.39814814814814814","last_synced_commit":"f39d0dcb8b5f4fb3152faad86f82915dc7c8ce9d"},"previous_names":["klaasnicolaas/python-pem"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/klaasnicolaas/python-gridnet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-gridnet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-gridnet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-gridnet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-gridnet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klaasnicolaas","download_url":"https://codeload.github.com/klaasnicolaas/python-gridnet/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-gridnet/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260857413,"owners_count":23073439,"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","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":["api","async","client","energy","hacktoberfest","local","net2grid","python"],"created_at":"2024-10-10T13:34:50.767Z","updated_at":"2025-06-20T01:07:55.716Z","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 gridnet package](https://raw.githubusercontent.com/klaasnicolaas/python-gridnet/main/assets/header_gridnet-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[![Code Quality][code-quality-shield]][code-quality]\n[![Build Status][build-shield]][build-url]\n[![Typing Status][typing-shield]][typing-url]\n\n[![Maintainability][maintainability-shield]][maintainability-url]\n[![Code Coverage][codecov-shield]][codecov-url]\n\nAsynchronous Python client for Net2Grid devices.\n\n## About\n\nA python package with which you can read the data from a [NET2GRID][net2grid] device\nvia a local api. Net2Grid supplies energy hardware to brands, that can market it as a\nwhite label product.\n\n## Supported SmartBridges\n\n- SBWF3102 ([Pure Energie][pure-energie])\n\n## Installation\n\n```bash\npip install gridnet\n```\n\n## Usage\n\n```py\nimport asyncio\n\nfrom gridnet import GridNet\n\n\nasync def main():\n    \"\"\"Show example on getting data from your device.\"\"\"\n    async with GridNet(\n        host=\"127.0.0.1\",\n    ) as client:\n        device = await client.device()\n        smartbridge = await client.smartbridge()\n        print(device)\n        print(smartbridge)\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\n## Data\n\nYou can read the following data with this package, the `power flow` entity can also\ngive a negative value. The `energy` entities are total values of both low and high\ntariff together.\n\n### Device\n\n- ID\n- Model\n- Batch\n- Firmware version\n- Hardware version\n- Manufacturer\n\n### SmartBridge\n\n- Power Flow (W)\n- Energy Consumption (kWh)\n- Energy Production (kWh)\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## Trademark Legal Notices\n\nAll product names, trademarks and registered trademarks in this repository, are\nproperty of their respective owners, and are used by the author for identification\npurposes only. The use of these names, trademarks and brands, do not imply endorsement\nor affiliation.\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[pure-energie]: https://pure-energie.nl\n[net2grid]: https://www.net2grid.com\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[build-shield]: https://github.com/klaasnicolaas/python-gridnet/actions/workflows/tests.yaml/badge.svg\n[build-url]: https://github.com/klaasnicolaas/python-gridnet/actions/workflows/tests.yaml\n[code-quality-shield]: https://github.com/klaasnicolaas/python-gridnet/actions/workflows/codeql.yaml/badge.svg\n[code-quality]: https://github.com/klaasnicolaas/python-gridnet/actions/workflows/codeql.yaml\n[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-gridnet.svg\n[commits-url]: https://github.com/klaasnicolaas/python-gridnet/commits/main\n[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-gridnet/branch/main/graph/badge.svg?token=CXCSJBsRPE\n[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-gridnet\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-gridnet\n[downloads-shield]: https://img.shields.io/pypi/dm/gridnet\n[downloads-url]: https://pypistats.org/packages/gridnet\n[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-gridnet.svg\n[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-gridnet.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg\n[maintainability-shield]: https://api.codeclimate.com/v1/badges/beb2e3ce851874fde45b/maintainability\n[maintainability-url]: https://codeclimate.com/github/klaasnicolaas/python-gridnet/maintainability\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg\n[pypi]: https://pypi.org/project/gridnet/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/gridnet\n[typing-shield]: https://github.com/klaasnicolaas/python-gridnet/actions/workflows/typing.yaml/badge.svg\n[typing-url]: https://github.com/klaasnicolaas/python-gridnet/actions/workflows/typing.yaml\n[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-gridnet.svg\n[releases]: https://github.com/klaasnicolaas/python-gridnet/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-gridnet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklaasnicolaas%2Fpython-gridnet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-gridnet/lists"}