{"id":21749643,"url":"https://github.com/cjne/ha-sunspec","last_synced_at":"2025-04-07T06:10:39.403Z","repository":{"id":38208220,"uuid":"373101151","full_name":"CJNE/ha-sunspec","owner":"CJNE","description":"Home Assistant customcomponent for SunSpec modbus devices","archived":false,"fork":false,"pushed_at":"2024-10-28T05:43:54.000Z","size":526,"stargazers_count":68,"open_issues_count":51,"forks_count":18,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-03-31T05:04:37.205Z","etag":null,"topics":["custom-component","home-assistant","sunspec"],"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/CJNE.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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}},"created_at":"2021-06-02T09:01:54.000Z","updated_at":"2025-02-12T19:48:05.000Z","dependencies_parsed_at":"2024-01-16T00:31:15.371Z","dependency_job_id":"18a04d03-b154-414e-bb55-4e7bfb91a98d","html_url":"https://github.com/CJNE/ha-sunspec","commit_stats":{"total_commits":197,"total_committers":7,"mean_commits":"28.142857142857142","dds":0.5177664974619289,"last_synced_commit":"1a0991f3a3473621154a69ce7a2bd40f4c148a1b"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CJNE%2Fha-sunspec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CJNE%2Fha-sunspec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CJNE%2Fha-sunspec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CJNE%2Fha-sunspec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CJNE","download_url":"https://codeload.github.com/CJNE/ha-sunspec/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247601448,"owners_count":20964864,"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":["custom-component","home-assistant","sunspec"],"created_at":"2024-11-26T08:42:24.069Z","updated_at":"2025-04-07T06:10:39.372Z","avatar_url":"https://github.com/CJNE.png","language":"Python","funding_links":["https://www.buymeacoffee.com/cjne.coffee"],"categories":[],"sub_categories":[],"readme":"# SunSpec\n\nThis custom component for [home assistant](https://home-assistant.io/) will let you monitor any SunSpec Modbus compliant device, most commonly a solar inverter or energy meter. A list of compliant devices and manufacturers can be found on the [sunspec website](https://sunspec.org/sunspec-modbus-certified-products/).\n\nIt will auto discover and create sensors depending on the available data of the device.\nBy default only the most common sensors are created, there is an optional configuration that lets you control exactly what data to use.\n\nCurrenlty supports Modbus TCP connections. Modbus serial connection is planned.\n\nWorks out of the box with the energy dashboard.\n\n[![GitHub Release][releases-shield]][releases]\n[![GitHub Activity][commits-shield]][commits]\n[![License][license-shield]](LICENSE)\n\n[![pre-commit][pre-commit-shield]][pre-commit]\n[![Black][black-shield]][black]\n\n[![hacs][hacsbadge]][hacs]\n[![Project Maintenance][maintenance-shield]][user_profile]\n[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]\n\n[![Discord][discord-shield]][discord]\n[![Community Forum][forum-shield]][forum]\n\n**This component will set up the following platforms.**\n\n| Platform | Description                 |\n| -------- | --------------------------- |\n| `sensor` | Show info from SunSpec API. |\n\n![logo][logoimg]\n\n## HACS Installation\n\n1. Add and search for sunspec in [HACS](https://hacs.xyz/)\n2. Install\n\n## Manual Installation\n\n1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`).\n2. If you do not have a `custom_components` directory (folder) there, you need to create it.\n3. In the `custom_components` directory (folder) create a new folder called `sunspec`.\n4. Download _all_ the files from the `custom_components/sunspec/` directory (folder) in this repository.\n5. Place the files you downloaded in the new directory (folder) you created.\n6. Restart Home Assistant\n7. In the HA UI go to \"Configuration\" -\u003e \"Integrations\" click \"+\" and search for \"SunSpec\"\n\nUsing your HA configuration directory (folder) as a starting point you should now also have this:\n\n```text\ncustom_components/sunspec/translations/en.json\ncustom_components/sunspec/__init__.py\ncustom_components/sunspec/api.py\ncustom_components/sunspec/config_flow.py\ncustom_components/sunspec/const.py\ncustom_components/sunspec/entity.py\ncustom_components/sunspec/manifest.json\ncustom_components/sunspec/sensor.py\n```\n\n## Configuration is done in the UI\n\n\u003c!----\u003e\n\n## Contributions are welcome!\n\nIf you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)\n\n## Credits\n\nThis project was generated from [@oncleben31](https://github.com/oncleben31)'s [Home Assistant Custom Component Cookiecutter](https://github.com/oncleben31/cookiecutter-homeassistant-custom-component) template.\n\nCode template was mainly taken from [@Ludeeus](https://github.com/ludeeus)'s [integration_blueprint][integration_blueprint] template\n\n---\n\n[integration_blueprint]: https://github.com/custom-components/integration_blueprint\n[black]: https://github.com/psf/black\n[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge\n[buymecoffee]: https://www.buymeacoffee.com/cjne.coffee\n[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge\n[commits-shield]: https://img.shields.io/github/commit-activity/y/cjne/ha-sunspec.svg?style=for-the-badge\n[commits]: https://github.com/cjne/ha-sunspec/commits/main\n[hacs]: https://hacs.xyz\n[hacsbadge]: https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge\n[discord]: https://discord.gg/Qa5fW2R\n[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge\n[logoimg]: logo.png\n[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge\n[forum]: https://community.home-assistant.io/\n[license-shield]: https://img.shields.io/github/license/cjne/ha-sunspec.svg?style=for-the-badge\n[maintenance-shield]: https://img.shields.io/badge/maintainer-%40cjne-blue.svg?style=for-the-badge\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[pre-commit-shield]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=for-the-badge\n[releases-shield]: https://img.shields.io/github/release/cjne/ha-sunspec.svg?style=for-the-badge\n[releases]: https://github.com/cjne/ha-sunspec/releases\n[user_profile]: https://github.com/cjne\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcjne%2Fha-sunspec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcjne%2Fha-sunspec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcjne%2Fha-sunspec/lists"}