This custom component for home assistant 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.
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.
This component will set up the following platforms.
| Platform | Description |
|---|---|
sensor |
Show info from SunSpec API. |
- Add and search for sunspec in HACS
- Install
- Using the tool of choice open the directory (folder) for your HA configuration (where you find
configuration.yaml). - If you do not have a
custom_componentsdirectory (folder) there, you need to create it. - In the
custom_componentsdirectory (folder) create a new folder calledsunspec. - Download all the files from the
custom_components/sunspec/directory (folder) in this repository. - Place the files you downloaded in the new directory (folder) you created.
- Restart Home Assistant
- 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:
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
If you want to contribute to this please read the Contribution guidelines
This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.
Code template was mainly taken from @Ludeeus's integration_blueprint template