270 ha addon add syntax check to config parameters (#274)

* fixed requirement status of client mode host

---------

Co-authored-by: Michael Metz <michael.metz@siemens.com>

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.12.1] - 2025-01-13
+
+- addon: bump base image version to v17.1.0
+- addon: add syntax check to config parameters
+- addon: bump base image version to v17.0.2
+
 ## [0.12.0] - 2024-12-22
 
 - add hadolint configuration

README.md

@@ -138,7 +138,7 @@ No special configuration is required for the Docker container if it is built and
 
 On the host, two directories (for log files and for config files) must be mapped. If necessary, the UID of the proxy process can be adjusted, which is also the owner of the log and configuration files.
 
-A description of the configuration parameters can be found [here](https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#docker-compose-environment-variables).
+A description of the configuration parameters can be found [here](https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#docker-compose-environment-variables).
 
 ## Proxy Configuration
 
@@ -168,7 +168,7 @@ You find more details here: <https://toml.io/en/v1.0.0>
 ###   https://github.com/s-allius/tsun-gen3-proxy/wiki/Operation-Modes-Overview
 ###
 ###   Here you will find a description of all configuration options:
-###   https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details
+###   https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml
 ###
 ###   The configration uses the TOML format, which aims to be easy to read due to 
 ###   obvious semantics. You find more details here: https://toml.io/en/v1.0.0
@@ -184,7 +184,7 @@ You find more details here: <https://toml.io/en/v1.0.0>
 ## required credentials. As the proxy does not currently support an encrypted connection
 ## to the MQTT broker, it is strongly recommended that you do not use a public broker.
 ##
-## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#mqtt-broker-account
+## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#mqtt-broker-account
 ##
 
 mqtt.host    = 'mqtt'   # URL or IP address of the mqtt broker
@@ -201,7 +201,7 @@ mqtt.passwd  = ''
 ## values match the HA default configuration. If you need to change these or want to use
 ## a different MQTT client, you can adjust the prefixes of the MQTT topics below.
 ##
-## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#home-assistant
+## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#home-assistant
 ##
 
 ha.auto_conf_prefix = 'homeassistant'       # MQTT prefix for subscribing for homeassistant status updates
@@ -219,7 +219,7 @@ ha.proxy_unique_id  = 'P170000000000001'    # MQTT unique id, to identify a prox
 ## inverters. This connection is only required if you want send data to the TSUN cloud
 ## to use the TSUN APPs or receive firmware updates.  
 ##
-## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#tsun-cloud-for-gen3-inverter-only
+## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#tsun-cloud-for-gen3-inverter-only
 ##
 
 tsun.enabled = true   # false: disables connecting to the tsun cloud, and avoids updates
@@ -235,7 +235,7 @@ tsun.port    = 5005
 ## inverters. This connection is only required if you want send data to the TSUN cloud
 ## to use the TSUN APPs or receive firmware updates.  
 ##
-## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#solarman-cloud-for-gen3plus-inverter-only
+## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#solarman-cloud-for-gen3plus-inverter-only
 ##
 solarman.enabled = true   # false: disables connecting to the tsun cloud, and avoids updates
 solarman.host    = 'iot.talent-monitoring.com'

app/.version

@@ -1 +1 @@
-0.12.0
+0.12.1

app/config/default_config.toml

@@ -15,7 +15,7 @@
 ###   https://github.com/s-allius/tsun-gen3-proxy/wiki/Operation-Modes-Overview
 ###
 ###   Here you will find a description of all configuration options:
-###   https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details
+###   https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml
 ###
 ###   The configration uses the TOML format, which aims to be easy to read due to 
 ###   obvious semantics. You find more details here: https://toml.io/en/v1.0.0
@@ -31,7 +31,7 @@
 ## required credentials. As the proxy does not currently support an encrypted connection
 ## to the MQTT broker, it is strongly recommended that you do not use a public broker.
 ##
-## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#mqtt-broker-account
+## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#mqtt-broker-account
 ##
 
 mqtt.host    = 'mqtt'   # URL or IP address of the mqtt broker
@@ -48,7 +48,7 @@ mqtt.passwd  = ''
 ## values match the HA default configuration. If you need to change these or want to use
 ## a different MQTT client, you can adjust the prefixes of the MQTT topics below.
 ##
-## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#home-assistant
+## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#home-assistant
 ##
 
 ha.auto_conf_prefix = 'homeassistant'       # MQTT prefix for subscribing for homeassistant status updates
@@ -66,7 +66,7 @@ ha.proxy_unique_id  = 'P170000000000001'    # MQTT unique id, to identify a prox
 ## inverters. This connection is only required if you want send data to the TSUN cloud
 ## to use the TSUN APPs or receive firmware updates.  
 ##
-## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#tsun-cloud-for-gen3-inverter-only
+## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#tsun-cloud-for-gen3-inverter-only
 ##
 
 tsun.enabled = true   # false: disables connecting to the tsun cloud, and avoids updates
@@ -82,7 +82,7 @@ tsun.port    = 5005
 ## inverters. This connection is only required if you want send data to the TSUN cloud
 ## to use the TSUN APPs or receive firmware updates.  
 ##
-## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details#solarman-cloud-for-gen3plus-inverter-only
+## https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml#solarman-cloud-for-gen3plus-inverter-only
 ##
 
 solarman.enabled = true   # false: disables connecting to the tsun cloud, and avoids updates

app/requirements.txt

@@ -1,4 +1,4 @@
     aiomqtt==2.3.0
     schema==0.7.7
     aiocron==1.8
-    aiohttp==3.11.10
+    aiohttp==3.11.11

ha_addons/Makefile

@@ -104,11 +104,11 @@ FORCE : ;
 # 
 
 INST=$(INST_BASE)/ha_addon_dev
-repro_files = DOCS.md icon.png logo.png translations/de.yaml translations/en.yaml
+repro_files = DOCS.md icon.png logo.png translations/de.yaml translations/en.yaml rootfs/run.sh
 repro_root = CHANGELOG.md 
 repro_templates = config.yaml
-repro_subdirs = translations
-repro_vers = debug dev rel
+repro_subdirs = translations rootfs
+repro_vers = debug dev rc rel
 
 repro_all_files := $(foreach dir,$(repro_vers), $(foreach file,$(repro_files),$(INST_BASE)/ha_addon_$(dir)/$(file)))
 repro_root_files := $(foreach dir,$(repro_vers), $(foreach file,$(repro_root),$(INST_BASE)/ha_addon_$(dir)/$(file)))
@@ -130,6 +130,8 @@ $(filter $(INST_BASE)/ha_addon_debug/%,$(repro_all_files)) : $(INST_BASE)/ha_add
 	cp $< $@
 $(filter $(INST_BASE)/ha_addon_dev/%,$(repro_all_files)) : $(INST_BASE)/ha_addon_dev/% : ha_addon/%
 	cp $< $@
+$(filter $(INST_BASE)/ha_addon_rc/%,$(repro_all_files)) : $(INST_BASE)/ha_addon_rc/% : ha_addon/%
+	cp $< $@
 $(filter $(INST_BASE)/ha_addon_rel/%,$(repro_all_files)) : $(INST_BASE)/ha_addon_rel/% : ha_addon/%
 	cp $< $@
 

ha_addons/ha_addon/DOCS.md

@@ -67,7 +67,7 @@ Example add-on configuration for GEN3PLUS inverters:
 ```yaml
 inverters:
   - serial: Y17000000000000
-    monitor_sn: '2000000000'
+    monitor_sn: 2000000000
     node_id: PV-Garage
     suggested_area: Garage
     modbus_polling: true
@@ -159,4 +159,4 @@ SOFTWARE.
 [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%2Fha-addons
-[configdetails]: https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-details
+[configdetails]: https://github.com/s-allius/tsun-gen3-proxy/wiki/Configuration-toml

ha_addons/ha_addon/Dockerfile

@@ -13,7 +13,7 @@
 # 1 Build Base Image #
 ######################
 
-ARG BUILD_FROM="ghcr.io/hassio-addons/base:17.0.1"
+ARG BUILD_FROM="ghcr.io/hassio-addons/base:17.1.0"
 # hadolint ignore=DL3006
 FROM $BUILD_FROM AS base
 

ha_addons/templates/config.jinja

@@ -1,7 +1,7 @@
 name: {{name}}
 description: {{description}}
 version: {% if version is defined and version|length %} {{version}} {% else %} {{AppVersion}} {% endif %}
-image: docker.io/sallius/tsun-gen3-addon
+image: {{image}}
 url: https://github.com/s-allius/tsun-gen3-proxy
 slug: {{slug}}
 advanced: {{advanced}}
@@ -31,16 +31,16 @@ ports:
 # parameters are available within the container as /data/options.json
 # and should become picked up by the proxy - current workaround as a transfer script
 # TODO: check again for multi hierarchie parameters
-# TODO: implement direct reading of the configuration file
+
 schema:
   inverters:
-    - serial: str
+    - serial: match(^(R17|Y17|Y47).{13}$)
       monitor_sn: int?
       node_id: str
       suggested_area: str
       modbus_polling: bool
-      client_mode.host: str?
-      client_mode.port: int?
+      client_mode.host: match(\b((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\b)?
+      client_mode.port: port?
       client_mode.forward: bool?
       #strings: # leider funktioniert es nicht die folgenden 3 parameter im schema aufzulisten. möglicherweise wird die verschachtelung nicht unterstützt.
       #  - string: str
@@ -62,10 +62,11 @@ schema:
   tsun.enabled: bool
   solarman.enabled: bool
   inverters.allow_all: bool
+
   # optionale parameter
-  # TODO besser strukturieren und vervollständigen
+
   mqtt.host: str?
-  mqtt.port: int?
+  mqtt.port: port?
   mqtt.user: str?
   mqtt.passwd: password?
   ha.auto_conf_prefix: str? # suggeriert optionale konfigurationsoption -> es darf jedoch kein default unter "options" angegeben werden

ha_addons/templates/debug_data.json

@@ -3,6 +3,7 @@
     "name": "TSUN-Proxy (Debug)",
     "description": "MQTT Proxy for TSUN Photovoltaic Inverters with Debug Logging",
     "version": "debug",
+    "image": "docker.io/sallius/tsun-gen3-addon",
     "slug": "tsun-proxy-debug",
     "advanced": true,
     "stage": "experimental"

ha_addons/templates/dev_data.json

@@ -3,6 +3,7 @@
     "name": "TSUN-Proxy (Dev)",
     "description": "MQTT Proxy for TSUN Photovoltaic Inverters",
     "version": "dev",
+    "image": "docker.io/sallius/tsun-gen3-addon",
     "slug": "tsun-proxy-dev",
     "advanced": false,
     "stage": "experimental"

ha_addons/templates/rc_data.json

@@ -0,0 +1,10 @@
+
+{
+    "name": "TSUN-Proxy (Release Candidate)",
+    "description": "MQTT Proxy for TSUN Photovoltaic Inverters",
+    "version": "rc",
+    "image": "ghcr.io/s-allius/tsun-gen3-addon",
+    "slug": "tsun-proxy-rc",
+    "advanced": true,
+    "stage": "experimental"
+}

ha_addons/templates/rel_data.json

@@ -2,6 +2,7 @@
 {
     "name": "TSUN-Proxy",
     "description": "MQTT Proxy for TSUN Photovoltaic Inverters",
+    "image": "ghcr.io/s-allius/tsun-gen3-addon",
     "slug": "tsun-proxy",
     "advanced": false,
     "stage": "stable"