🎉 Release of add-on Grott Beta branch (2.8) - An addon for Home Assistant to monitor Growatt inverters 0.1.3

README.md

@@ -59,10 +59,10 @@ For a general repository issue or add-on ideas [open an issue here][issue]
 
 
 
-[addon-grott-current]: https://github.com/egguy/addon-grott-beta/tree/v0.1.2
+[addon-grott-current]: https://github.com/egguy/addon-grott-beta/tree/v0.1.3
-[addon-doc-grott-current]: https://github.com/egguy/addon-grott-beta/blob/v0.1.2/README.md
+[addon-doc-grott-current]: https://github.com/egguy/addon-grott-beta/blob/v0.1.3/README.md
 [grott-current-issue]: https://github.com/egguy/addon-grott-beta/issues
-[grott-current-version-shield]: https://img.shields.io/badge/version-v0.1.2-blue.svg
+[grott-current-version-shield]: https://img.shields.io/badge/version-v0.1.3-blue.svg
 [grott-current-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
 [grott-current-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
 [grott-current-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg

grott-current/CHANGELOG.md

@@ -1,9 +1,8 @@
-# Changelog since v0.1.0
+## What’s changed
-- Corrected typo 
+## 🚀 Enhancements
-- Add multiple target for deploy 
+
-- Updated base 
+- Propagate deployment to the old repo @egguy (#3)
-- Updated deploy configuration 
+
-- Updated repository URL 
+## 📚 Documentation
-- Add edge 
+
-- ⬆️ Update alpine_3_18/python3 to v3.11.6-r0 
+- Add improved documentation @egguy (#4)
-- Add ref to stable repository 

grott-current/DOCS.md

@@ -1,30 +1,130 @@
 # Grott - Home Assistant native MQTT integration
 
-## Installation
+<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
+
+<!-- code_chunk_output -->
+
+- [Grott - Home Assistant native MQTT integration](#grott---home-assistant-native-mqtt-integration)
+  - [Requirements](#requirements)
+  - [Configuration of the Wi-Fi logger](#configuration-of-the-wi-fi-logger)
+  - [Configuration](#configuration)
+    - [Specific inverter configuration](#specific-inverter-configuration)
+    - [Multiple inverters configuration](#multiple-inverters-configuration)
+    - [External MQTT broker](#external-mqtt-broker)
+    - [Compatibility with homeassistant-grott](#compatibility-with-homeassistant-grott)
+  - [Configuration of grott](#configuration-of-grott)
+    - [PVOuput](#pvouput)
+
+<!-- /code_chunk_output -->
+
+## Requirements
+
+- A MQTT broker (e.g. the Mosquitto broker add-on)
+  - 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** add-on.
+- A Growatt inverter with a Wi-Fi module
+
+## Configuration of the Wi-Fi logger
+
+The IP to use is the IPv4 of home assistant. You can't use the DNS of home assistant. You need to use the IPv4.
+
+You can find this information in: **settings → system → network**, on **Configure network interfaces** click on the three dots and choose **IP Information**. You will see the IPv4 address.
+
+The IP address to use is the field **IP Address**. You need to remove the /XX at the end of the IP address. e.g.: **IP Address: 192.168.20.2/24** -> IP address to use: **192.168.20.2**
+
+Here some resources to configure your Wi-Fi logger:
+
+- [Rerouting Growatt Wi-Fi TCPIP data via your Grott Server](https://github.com/johanmeijer/grott/wiki/Rerouting-Growatt-Wifi-TCPIP-data-via-your-Grott-Server)
+- [Muppet3000 guide to reconfigure the stick](https://github.com/muppet3000/homeassistant-grott/blob/main/docs/setup/datalogger.md)
+
+## Configuration
+
+If you do a change of configuration. It is important to save and then restart the add-on.
+
+### Specific inverter configuration
+
+If you have multiple inverters, please refer to how to configure them in this documentation: [Multiple inverters configuration](#multiple-inverters-configuration)
+
+In the case you have one of the listed inverter types, you need a special configuration:
+
+- SPH
+  - SPH6000, SPH3000...
+- SPF
+  - SPF5000, SPF3000...
+- TL3
+  - TL3-X...
+- MAX
+  - MAX 100-150KTL3-X...
+
+The support for these inverters is available in grott 2.8
+
+- SPA
+  - SPA 4000-10000TL3
+- MIN
+  - MIN 2500-6000TL
+
+The setting to change is inverter type. You need to put the 3 letters of the inverter type in the configuration.
+
+e.g:
+
+- SPH6000 -> SPH
+- SPF5000 -> SPF
+- TL3-X -> TL3
+- MAX 100-150KTL3-X -> MAX
+- SPA 4000-10000TL3 -> SPA
+- MIN 2500-6000TL -> MIN
+
+### Multiple inverters configuration
+
+In the case of multiple inverters, you need to configure the inverter details in the add-on configuration. If you have only one inverter, you can leave the inverter details empty. Use the inverter type as described in the [Specific inverter configuration](#specific-inverter-configuration) section.
+
+You will have to get the serial number of the inverter. To achieve this, you can run grott in verbose mode and check the logs. You will see the serial number of the inverter in the logs.
+
+You can keep the default value for `invertype`, it will override it.
+
+The format is e.g.:
+
+```json
+{ "SERIAL": "TYPE", "SERIAL": "TYPE" }
+```
+
+It is important to respect the quotes and the comma to separate the inverters.
+
+e.g.:
+
+```json
+{ "NWO00415E3": "SPH", "DFO1231952": "MAX" }
+```
+
+### External MQTT broker
+
+If you are using an external MQTT broker, you need to configure the MQTT broker details in the add-on configuration. If you are using the Mosquitto broker add-onn, you can leave the MQTT broker details empty.
 
-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 add-on** fill in your MQTT details (leave empty when using the Mosquitto broker add-on). The format is e.g.: <br>
 
-   - 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
+   ```
 
-     ```yaml
+### Compatibility with homeassistant-grott
-     host: <IP>
-     port: 1883
-     user: my_user
-     password: my_password
-     ```
 
-   - Click **Save**
+Muppet3000 has created a custom component for Home Assistant. This component is called [homeassistant-grott](https://github.com/muppet3000/homeassistant-grott). It is compatible with this add-on.
-   - **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>
+You can use the add-on and the component at the same time. This will make the deployment of grott and configuration a bit easier.
-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)
+You can activate the compatibility mode by checking: **Enable grott MQTT** in the configuration, and then follow the instruction to install and activate the extension.
-   - Use the local IP of your home assistant
+
-   - Don't use a DNS, the datalogger can't resolve `homeassistant.local`
+It is recommended to deactivate the **Home Assistant plugin** in the configuration. This can lead to duplicate sensors.
+
+## Configuration of grott
+
+The add-on creates a folder in home assistant. You can find it in the `/config/grott` folder of your home assistant instance.
+
+You can create/modify the `grott.ini` using the file editor add-on or VS Code add-on. This allows you to add pvoutput support or to add a custom JSON layout.
+
+### PVOuput
+
+[How to configure PVOutput](https://github.com/johanmeijer/grott/wiki/PVOutput.org-support)

grott-current/README.md

@@ -2,38 +2,18 @@
 
 ![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
 
-
-
 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
+This addon is based on the 2.8 Branch of [grott](https://github.com/johanmeijer/grott) code and current grott_ha extension.
-[grott](https://github.com/johanmeijer/grott) code
-and current grott_ha extension.
 
-## WARNING! THIS IS AN EDGE VERSION!
+[:books: Read the full add-on documentation][docs]
-
-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-b6f2f24-blue.svg
+[release-shield]: https://img.shields.io/badge/version-v0.1.3-blue.svg
-[release]: https://github.com/egguy/addon-grott/tree/b6f2f24
+[release]: https://github.com/egguy/addon-grott-beta/tree/v0.1.3
+[docs]: https://github.com/egguy/addon-grott-beta/blob/main/grott-beta/DOCS.md

grott-current/config.yaml

@@ -1,20 +1,19 @@
----
+name: Grott Beta branch (2.8) - An addon for Home Assistant to monitor Growatt inverters
-name: grott
+version: 0.1.3
-version: 0.1.2
+slug: grott-beta
-slug: grott-current
 description: The Growatt inverter monitor with current HA plugin integrated
-url: https://github.com/egguy/addon-grott
+url: https://github.com/egguy/addon-grott-beta
 arch:
-  - armhf
+- armhf
-  - armv7
+- armv7
-  - aarch64
+- aarch64
-  - amd64
+- amd64
-  - i386
+- i386
 services:
-  - mqtt:need
+- mqtt:need
 init: false
 map:
-  - config:rw
+- config:rw
 ports:
   5279/tcp: 5279
 ports_description:
@@ -24,7 +23,7 @@ options:
   gmode: proxy
   grott_mqtt: false
   ginvtype: default
-  ginvtypemap: ""
+  ginvtypemap: ''
   retain: false
   verbose: false
   ha_plugin: true
@@ -84,4 +83,4 @@ schema:
     user: str?
     password: str?
   data_path: str
-image: ghcr.io/egguy/grott/{arch}
+image: ghcr.io/egguy/grott-beta/{arch}