Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mukaschultze/ha-must-inverter
Must Inverter plugin for HomeAssistant
https://github.com/mukaschultze/ha-must-inverter
battery-monitor hacs hacs-integration home-assistant homeassistant inverter modbus must must-energy must-solar power solar solar-energy
Last synced: 12 days ago
JSON representation
Must Inverter plugin for HomeAssistant
- Host: GitHub
- URL: https://github.com/mukaschultze/ha-must-inverter
- Owner: mukaschultze
- License: mit
- Created: 2024-01-15T20:15:53.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-07-10T13:28:26.000Z (4 months ago)
- Last Synced: 2024-10-30T03:03:18.354Z (14 days ago)
- Topics: battery-monitor, hacs, hacs-integration, home-assistant, homeassistant, inverter, modbus, must, must-energy, must-solar, power, solar, solar-energy
- Language: Python
- Homepage:
- Size: 88.9 KB
- Stars: 26
- Watchers: 4
- Forks: 4
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Must inverter integration for Home Assistant
[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![License][license-shield]](LICENSE)
![Project Maintenance][maintenance-shield]
[][buymecoffee]
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=mukaschultze&repository=ha-must-inverter&category=integration)
The Home Assistant Must Solar Inverter Plugin is a custom integration that adds support for monitoring and controlling
Must solar inverters within the Home Assistant platform. This plugin enables you to retrieve real-time data, such as
power production, battery status, and more, directly from your Must solar inverter.
## Features
- **Real-time Monitoring**: View live data from your Must solar inverter, including power production, battery status, and other relevant information.
- **Integration with Home Assistant**: Seamlessly integrate Must solar inverter data into your Home Assistant setup.
- **Control Functionality**: Control certain aspects of your Must solar inverter directly through Home Assistant.
|  |  |
| :-------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: |
## Supported Devices
This integration is tested using a Must Solar PV18-3024 VPM (aka PV1800). However, it should work with other models that
use the same communication protocol, such as the PH1800 and EP1800 series.
This integration will have the wrong min and max range for writable voltages when using it with 12v or 48v inverters
(mostly because my model is 24v and I don't own other models to reverse engineer). If you see some values that don't
make sense for your inverter, please open an issue or a pull request.
## Disclaimer
This integration is not officially supported by Must Solar, I'm not affiliated with Must Solar in any way. This
integration is based on reverse engineering the communication protocol used by the Must Solar inverters and by resources
found online. Use it at your own risk.
> [!CAUTION]
> There are some modbus registers that cannot be reversed to their original value after being written and can have a
> huge effect on the inverter operation, such as the calibration coefficients (these entities are disabled by default).
> This integration **DOES NOT** write any information to the device via modbus unless you manually change an entity value.
## Installation
### HACS (Home Assistant Community Store)
If you have HACS just search for `Must Inverter` and install it from there. Or alternatively, [click here](https://my.home-assistant.io/redirect/hacs_repository/?owner=mukaschultze&repository=ha-must-inverter&category=integration).
### Manual Installation
1. Download the [latest release](https://github.com/mukaschultze/ha-must-inverter/releases/latest) from the GitHub repository.
2. Extract the downloaded archive.
3. Copy the `custom_components/must_inverter` directory to your Home Assistant config directory.
4. Restart Home Assistant.
After a correct installation, your configuration directory should look like this:
```text
└── ...
└── configuration.yaml
└── secrets.yaml
└── custom_components
└── must_inverter
└── __init__.py
└── config_flow.py
└── const.py
└── ...
```
## Usage
1. Open the Home Assistant UI.
2. Navigate to "Configuration" -> "Integrations."
3. Click the "+" button to add a new integration.
4. Search for "Must Inverter" and select it.
5. Enter the required configuration for your serial setup (USB, TCP, or UDP).
## Support and Contributions
For bug reports, feature requests, or general questions, please create an issue on the GitHub repository.
Contributions are welcome! Feel free to fork the repository, make changes, and submit a pull request.
## Acknowledgments
This plugin would not have been possible without the valuable contributions of the following individuals and their projects on reversing engineering the Must solar inverter:
- https://github.com/aquarat/must_inverter
- https://github.com/dylangmiles/docker-must-homeassistant
- https://github.com/thelabexpedition67/MustInverterDataHandler
Their efforts have paved the way for the development of this Home Assistant integration.
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
---
[integration_blueprint]: https://github.com/mukaschultze/ha-must-inverter
[buymecoffee]: https://www.buymeacoffee.com/mukaschultze
[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/mukaschultze/ha-must-inverter.svg?style=for-the-badge
[commits]: https://github.com/mukaschultze/ha-must-inverter/commits/main
[discord]: https://discord.gg/Qa5fW2R
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge
[exampleimg]: example.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/mukaschultze/ha-must-inverter.svg?style=for-the-badge
[maintenance-shield]: https://img.shields.io/badge/maintainer-%40mukaschultze-blue.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/mukaschultze/ha-must-inverter.svg?style=for-the-badge
[releases]: https://github.com/mukaschultze/ha-must-inverter/releases