Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cjne/ha-sunspec

Home Assistant customcomponent for SunSpec modbus devices
https://github.com/cjne/ha-sunspec

custom-component home-assistant sunspec

Last synced: 5 days ago
JSON representation

Home Assistant customcomponent for SunSpec modbus devices

Awesome Lists containing this project

README 

        
# SunSpec



This 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/).



It will auto discover and create sensors depending on the available data of the device.

By default only the most common sensors are created, there is an optional configuration that lets you control exactly what data to use.



Currenlty supports Modbus TCP connections. Modbus serial connection is planned.



Works out of the box with the energy dashboard.



[![GitHub Release][releases-shield]][releases]

[![GitHub Activity][commits-shield]][commits]

[![License][license-shield]](LICENSE)



[![pre-commit][pre-commit-shield]][pre-commit]

[![Black][black-shield]][black]



[![hacs][hacsbadge]][hacs]

[![Project Maintenance][maintenance-shield]][user_profile]

[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]



[![Discord][discord-shield]][discord]

[![Community Forum][forum-shield]][forum]



**This component will set up the following platforms.**



| Platform | Description                 |

| -------- | --------------------------- |

| `sensor` | Show info from SunSpec API. |



![logo][logoimg]



## HACS Installation



1. Add and search for sunspec in [HACS](https://hacs.xyz/)

2. Install



## Manual Installation



1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`).

2. If you do not have a `custom_components` directory (folder) there, you need to create it.

3. In the `custom_components` directory (folder) create a new folder called `sunspec`.

4. Download _all_ the files from the `custom_components/sunspec/` directory (folder) in this repository.

5. Place the files you downloaded in the new directory (folder) you created.

6. Restart Home Assistant

7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "SunSpec"



Using your HA configuration directory (folder) as a starting point you should now also have this:



```text

custom_components/sunspec/translations/en.json

custom_components/sunspec/__init__.py

custom_components/sunspec/api.py

custom_components/sunspec/config_flow.py

custom_components/sunspec/const.py

custom_components/sunspec/entity.py

custom_components/sunspec/manifest.json

custom_components/sunspec/sensor.py

```



## Configuration is done in the UI



## Contributions are welcome!



If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)



## Credits



This project was generated from [@oncleben31](https://github.com/oncleben31)'s [Home Assistant Custom Component Cookiecutter](https://github.com/oncleben31/cookiecutter-homeassistant-custom-component) template.



Code template was mainly taken from [@Ludeeus](https://github.com/ludeeus)'s [integration_blueprint][integration_blueprint] template



---



[integration_blueprint]: https://github.com/custom-components/integration_blueprint

[black]: https://github.com/psf/black

[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge

[buymecoffee]: https://www.buymeacoffee.com/cjne.coffee

[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge

[commits-shield]: https://img.shields.io/github/commit-activity/y/cjne/ha-sunspec.svg?style=for-the-badge

[commits]: https://github.com/cjne/ha-sunspec/commits/main

[hacs]: https://hacs.xyz

[hacsbadge]: https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge

[discord]: https://discord.gg/Qa5fW2R

[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge

[logoimg]: logo.png

[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge

[forum]: https://community.home-assistant.io/

[license-shield]: https://img.shields.io/github/license/cjne/ha-sunspec.svg?style=for-the-badge

[maintenance-shield]: https://img.shields.io/badge/maintainer-%40cjne-blue.svg?style=for-the-badge

[pre-commit]: https://github.com/pre-commit/pre-commit

[pre-commit-shield]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=for-the-badge

[releases-shield]: https://img.shields.io/github/release/cjne/ha-sunspec.svg?style=for-the-badge

[releases]: https://github.com/cjne/ha-sunspec/releases

[user_profile]: https://github.com/cjne