diff --git a/README.md b/README.md index ff9bd80..7426394 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,19 @@ This addon allow you to have all the entities automatically created. ## Add-ons provided by this repository +### ✓ [Grott Beta branch (2.8)][addon-grott-beta] + +![Latest Version][grott-beta-version-shield] +![Supports armhf Architecture][grott-beta-armhf-shield] +![Supports armv7 Architecture][grott-beta-armv7-shield] +![Supports aarch64 Architecture][grott-beta-aarch64-shield] +![Supports amd64 Architecture][grott-beta-amd64-shield] +![Supports i386 Architecture][grott-beta-i386-shield] + +The Growatt inverter monitor with current HA plugin integrated + +[:books: Grott Beta branch (2.8) add-on documentation][addon-doc-grott-beta] + ### ✓ [Grott stable branch (2.7)][addon-grott] ![Latest Version][grott-version-shield] @@ -39,12 +52,22 @@ You could also open an issue here on GitHub. Note, we use a separate GitHub repository for each add-on. Please ensure you are creating the issue on the correct GitHub repository matching the add-on. +- [Open an issue for the add-on: Grott Beta branch (2.8)][grott-beta-issue] - [Open an issue for the add-on: Grott stable branch (2.7)][grott-issue] For a general repository issue or add-on ideas [open an issue here][issue] +[addon-grott-beta]: https://github.com/egguy/addon-grott-beta/tree/v0.1.6 +[addon-doc-grott-beta]: https://github.com/egguy/addon-grott-beta/blob/v0.1.6/README.md +[grott-beta-issue]: https://github.com/egguy/addon-grott-beta/issues +[grott-beta-version-shield]: https://img.shields.io/badge/version-v0.1.6-blue.svg +[grott-beta-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[grott-beta-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[grott-beta-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[grott-beta-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[grott-beta-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [addon-grott]: https://github.com/egguy/addon-grott/tree/v0.1.7 [addon-doc-grott]: https://github.com/egguy/addon-grott/blob/v0.1.7/README.md [grott-issue]: https://github.com/egguy/addon-grott/issues diff --git a/grott-beta/CHANGELOG.md b/grott-beta/CHANGELOG.md new file mode 100644 index 0000000..e72ec96 --- /dev/null +++ b/grott-beta/CHANGELOG.md @@ -0,0 +1,11 @@ +## What’s changed +## 🚀 Enhancements + +- Add the support for creating a versioned release @egguy (#19) +- Use [Grott 2.8.3](https://github.com/johanmeijer/grott/commit/c97bd8ca8c6b8dd778cd3a089711703e0a60bd7e) + +## ⬆️ Dependency updates + +- ⬆️ Update Add-on base image to v14.3.3 @renovate (#17) +- ⬆️ Update Add-on base image to v15 (major) @renovate (#18) +- ⬆️ Update peter-evans/repository-dispatch action to v3 @renovate (#20) diff --git a/grott-beta/DOCS.md b/grott-beta/DOCS.md new file mode 100644 index 0000000..cc124cb --- /dev/null +++ b/grott-beta/DOCS.md @@ -0,0 +1,130 @@ +# Grott - Home Assistant native MQTT integration + + + + + +- [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) + + + +## 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. 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.:
+ + ```yaml + host: + port: 1883 + user: my_user + password: my_password + ``` + +### Compatibility with homeassistant-grott + +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. + +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. + +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. + +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) diff --git a/grott-beta/README.md b/grott-beta/README.md new file mode 100644 index 0000000..26bc90c --- /dev/null +++ b/grott-beta/README.md @@ -0,0 +1,22 @@ +# Grott - Home Assistant native MQTT integration + +![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] + +[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/egguy) + +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.8 Branch of [grott](https://github.com/johanmeijer/grott) code and current grott_ha extension. + +[:books: Read the full add-on documentation][docs] + + +[docs]: https://github.com/egguy/addon-grott-beta/blob/main/grott-beta/DOCS.md +[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg +[release-shield]: https://img.shields.io/badge/version-v0.1.6-blue.svg +[release]: https://github.com/egguy/addon-grott-beta/tree/v0.1.6 \ No newline at end of file diff --git a/grott-beta/config.yaml b/grott-beta/config.yaml new file mode 100644 index 0000000..d2f2669 --- /dev/null +++ b/grott-beta/config.yaml @@ -0,0 +1,86 @@ +name: Grott Beta branch (2.8) +version: 0.1.6 +slug: grott-beta +description: The Growatt inverter monitor with current HA plugin integrated +url: https://github.com/egguy/addon-grott-beta +arch: +- armhf +- armv7 +- aarch64 +- amd64 +- i386 +services: +- mqtt:need +init: false +map: +- config:rw +ports: + 5279/tcp: 5279 +ports_description: + 5279/tcp: The port used by grott to receive the data of the logger +options: + data_path: /config/grott + gmode: proxy + grott_mqtt: false + ginvtype: default + ginvtypemap: '' + retain: false + verbose: false + ha_plugin: true + mqtt: {} +schema: + gblockcmd: bool? + gcompat: bool? + gdecrypt: bool? + gextension: bool? + gextname: str? + gextvar: str? + ggrottip: str? + ggrottport: port? + ggrowattip: str? + ggrowattport: port? + gifbucket: str? + gifdbname: str? + gifip: str? + giforg: str? + gifpassword: password? + gifport: port? + giftoken: str? + gifuser: str? + gincludeall: bool? + ginflux: bool? + ginflux2: bool? + ginverterid: str? + ginvtype: str? + ginvtypemap: str? + gminrecl: int? + gmode: str + gmqttauth: bool? + gmqttinverterintopic: bool? + gmqttip: str? + gmqttpassword: password? + gmqttport: str? + gmqtttopic: str? + gmqttuser: str? + gnoipf: bool? + grott_mqtt: bool? + gpvapikey: str? + gpvdisv1: bool? + gpvinverters: int? + gpvoutput: bool? + gpvsystemid: int? + gpvtemp: bool? + gsendbuf: bool? + gtime: str? + gtimezone: str? + gvalueoffset: int? + verbose: bool + retain: bool + ha_plugin: bool + mqtt: + host: str? + port: int? + user: str? + password: str? + data_path: str +image: ghcr.io/egguy/grott-beta/{arch} diff --git a/grott-beta/icon.png b/grott-beta/icon.png new file mode 100644 index 0000000..b3a89bc Binary files /dev/null and b/grott-beta/icon.png differ diff --git a/grott-beta/logo.png b/grott-beta/logo.png new file mode 100644 index 0000000..4db5614 Binary files /dev/null and b/grott-beta/logo.png differ diff --git a/grott-beta/translations/en.yaml b/grott-beta/translations/en.yaml new file mode 100644 index 0000000..58f3f71 --- /dev/null +++ b/grott-beta/translations/en.yaml @@ -0,0 +1,38 @@ +--- +configuration: + verbose: + name: Verbose mode + description: Enable the verbose mode. Useful for debugging + retain: + name: Activate MQTT retain + description: >- + This allow to keep the values between reboot, prevent showing sensor + values as unknown + gminrecl: + name: Minimum record length + description: The minimum packet length to be treated + grott_mqtt: + name: Enable grott MQTT + description: >- + Allow grott to send MQTT messages. If your are using + the grott_ha extension, you don't need this. + If you are using the grott integration, you need to enable it. + ginvtype: + name: Inverter type + description: >- + For changing the layout used for decoding + (ex: sph, spf or tl3). Keep it on default if using inverter map. + ginvtypemap: + name: Inverter mapping + description: >- + An inverter mapping in the form {"SERIAL": "type"} + e.g.: for an SPH6000 with serial "NWO00415E3" : {"NWO00415E3": "sph"} + ha_plugin: + name: Home Assistant plugin + description: >- + Enable the Home Assistant plugin. + This will send the data to Home Assistant via the grott HA plugin. + Can be disabled if you are using the grott integration. + +network: + 5279/TCP: This is the port used by grott to receive datalogger information.