From 6fb663eb3316c2863e8dce696877666a2c9b48c4 Mon Sep 17 00:00:00 2001 From: Etienne G Date: Mon, 13 Nov 2023 13:20:03 +0000 Subject: [PATCH] :tada: Release of add-on Grott stable branch (2.7) 0.1.7 --- README.md | 6 +++--- grott/CHANGELOG.md | 7 ++----- grott/DOCS.md | 33 ++++++++++++++++++++++++++++++--- grott/README.md | 16 ++++++++-------- grott/config.yaml | 2 +- 5 files changed, 44 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 33a1ec7..ba68013 100644 --- a/README.md +++ b/README.md @@ -68,10 +68,10 @@ For a general repository issue or add-on ideas [open an issue here][issue] [grott-current-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [grott-current-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [grott-current-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-grott]: https://github.com/egguy/addon-grott/tree/v0.1.5 -[addon-doc-grott]: https://github.com/egguy/addon-grott/blob/v0.1.5/README.md +[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 -[grott-version-shield]: https://img.shields.io/badge/version-v0.1.5-blue.svg +[grott-version-shield]: https://img.shields.io/badge/version-v0.1.7-blue.svg [grott-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [grott-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [grott-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg diff --git a/grott/CHANGELOG.md b/grott/CHANGELOG.md index 5c74a5d..eb21a2e 100644 --- a/grott/CHANGELOG.md +++ b/grott/CHANGELOG.md @@ -1,8 +1,5 @@ ## Whatโ€™s changed -## ๐Ÿš€ Enhancements - -- Changed the name of the addon @egguy (#11) - ## ๐Ÿ“š Documentation -- Update of the documentation @egguy (#10) +- Corrected the documentation generation @egguy (#19) +- Removed the last trace of the old extension diff --git a/grott/DOCS.md b/grott/DOCS.md index 234fa17..cc124cb 100644 --- a/grott/DOCS.md +++ b/grott/DOCS.md @@ -1,5 +1,22 @@ # 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) @@ -25,9 +42,9 @@ If you do a change of configuration. It is important to save and then restart th ### Specific inverter configuration -If you have multiple inverters, please refer on how to configure them on this documentation: [Multiple inverters configuration](#multiple-inverters-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 type, you need a special configuration: +In the case you have one of the listed inverter types, you need a special configuration: - SPH - SPH6000, SPH3000... @@ -62,7 +79,7 @@ In the case of multiple inverters, you need to configure the inverter details in 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. +You can keep the default value for `invertype`, it will override it. The format is e.g.: @@ -101,3 +118,13 @@ You can use the add-on and the component at the same time. This will make the de 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/README.md b/grott/README.md index a9d6950..3d19056 100644 --- a/grott/README.md +++ b/grott/README.md @@ -1,20 +1,20 @@ # Grott - Home Assistant native MQTT integration -![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] - +[![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 data is forwarded 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. +This addon is based on the 2.7.8 [grott](https://github.com/johanmeijer/grott) code and current grott_ha extension. +[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.5-blue.svg -[release]: https://github.com/egguy/addon-grott/tree/v0.1.5 \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-v0.1.7-blue.svg +[release]: https://github.com/egguy/addon-grott/tree/v0.1.7 +[docs]: https://github.com/egguy/addon-grott/blob/main/grott/DOCS.md \ No newline at end of file diff --git a/grott/config.yaml b/grott/config.yaml index cf7faf2..d986608 100644 --- a/grott/config.yaml +++ b/grott/config.yaml @@ -1,5 +1,5 @@ name: Grott stable branch (2.7) -version: 0.1.5 +version: 0.1.7 slug: grott description: The Growatt inverter monitor with current HA plugin integrated url: https://github.com/egguy/addon-grott