From a062da7a2dc34b9306375d1e32447d68aacb058d Mon Sep 17 00:00:00 2001 From: Michael Metz Date: Thu, 5 Dec 2024 17:54:28 +0100 Subject: [PATCH 01/10] initial DOCS.md for Addon --- ha_addons/ha_addon/DOCS.md | 155 +++++++++++++++++++++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 ha_addons/ha_addon/DOCS.md diff --git a/ha_addons/ha_addon/DOCS.md b/ha_addons/ha_addon/DOCS.md new file mode 100644 index 0000000..fc2faa9 --- /dev/null +++ b/ha_addons/ha_addon/DOCS.md @@ -0,0 +1,155 @@ +# Home Assistant Add-on: TSUN Proxy + +[TSUN Proxy][tsunproxy] enables a reliable connection between TSUN third generation +inverters and an MQTT broker. With the proxy, you can easily retrieve real-time values +such as power, current and daily energy and integrate the inverter into Home Assistant. +This works even without an internet connection. +The optional connection to the TSUN Cloud can be disabled! + +## Pre-requisites +1. This Add-on requires an MQTT broker to work. +For a typical installation, we recommend the Mosquitto add-on running on your Home Assistant. + +2. You need to loop the proxy into the connection between the inverter and the TSUN Cloud, +you must adapt the DNS record within the network that your inverter uses. You need a mapping +from logger.talent-monitoring.com and/or iot.talent-monitoring.com to the IP address of your +Home Assistant. +This can be done, for example, by adding a local DNS record to AdGuard Home Add-on. + + + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + + +1. Add the repository URL to the Home Assistant add-on store +2. Reload the add-on store page +3. Click the "Install" button to install the add-on. +4. Add your inverter configuration to the add-on configuration +5. Start the "TSUN-Proxy" add-on +6. Check the logs of the "TSUN-Proxy" add-on to see if everything went well. + +_Please note, the add-on is pre-configured to connect with +Home Assistants default MQTT Broker. There is no need to configure any MQTT parameters +if you're running an MOSQUITTO add-on. Home Assistant communication and TSUN Cloud URL +and Ports are also pre-configured._ + +This automatic handling of the TSUN Cloud and MQTT Broker conflicts with the +[TSUN Proxy official documentation][tsunproxy]. The official documentation +will state `mqtt.host`, `mqtt.port`, `mqtt.user`, `mqtt.passwd` `solarman.host`, +`solarman.port` `tsun.host`, `tsun.port` and Home Assistant options are required. +For the add-on, however, this isn't needed. + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration after installation: + +```yaml +inverters: + - serial: R17E760702080400 + node_id: PV-Garage + suggested_area: Garage + modbus_polling: false + pv1_manufacturer: Shinefar + pv1_type: SF-M18/144550 + pv2_manufacturer: Shinefar + pv2_type: SF-M18/144550 +``` + +**Note**: _This is just an example, you need to replace the values with your own!_ + +Example add-on configuration for GEN3PLUS inverters: + +```yaml +inverters: + - serial: Y17000000000000 + monitor_sn: '2000000000' + node_id: PV-Garage + suggested_area: Garage + modbus_polling: true + pv1_manufacturer: Shinefar + pv1_type: SF-M18/144550 + pv2_manufacturer: Shinefar + pv2_type: SF-M18/144550 + pv3_manufacturer: Shinefar + pv3_type: SF-M18/144550 + pv4_manufacturer: Shinefar + pv4_type: SF-M18/144550 +``` + +**Note**: _This is just an example, you need to replace the values with your own!_ + + + + +## MQQT settings + +By default, this add-on requires no `mqtt` config from the user. **This is not an error!** + +However, you are free to set them if you want to override, however, in +general usage, that should not be needed and is not recommended for this add-on. + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. + +Releases are based on [Semantic Versioning][semver], and use the format +of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented +based on the following: + +- `MAJOR`: Incompatible or major changes. +- `MINOR`: Backwards-compatible new features and enhancements. +- `PATCH`: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The Discussions section on [GitHub][discussions]. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Stefan Allius][author]. + +We're very happy to receive contributions to this project! You can get started by reading [CONTRIBUTING.md][contribute]. + +## License +This project is licensed under the [BSD 3-clause License][bsd]. + +Note the aiomqtt library used is based on the paho-mqtt library, which has a dual license. +One of the licenses is the so-called [Eclipse Distribution License v1.0.][eclipse] +It is almost word-for-word identical to the BSD 3-clause License. The only differences are: + +- One use of "COPYRIGHT OWNER" (EDL) instead of "COPYRIGHT HOLDER" (BSD) +- One use of "Eclipse Foundation, Inc." (EDL) instead of "copyright holder" (BSD) + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +[tsunproxy]: https://github.com/s-allius/tsun-gen3-proxy +[discussions]: https://github.com/s-allius/tsun-gen3-proxy/discussions +[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg +[author]: https://github.com/s-allius +[discord-ha]: https://discord.gg/c5DvZ4e +[issue]: https://github.com/s-allius/tsun-gen3-proxy/issues +[releases]: https://github.com/s-allius/tsun-gen3-proxy/releases +[contribute]: https://github.com/s-allius/tsun-gen3-proxy/blob/main/CONTRIBUTING.md +[semver]: http://semver.org/spec/v2.0.0.htm +[bsd]: https://opensource.org/licenses/BSD-3-Clause +[eclipse]: https://www.eclipse.org/org/documents/edl-v10.php From 22c3a21e4686116aec3c7b6a79b3150366609372 Mon Sep 17 00:00:00 2001 From: Michael Metz Date: Thu, 5 Dec 2024 18:08:45 +0100 Subject: [PATCH 02/10] links to Mosquitto and Adguard --- ha_addons/ha_addon/DOCS.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/ha_addons/ha_addon/DOCS.md b/ha_addons/ha_addon/DOCS.md index fc2faa9..0181fb3 100644 --- a/ha_addons/ha_addon/DOCS.md +++ b/ha_addons/ha_addon/DOCS.md @@ -8,13 +8,14 @@ The optional connection to the TSUN Cloud can be disabled! ## Pre-requisites 1. This Add-on requires an MQTT broker to work. -For a typical installation, we recommend the Mosquitto add-on running on your Home Assistant. +For a typical installation, we recommend the [Mosquitto add-on][Mosquitto] running on your Home Assistant. 2. You need to loop the proxy into the connection between the inverter and the TSUN Cloud, you must adapt the DNS record within the network that your inverter uses. You need a mapping from logger.talent-monitoring.com and/or iot.talent-monitoring.com to the IP address of your Home Assistant. -This can be done, for example, by adding a local DNS record to AdGuard Home Add-on. +This can be done, for example, by adding a local DNS record to [AdGuard Home Add-on][AdGuard] +(navigate to `filters` on the AdGuard panel and add an entry under `custom filtering rules`). @@ -153,3 +154,5 @@ SOFTWARE. [semver]: http://semver.org/spec/v2.0.0.htm [bsd]: https://opensource.org/licenses/BSD-3-Clause [eclipse]: https://www.eclipse.org/org/documents/edl-v10.php +[Mosquitto]: https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md +[AdGuard]: https://github.com/hassio-addons/addon-adguard-home \ No newline at end of file From 17806af53b9d99094001af6cd0ea1fab72effb76 Mon Sep 17 00:00:00 2001 From: Michael Metz Date: Sat, 7 Dec 2024 10:48:07 +0100 Subject: [PATCH 03/10] replaced _ by . for PV-Strings --- ha_addons/ha_addon/DOCS.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/ha_addons/ha_addon/DOCS.md b/ha_addons/ha_addon/DOCS.md index 0181fb3..684b542 100644 --- a/ha_addons/ha_addon/DOCS.md +++ b/ha_addons/ha_addon/DOCS.md @@ -55,10 +55,10 @@ inverters: node_id: PV-Garage suggested_area: Garage modbus_polling: false - pv1_manufacturer: Shinefar - pv1_type: SF-M18/144550 - pv2_manufacturer: Shinefar - pv2_type: SF-M18/144550 + pv1.manufacturer: Shinefar + pv1.type: SF-M18/144550 + pv2.manufacturer: Shinefar + pv2.type: SF-M18/144550 ``` **Note**: _This is just an example, you need to replace the values with your own!_ @@ -72,14 +72,14 @@ inverters: node_id: PV-Garage suggested_area: Garage modbus_polling: true - pv1_manufacturer: Shinefar - pv1_type: SF-M18/144550 - pv2_manufacturer: Shinefar - pv2_type: SF-M18/144550 - pv3_manufacturer: Shinefar - pv3_type: SF-M18/144550 - pv4_manufacturer: Shinefar - pv4_type: SF-M18/144550 + pv1.manufacturer: Shinefar + pv1.type: SF-M18/144550 + pv2.manufacturer: Shinefar + pv2.type: SF-M18/144550 + pv3.manufacturer: Shinefar + pv3.type: SF-M18/144550 + pv4.manufacturer: Shinefar + pv4.type: SF-M18/144550 ``` **Note**: _This is just an example, you need to replace the values with your own!_ From d1cfb53284824276afbf639c49a7f9ccd75ff0b1 Mon Sep 17 00:00:00 2001 From: Michael Metz Date: Sat, 7 Dec 2024 11:20:09 +0100 Subject: [PATCH 04/10] mentioned add-on installation method in README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 7590b4a..5c4bf3e 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,9 @@ Through this, the inverter then establishes a connection to the proxy and the pr By means of `docker` a simple installation and operation is possible. By using `docker-composer`, a complete stack of proxy, `MQTT-brocker` and `home-assistant` can be started easily. +Alternatively you can run the TSUN-Proxy as a Home Assistant Add-on. The installation of this add-on is pretty straightforward and not different in comparison to installing any other custom Home Assistant add-on. +Follow the Instructions mentioned in the add-on subdirectory `ha_addons`. +
ℹ️ This project is not related to the company TSUN. It is a private initiative that aims to connect TSUN inverters with an MQTT broker. There is no support and no warranty from TSUN.

@@ -65,11 +68,20 @@ Here are some screenshots of how the inverter is displayed in the Home Assistant ## Requirements +### for Docker Installation - A running Docker engine to host the container - Ability to loop the proxy into the connection between the inverter and the TSUN cloud +### for Home Assistant Add-on Installation +- Running Home Assistant on Home Assistant OS or Supervised. Container and Core installations doesn't support add-ons. +- Ability to loop the proxy into the connection between the inverter and the TSUN cloud + + + + # Getting Started +## for Docker Installation To run the proxy, you first need to create the image. You can do this quite simply as follows: ```sh @@ -95,7 +107,21 @@ With this information we can customize the `docker run`` statement: docker run --dns '8.8.8.8' --env 'UID=1050' -p '5005:5005' -p '10000:10000' -v ./config:/home/tsun-proxy/config -v ./log:/home/tsun-proxy/log tsun-proxy ``` +## for Home Assistant Add-on Installation + +1. Add the repository URL to the Home Assistant add-on store +2. Reload the add-on store page +3. Click the "Install" button to install the add-on. + + + # Configuration +```txt +❗The following describtion applies to docker installation. For Home Assistant Add-on installation, the +configuration is done via the Home Assistant UI. Some options are not required, nor is the e creation of a +config.toml file.. For general understandment of the configuration, you can read the following describtion. +``` + The configuration consists of several parts. First, the container and the proxy itself must be configured, and then the connection of the inverter to the proxy must be set up, which is done differently depending on the inverter generation From a7e27384a4b5c769fa2feba70dbcd4a1b4dcf92f Mon Sep 17 00:00:00 2001 From: Stefan Allius Date: Sun, 8 Dec 2024 14:27:23 +0100 Subject: [PATCH 05/10] fix most of the markdown linter warnings --- README.md | 17 +++++++---------- ha_addons/ha_addon/DOCS.md | 38 +++++++++++++++++--------------------- 2 files changed, 24 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 5c4bf3e..f6072be 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Supported Python versions Supported aiomqtt versions Supported aiocron versions - Supported toml versions + Supported toml versions
@@ -29,7 +29,7 @@ Through this, the inverter then establishes a connection to the proxy and the pr By means of `docker` a simple installation and operation is possible. By using `docker-composer`, a complete stack of proxy, `MQTT-brocker` and `home-assistant` can be started easily. Alternatively you can run the TSUN-Proxy as a Home Assistant Add-on. The installation of this add-on is pretty straightforward and not different in comparison to installing any other custom Home Assistant add-on. -Follow the Instructions mentioned in the add-on subdirectory `ha_addons`. +Follow the Instructions mentioned in the add-on subdirectory `ha_addons`.
ℹ️ This project is not related to the company TSUN. It is a private initiative that aims to connect TSUN inverters with an MQTT broker. There is no support and no warranty from TSUN. @@ -69,19 +69,19 @@ Here are some screenshots of how the inverter is displayed in the Home Assistant ## Requirements ### for Docker Installation + - A running Docker engine to host the container - Ability to loop the proxy into the connection between the inverter and the TSUN cloud ### for Home Assistant Add-on Installation -- Running Home Assistant on Home Assistant OS or Supervised. Container and Core installations doesn't support add-ons. -- Ability to loop the proxy into the connection between the inverter and the TSUN cloud - - +- Running Home Assistant on Home Assistant OS or Supervised. Container and Core installations doesn't support add-ons. +- Ability to loop the proxy into the connection between the inverter and the TSUN cloud # Getting Started ## for Docker Installation + To run the proxy, you first need to create the image. You can do this quite simply as follows: ```sh @@ -113,16 +113,14 @@ docker run --dns '8.8.8.8' --env 'UID=1050' -p '5005:5005' -p '10000:10000' -v 2. Reload the add-on store page 3. Click the "Install" button to install the add-on. - - # Configuration + ```txt ❗The following describtion applies to docker installation. For Home Assistant Add-on installation, the configuration is done via the Home Assistant UI. Some options are not required, nor is the e creation of a config.toml file.. For general understandment of the configuration, you can read the following describtion. ``` - The configuration consists of several parts. First, the container and the proxy itself must be configured, and then the connection of the inverter to the proxy must be set up, which is done differently depending on the inverter generation For GEN3PLUS inverters, this can be done easily via the web interface of the inverter. The GEN3 inverters do not have a web interface, so the proxy is integrated via a modified DNS resolution. @@ -346,7 +344,6 @@ In this case, you MUST NOT change the port or the host address, as this may caus require a complete reset. Use the configuration in client mode instead. ``` - If access to the web interface does not work, it can also be redirected via DNS redirection, as is necessary for the GEN3 inverters. ## Client Mode (GEN3PLUS only) diff --git a/ha_addons/ha_addon/DOCS.md b/ha_addons/ha_addon/DOCS.md index 684b542..e0d9a60 100644 --- a/ha_addons/ha_addon/DOCS.md +++ b/ha_addons/ha_addon/DOCS.md @@ -1,30 +1,28 @@ # Home Assistant Add-on: TSUN Proxy -[TSUN Proxy][tsunproxy] enables a reliable connection between TSUN third generation -inverters and an MQTT broker. With the proxy, you can easily retrieve real-time values -such as power, current and daily energy and integrate the inverter into Home Assistant. -This works even without an internet connection. +[TSUN Proxy][tsunproxy] enables a reliable connection between TSUN third generation +inverters and an MQTT broker. With the proxy, you can easily retrieve real-time values +such as power, current and daily energy and integrate the inverter into Home Assistant. +This works even without an internet connection. The optional connection to the TSUN Cloud can be disabled! ## Pre-requisites + 1. This Add-on requires an MQTT broker to work. For a typical installation, we recommend the [Mosquitto add-on][Mosquitto] running on your Home Assistant. -2. You need to loop the proxy into the connection between the inverter and the TSUN Cloud, -you must adapt the DNS record within the network that your inverter uses. You need a mapping -from logger.talent-monitoring.com and/or iot.talent-monitoring.com to the IP address of your +2. You need to loop the proxy into the connection between the inverter and the TSUN Cloud, +you must adapt the DNS record within the network that your inverter uses. You need a mapping +from logger.talent-monitoring.com and/or iot.talent-monitoring.com to the IP address of your Home Assistant. -This can be done, for example, by adding a local DNS record to [AdGuard Home Add-on][AdGuard] +This can be done, for example, by adding a local DNS record to [AdGuard Home Add-on][AdGuard] (navigate to `filters` on the AdGuard panel and add an entry under `custom filtering rules`). - - ## Installation The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on. - 1. Add the repository URL to the Home Assistant add-on store 2. Reload the add-on store page 3. Click the "Install" button to install the add-on. @@ -33,14 +31,14 @@ comparison to installing any other Home Assistant add-on. 6. Check the logs of the "TSUN-Proxy" add-on to see if everything went well. _Please note, the add-on is pre-configured to connect with -Home Assistants default MQTT Broker. There is no need to configure any MQTT parameters -if you're running an MOSQUITTO add-on. Home Assistant communication and TSUN Cloud URL +Home Assistants default MQTT Broker. There is no need to configure any MQTT parameters +if you're running an MOSQUITTO add-on. Home Assistant communication and TSUN Cloud URL and Ports are also pre-configured._ This automatic handling of the TSUN Cloud and MQTT Broker conflicts with the [TSUN Proxy official documentation][tsunproxy]. The official documentation -will state `mqtt.host`, `mqtt.port`, `mqtt.user`, `mqtt.passwd` `solarman.host`, -`solarman.port` `tsun.host`, `tsun.port` and Home Assistant options are required. +will state `mqtt.host`, `mqtt.port`, `mqtt.user`, `mqtt.passwd` `solarman.host`, +`solarman.port` `tsun.host`, `tsun.port` and Home Assistant options are required. For the add-on, however, this isn't needed. ## Configuration @@ -84,9 +82,6 @@ inverters: **Note**: _This is just an example, you need to replace the values with your own!_ - - - ## MQQT settings By default, this add-on requires no `mqtt` config from the user. **This is not an error!** @@ -126,10 +121,11 @@ The original setup of this repository is by [Stefan Allius][author]. We're very happy to receive contributions to this project! You can get started by reading [CONTRIBUTING.md][contribute]. ## License + This project is licensed under the [BSD 3-clause License][bsd]. -Note the aiomqtt library used is based on the paho-mqtt library, which has a dual license. -One of the licenses is the so-called [Eclipse Distribution License v1.0.][eclipse] +Note the aiomqtt library used is based on the paho-mqtt library, which has a dual license. +One of the licenses is the so-called [Eclipse Distribution License v1.0.][eclipse] It is almost word-for-word identical to the BSD 3-clause License. The only differences are: - One use of "COPYRIGHT OWNER" (EDL) instead of "COPYRIGHT HOLDER" (BSD) @@ -155,4 +151,4 @@ SOFTWARE. [bsd]: https://opensource.org/licenses/BSD-3-Clause [eclipse]: https://www.eclipse.org/org/documents/edl-v10.php [Mosquitto]: https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md -[AdGuard]: https://github.com/hassio-addons/addon-adguard-home \ No newline at end of file +[AdGuard]: https://github.com/hassio-addons/addon-adguard-home From d0ea3e88f516a5f008d50af6bc93643fe96c701b Mon Sep 17 00:00:00 2001 From: Stefan Allius Date: Sun, 8 Dec 2024 15:29:48 +0100 Subject: [PATCH 06/10] add missing alt texts --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f6072be..df98d70 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ Supported aiocron versions Supported toml versions
- - - + The quality gate status + No of bugs + No of code-smells
- + Test coverage in percent

# Overview From 25a0a1e39dff7eac8737ea43724e23990321f803 Mon Sep 17 00:00:00 2001 From: Michael Metz Date: Tue, 10 Dec 2024 22:48:44 +0100 Subject: [PATCH 07/10] added nice add repository to my Home Assistant badges --- README.md | 4 ++++ ha_addons/ha_addon/DOCS.md | 3 +++ 2 files changed, 7 insertions(+) diff --git a/README.md b/README.md index df98d70..a410a28 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,7 @@ docker run --dns '8.8.8.8' --env 'UID=1050' -p '5005:5005' -p '10000:10000' -v ## for Home Assistant Add-on Installation 1. Add the repository URL to the Home Assistant add-on store +[![Add repository on my Home Assistant][repository-badge]][repository-url] 2. Reload the add-on store page 3. Click the "Install" button to install the add-on. @@ -431,3 +432,6 @@ We're very happy to receive contributions to this project! You can get started b ## Changelog The changelog lives in [CHANGELOG.md](https://github.com/s-allius/tsun-gen3-proxy/blob/main/CHANGELOG.md). It follows the principles of [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + +[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge +[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fs-allius%2Ftsun-gen3-proxy diff --git a/ha_addons/ha_addon/DOCS.md b/ha_addons/ha_addon/DOCS.md index e0d9a60..4034b0b 100644 --- a/ha_addons/ha_addon/DOCS.md +++ b/ha_addons/ha_addon/DOCS.md @@ -24,6 +24,7 @@ The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on. 1. Add the repository URL to the Home Assistant add-on store +[![Add repository on my Home Assistant][repository-badge]][repository-url] 2. Reload the add-on store page 3. Click the "Install" button to install the add-on. 4. Add your inverter configuration to the add-on configuration @@ -152,3 +153,5 @@ SOFTWARE. [eclipse]: https://www.eclipse.org/org/documents/edl-v10.php [Mosquitto]: https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md [AdGuard]: https://github.com/hassio-addons/addon-adguard-home +[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge +[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fs-allius%2Ftsun-gen3-proxy \ No newline at end of file From 6667b9b499d64d4f9408dda9ac0a9503f15f663b Mon Sep 17 00:00:00 2001 From: Michael Metz Date: Sun, 15 Dec 2024 14:23:40 +0100 Subject: [PATCH 08/10] removed [addon-badge] --- ha_addons/ha_addon/DOCS.md | 1 - 1 file changed, 1 deletion(-) diff --git a/ha_addons/ha_addon/DOCS.md b/ha_addons/ha_addon/DOCS.md index 4034b0b..6a391d9 100644 --- a/ha_addons/ha_addon/DOCS.md +++ b/ha_addons/ha_addon/DOCS.md @@ -142,7 +142,6 @@ SOFTWARE. [tsunproxy]: https://github.com/s-allius/tsun-gen3-proxy [discussions]: https://github.com/s-allius/tsun-gen3-proxy/discussions -[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg [author]: https://github.com/s-allius [discord-ha]: https://discord.gg/c5DvZ4e [issue]: https://github.com/s-allius/tsun-gen3-proxy/issues From c5da7ddd38b6f6cea2651c0ec4e1c87183547a13 Mon Sep 17 00:00:00 2001 From: Michael Metz Date: Sun, 15 Dec 2024 14:37:49 +0100 Subject: [PATCH 09/10] revised config disclaimer --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a410a28..7dc90b3 100644 --- a/README.md +++ b/README.md @@ -117,9 +117,10 @@ docker run --dns '8.8.8.8' --env 'UID=1050' -p '5005:5005' -p '10000:10000' -v # Configuration ```txt -❗The following describtion applies to docker installation. For Home Assistant Add-on installation, the -configuration is done via the Home Assistant UI. Some options are not required, nor is the e creation of a -config.toml file.. For general understandment of the configuration, you can read the following describtion. +❗The following description applies to the Docker installation. When installing the Home Assistant add-on, the +configuration is carried out via the Home Assistant UI. Some of the options described below are not required for +this. Additionally, creating a config.toml file is not necessary. However, for a general understanding of the +configuration and functionality, it is helpful to read the following description. ``` The configuration consists of several parts. First, the container and the proxy itself must be configured, and then the connection of the inverter to the proxy must be set up, which is done differently depending on the inverter generation From dac6423305b54cd04b7127510ec72498a28003d3 Mon Sep 17 00:00:00 2001 From: Stefan Allius Date: Sun, 15 Dec 2024 15:01:01 +0100 Subject: [PATCH 10/10] add newline at end of file to fix linter warning --- ha_addons/ha_addon/DOCS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ha_addons/ha_addon/DOCS.md b/ha_addons/ha_addon/DOCS.md index 6a391d9..b5c1a29 100644 --- a/ha_addons/ha_addon/DOCS.md +++ b/ha_addons/ha_addon/DOCS.md @@ -153,4 +153,4 @@ SOFTWARE. [Mosquitto]: https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md [AdGuard]: https://github.com/hassio-addons/addon-adguard-home [repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge -[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fs-allius%2Ftsun-gen3-proxy \ No newline at end of file +[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fs-allius%2Ftsun-gen3-proxy