forked from Maes152/grott-home-assistant-add-on
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
83 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,10 @@ | ||
# Changelog | ||
|
||
## 0.6 | ||
|
||
- Updated the branch used by grott | ||
|
||
## 0.5 | ||
|
||
- Change to use pip3 with the newest addon image. | ||
|
||
## 0.3 | ||
|
||
- Add translations | ||
- Moved the ginvtypemap to the top configuration | ||
|
||
## 0.2 | ||
|
||
- Based on grott v2.7.7 | ||
- use the current grott_ha.py plugins | ||
- Auto configuration for the MQTT part | ||
|
||
## 0.1 | ||
|
||
- Initial version | ||
- Based on grott v2.7.6 | ||
# Changelog since v0.1.0 | ||
- ⬆️ Update Add-on base image to v14.2.1 | ||
- Corrected typo | ||
- Add multiple target for deploy | ||
- Updated base | ||
- Updated deploy configuration | ||
- Updated repository URL | ||
- Add edge | ||
- ⬆️ Update alpine_3_18/python3 to v3.11.6-r0 | ||
- Add ref to stable repository |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,30 @@ | ||
# Home Assistant Add-on: Grott - The Growatt inverter monitor | ||
# Grott - Home Assistant native MQTT integration | ||
|
||
## Installation | ||
|
||
Follow these steps to get the add-on installed on your system: | ||
|
||
1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**. | ||
2. Find the "Grott" add-on and click it. | ||
3. Click on the "INSTALL" button. | ||
|
||
## How to use | ||
|
||
The add-on has a couple of options available. To get the add-on running: | ||
|
||
1. Start the add-on. | ||
2. Have some patience and wait a couple of minutes. | ||
3. Check the add-on log output to see the result. | ||
|
||
## Add-on configuration: | ||
|
||
All options from grott are available as options in this add-on. They need to follow the naming convention of the environment variables. Eg: | ||
|
||
```yaml | ||
gmode: proxy | ||
gnomqtt: False | ||
gmqttip: 127.0.0.1 | ||
gmqttport: 5288 | ||
gmqttauth: False | ||
gmqtttopic: energy/grott | ||
gmqttuser: user | ||
gmqttpassword: password | ||
``` | ||
1. If you don't have an MQTT broker yet; in Home Assistant go to **Settings → Add-ons → Add-on store** and install the **Mosquitto broker** addon. | ||
1. Go back to the **Add-on store**, click **⋮ → Repositories**, fill in</br> `https://github.com/egguy/grott-home-assistant-add-on` and click **Add → Close** or click the **Add repository** button below, click **Add → Close** (You might need to enter the **internal IP address** of your Home Assistant instance first). | ||
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fegguy%2Fgrott-home-assistant-add-on) | ||
1. The repository includes two add-ons: | ||
- **grott** is the stable release that tracks the released versions of grott HA plugin. | ||
- **grott Edge** tracks the `dev` branch of grott HA plugin such that you can install the edge version if there are features or fixes in the grott HA dev branch that are not yet released. (**recommended for most users**) | ||
1. Click on the addon and press **Install** and wait till the addon is installed. | ||
1. Click on **Configuration** | ||
|
||
- If you are **not** using the Mosquitto broker addon fill in your MQTT details (leave empty when using the Mosquitto broker addon). Format is e.g.: <br> | ||
|
||
```yaml | ||
host: <IP> | ||
port: 1883 | ||
user: my_user | ||
password: my_password | ||
``` | ||
|
||
- Click **Save** | ||
- **Tip:** it is possible to refer to variables in the Home Assistant `secrets.yaml` file by using e.g. `password: '!secret mqtt_pass'` | ||
|
||
1. If multiple inverters, please refer on how to configure them on this documentation: <https://github.com/johanmeijer/grott/wiki/Multi-Inverter-support> | ||
1. Start the addon by going to **Info** and click **Start** | ||
1. Configure your data logger using the information contained here: [Rerouting Growatt Wifi TCPIP data via your Grott Server](https://github.com/johanmeijer/grott/wiki/Rerouting-Growatt-Wifi-TCPIP-data-via-your-Grott-Server) | ||
- Use the local IP of your home assistant | ||
- Don't use a DNS, the datalogger can't resolve `homeassistant.local` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,39 @@ | ||
# The Growatt Inverter Monitor - HA addon | ||
# Grott - Home Assistant native MQTT integration | ||
|
||
This addon allow you to run a local version of grott with the HA plugin and auto discovery enabled. | ||
![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] | ||
|
||
The data is fowarded to the growatt's server. The grott server decode them and send them to your HA instance. | ||
|
||
This addon is based on the 2.7.8 [grott](https://github.com/johanmeijer/grott) code and included grott_ha extension. | ||
|
||
This addon allow you to run a local version of grott with the HA plugin | ||
and auto discovery enabled. | ||
|
||
The data is fowarded to the growatt's server. | ||
The grott server decode them and send them to your HA instance. | ||
|
||
This addon is based on the 2.7.8 | ||
[grott](https://github.com/johanmeijer/grott) code | ||
and current grott_ha extension. | ||
|
||
## WARNING! THIS IS AN EDGE VERSION! | ||
|
||
This Home Assistant Add-ons repository contains edge builds of add-ons. | ||
Edge builds add-ons are based upon the latest development version. | ||
|
||
- They may not work at all. | ||
- They might stop working at any time. | ||
- They could have a negative impact on your system. | ||
|
||
This repository was created for: | ||
|
||
- Anybody willing to test. | ||
- Anybody interested in trying out upcoming add-ons or add-on features. | ||
- Developers. | ||
|
||
If you are more interested in stable releases of our add-ons: | ||
|
||
<https://github.com/egguy/ha-addons> | ||
|
||
|
||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg | ||
[release-shield]: https://img.shields.io/badge/version-044729b-blue.svg | ||
[release]: https://github.com/egguy/addon-grott/tree/044729b |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters