{"id":37063670,"url":"https://github.com/nmakel/solaredge_setapp","last_synced_at":"2026-01-14T07:17:03.395Z","repository":{"id":57469187,"uuid":"189741295","full_name":"nmakel/solaredge_setapp","owner":"nmakel","description":"SolarEdge SetApp protocol buffers parser library","archived":true,"fork":false,"pushed_at":"2021-02-06T21:28:32.000Z","size":324,"stargazers_count":15,"open_issues_count":2,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-09-14T08:18:53.818Z","etag":null,"topics":["protobuf","setapp","solaredge","solaredge-api"],"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/nmakel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-01T14:18:57.000Z","updated_at":"2025-06-16T21:38:32.000Z","dependencies_parsed_at":"2022-09-19T10:10:34.357Z","dependency_job_id":null,"html_url":"https://github.com/nmakel/solaredge_setapp","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/nmakel/solaredge_setapp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmakel%2Fsolaredge_setapp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmakel%2Fsolaredge_setapp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmakel%2Fsolaredge_setapp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmakel%2Fsolaredge_setapp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nmakel","download_url":"https://codeload.github.com/nmakel/solaredge_setapp/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmakel%2Fsolaredge_setapp/sbom","scorecard":{"id":690777,"data":{"date":"2025-08-11","repo":{"name":"github.com/nmakel/solaredge_setapp","commit":"ac5ac7ba69211ffec94597d2f51573e52d5e7ede"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"Code-Review","score":0,"reason":"Found 1/29 approved changesets -- score normalized to 0","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":"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":"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":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"Vulnerabilities","score":4,"reason":"6 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2022-48 / GHSA-77rm-9x9h-xj3g","Warn: Project is vulnerable to: GHSA-8gq9-2x98-w8hf","Warn: Project is vulnerable to: GHSA-8qvm-5x2c-j2w7","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 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-22T02:15:13.336Z","repository_id":57469187,"created_at":"2025-08-22T02:15:13.336Z","updated_at":"2025-08-22T02:15:13.336Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28412779,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T05:26:33.345Z","status":"ssl_error","status_checked_at":"2026-01-14T05:21:57.251Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["protobuf","setapp","solaredge","solaredge-api"],"created_at":"2026-01-14T07:17:02.768Z","updated_at":"2026-01-14T07:17:03.386Z","avatar_url":"https://github.com/nmakel.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# solaredge_setapp\n\nsolaredge_setapp is a python library that parses inverter and power optimizer data from a compatible SolarEdge PV inverter. Only those models which support SetApp commissioning are supported.\n\nThis project is built on the efforts of others: for Home Assistant users, see drobtravels' \u003ca href=\"https://github.com/drobtravels/solaredge-local\"\u003esolaredge_local\u003c/a\u003e, and jbuehl's \u003ca href=\"https://github.com/jbuehl/solaredge\"\u003esolaredge\u003c/a\u003e for all non-SetApp power inverters. Developed and tested on a European SE3500H-RW000BNN4 SolarEdge single-phase inverter. If you instead want to monitor the official SolarEdge Modbus API, you could try \u003ca href=\"https://github.com/nmakel/solaredge_modbus\"\u003esolaredge_modbus\u003c/a\u003e.\n\nCurrent WSA target: **1.6.9** (firmware **4.10.25**)\n\nRelease 0.0.7 and earlier are compatible with WSA \u003c= 1.3.9.\n\n### Reduced access to the SetApp API (2020-04-23)\n\nThe SetApp commissioning API with which this software communicates is used primarily by the SetApp utility on smartphones. For many users the commissioning API was *also* available through the ethernet and WiFi interfaces due to their inverter being in **debug mode**. As of 2020-03 SolarEdge has been systematically turning off debug mode on inverters.\n\nAccess to the commissioning API remains possible, however: by connecting to the inverter on the temporary WiFi access point created for the SetApp commissioning utility. This network can be activated by switching the 0/1/P button to P for *one second*. The WiFi network, whose name is displayed in the SetApp utility, and the password to which is printed on the label on the side of the inverter, still provides access to the SetApp API on port 80 as before. Once connected to this network it can be kept active by regularly requesting any API endpoint. Lack of activity causes this network to disconnect.\n\nThose users with inverters still in debug mode might consider disconnecting their inverter \u0026mdash; or otherwise firewall outbound connections \u0026mdash; in order to prevent remote updates from disabling debug mode.\n\n## Installation\n\nTo install, either clone this project and install using `setuptools`:\n\n```python3 setup.py install```\n\nor install the package from PyPi:\n\n```pip3 install solaredge_setapp```\n\n## Usage\n\nSee `example.py` how to fetch, parse, and display the SetApp protobuf files exposed by the SetApp API.\n\n```python3 example.py your-inverter-ip```\n\nFor a complete JSON dump of all parsed values from all endpoints, try `dump_all.py`:\n\n```python3 dump_all.py your-inverter-ip```\n\nBasic usage of the **status** API endpoint:\n\n```\nimport solaredge_setapp\nimport requests\n\ninverter_ip = \"10.0.0.1\"\n\nstatus_request = requests.get(f\"http://{inverter_ip}/web/v1/status\").content\nstatus = solaredge_setapp.status.Status(status_request)\n\nprint(f\"Inverter {status['serial']} is {status['status']} at {status['power_ac']:.2f}W\")\n```\n\nSee the relevant `.proto` file in `solaredge_setapp/messages/`, and `solaredge_setapp/%endpoint%.py` for all fields that are parsed for that particular endpoint.\n\nThe following API endpoints contain most of the useful information, and are therefore the primary focus:\n\n* **information** - web/v1/information - CPU and DSP versions, error logging\n* **maintenance** - web/v1/maintenance - power optimizer telemetry\n* **status** - web/v1/status - inverter and energy statistics\n\nThe remaining endpoints mostly concern functionality of the commissioning interface itself, and are therefore not implemented:\n\n* **app_configs** - web/v1/app_configs - language and functionality\n* **communication** - web/v1/communication - ethernet, wifi and RS485 settings\n* **grid_protection** - web/v1/grid_protection - grid protection settings\n* **power_control** - web/v1/power_control - grid power settings\n* **region** - web/v1/region - language and country settings\n\n\n## Working on protobuf messages\n\nIn order to use `compile_proto.sh` to (re)compile the protocol buffer `.proto` message definitions you will need `protoc`, which is provided, for example, by Ubuntu's `protobuf-compiler` package. *(Re-)compiling the protobuf messages is only necessary if you have made local changes to them.*\n\nYou can test changes to .proto files directly by passing raw protobuf to `protoc`:\n\n```curl -s http://your-inverter-ip/web/v1/status | protoc --decode Status messages/status.proto```\n\n## Limitations\n\nThe SetApp API does not (yet) provide real-time power optimizer data. Initial results suggest the data is 5-15 minutes old. Inverter production and voltage information is near real-time, however. Basically, the entire information set visible on the inverter's SetApp web interface is available through this library, in addition to per optimizer voltages and temperatures. Power optimizer voltages and current are expressed as integers, and are therefore not entirely accurate.\n\nRate limiting will kick in if you have the SetApp web interface open while using this library.\n\nThe SetApp API is new, and therefore likely to change. Variable naming, distribution, and parsing is likely to change.\n\n## Contributing\n\nContributions are more than welcome, especially to the protocol buffer message definitions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnmakel%2Fsolaredge_setapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnmakel%2Fsolaredge_setapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnmakel%2Fsolaredge_setapp/lists"}