{"id":17231660,"url":"https://github.com/jmccrohan/pysolarmanv5","last_synced_at":"2025-05-15T19:01:42.274Z","repository":{"id":37274109,"uuid":"429008576","full_name":"jmccrohan/pysolarmanv5","owner":"jmccrohan","description":"A python module to interact with Solarman Data Logging Sticks","archived":false,"fork":false,"pushed_at":"2025-04-21T22:42:02.000Z","size":215,"stargazers_count":145,"open_issues_count":5,"forks_count":34,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-04-21T23:32:43.284Z","etag":null,"topics":["inverter","modbus","pysolarmanv5","python","solar","solarman"],"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/jmccrohan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-11-17T10:53:52.000Z","updated_at":"2025-04-21T22:42:05.000Z","dependencies_parsed_at":"2024-05-02T20:48:34.186Z","dependency_job_id":"fb721188-cf4d-4839-b1f1-b29fbba6969a","html_url":"https://github.com/jmccrohan/pysolarmanv5","commit_stats":{"total_commits":172,"total_committers":6,"mean_commits":"28.666666666666668","dds":"0.33720930232558144","last_synced_commit":"f4d054b1c2d2eb677e352269580e31bc88c60a0b"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmccrohan%2Fpysolarmanv5","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmccrohan%2Fpysolarmanv5/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmccrohan%2Fpysolarmanv5/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmccrohan%2Fpysolarmanv5/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmccrohan","download_url":"https://codeload.github.com/jmccrohan/pysolarmanv5/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254404337,"owners_count":22065639,"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":["inverter","modbus","pysolarmanv5","python","solar","solarman"],"created_at":"2024-10-15T04:58:10.829Z","updated_at":"2025-05-15T19:01:42.265Z","avatar_url":"https://github.com/jmccrohan.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pysolarmanv5\n\nThis is a Python module to interact with Solarman (IGEN-Tech) v5 based solar\ninverter data loggers. Modbus RTU frames can be encapsulated in the proprietary\nSolarman v5 protocol and requests sent to the data logger on port tcp/8899.\n\nThis module aims to simplify the Solarman v5 protocol, exposing both sync and\nasync interfaces similar to that of the [uModbus](https://github.com/AdvancedClimateSystems/uModbus)\nlibrary.\n\nDetails of the Solarman v5 protocol have been based on the excellent work of\n[Inverter-Data-Logger by XtheOne](https://github.com/XtheOne/Inverter-Data-Logger/)\nand others.\n\n## Documentation\n\npysolarmanv5 documentation is available on [Read the Docs](https://pysolarmanv5.readthedocs.io/).\n\nThe Solarman V5 protocol is documented [here](https://pysolarmanv5.readthedocs.io/en/latest/solarmanv5_protocol.html).\n\n## Supported Devices\n\nA user contributed list of supported devices is available [here](https://github.com/jmccrohan/pysolarmanv5/issues/11).\n\nIf you are unsure if your device is supported, please use the [solarman_scan](https://github.com/jmccrohan/pysolarmanv5/blob/main/utils/solarman_scan.py) \nutility to find compatible data logging sticks on your local network.\n\nPlease note that the **Solis S3-WIFI-ST** data logging stick is **NOT supported**.  \nSee [GH issue #8](https://github.com/jmccrohan/pysolarmanv5/issues/8) for further information. \n\nSome Ethernet data logging sticks have native support Modbus TCP and therefore **do not require pysolarmanv5**.\nSee [GH issue #5](https://github.com/jmccrohan/pysolarmanv5/issues/5) for further information. \n\n## Dependencies\n\n- pysolarmanv5 requires Python 3.8 or greater.\n- pysolarmanv5 depends on [uModbus](https://github.com/AdvancedClimateSystems/uModbus).\n\n## Installation\n\nTo install the latest stable version of pysolarmanv5 from PyPi, run:\n\n`pip install pysolarmanv5`\n\nTo install the latest development version from git, run:\n\n`pip install git+https://github.com/jmccrohan/pysolarmanv5.git`\n\nThis will also install the tools from the [utils](/utils) directory.\n\n## Docker\n\nTo run the tools in the docker image, run:\n\n`docker run --rm ghcr.io/jmccrohan/pysolarmanv5:latest`\n\n## Projects using pysolarmanv5\n\n- [davidrapan/ha-solarman](https://github.com/davidrapan/ha-solarman)\n- [StephanJoubert/home_assistant_solarman](https://github.com/StephanJoubert/home_assistant_solarman)\n- [NosIreland/solismon3](https://github.com/NosIreland/solismon3)\n- [NosIreland/solismod](https://github.com/NosIreland/solismod)\n- [jmccrohan/ha_pyscript_pysolarmanv5](https://github.com/jmccrohan/ha_pyscript_pysolarmanv5)\n- [YodaDaCoda/hass-solarman-modbus](https://github.com/YodaDaCoda/hass-solarman-modbus)\n- [schwatter/solarman_mqtt](https://github.com/schwatter/solarman_mqtt)\n- [RonnyKempe/solismon](https://github.com/RonnyKempe/solismon)\n- [toledobastos/solarman_battery_autocharge](https://github.com/toledobastos/solarman_battery_autocharge)\n- [AndyTaylorTweet/solis2mqtt](https://github.com/AndyTaylorTweet/solis2mqtt)\n- [pixellos/codereinvented.automation.py](https://github.com/pixellos/codereinvented.automation.py)\n- [cjgwhite/hass-solar](https://github.com/cjgwhite/hass-solar)\n- [imcfarla2003/solarconfig](https://github.com/imcfarla2003/solarconfig)\n- [githubDante/deye-controller](https://github.com/githubDante/deye-controller)\n- [danfoster/solis](https://github.com/danfoster/solis)\n\n## Contributions\n\nContributions welcome. Please raise any Issues / Pull Requests via [Github](https://github.com/jmccrohan/pysolarmanv5).\n\n## License\n\npysolarmanv5 is licensed under the [MIT License](https://github.com/jmccrohan/pysolarmanv5/blob/master/LICENSE). Copyright (c) 2024 Jonathan McCrohan\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmccrohan%2Fpysolarmanv5","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmccrohan%2Fpysolarmanv5","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmccrohan%2Fpysolarmanv5/lists"}