bump to version v0.13.0-rc1

2025-04-06 22:42:51 +02:00
parent 477a278cdc
commit 3b515f7384
8 changed files with 193 additions and 35 deletions
--- a/ha_addon_rc/CHANGELOG.md
+++ b/ha_addon_rc/CHANGELOG.md
@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

 ## [unreleased]

+- update dependency python to 3.13
+- add initial support for TSUN MS-3000
+- add initial apparmor support [#293](https://github.com/s-allius/tsun-gen3-proxy/issues/293)
+- add Modbus polling mode for DCU1000 [#292](https://github.com/s-allius/tsun-gen3-proxy/issues/292)
+- add Modbus scanning mode
+- allow `R47`serial numbers for GEN3 inverters
+- add watchdog for Add-ons
+- add first costumer apparmor definition
+- Respect logging.ini file, if LOG_ENV isn't set well [#288](https://github.com/s-allius/tsun-gen3-proxy/issues/288)
+- Remove trailing apostrophe in the log output [#288](https://github.com/s-allius/tsun-gen3-proxy/issues/288)
+- update AddOn base docker image to version 17.2.1
+- addon: add date and time to dev container version
+- Update AddOn python3 to 3.12.9-r0
+- add initial DCU support
+- update aiohttp to version 3.11.12
+- fix the path handling for logging.ini and default_config.toml [#180](https://github.com/s-allius/tsun-gen3-proxy/issues/180)
+
 ## [0.12.1] - 2025-01-13

 - addon: bump base image version to v17.1.0
--- a/ha_addon_rc/DOCS.md
+++ b/ha_addon_rc/DOCS.md
@@ -68,8 +68,8 @@ Example add-on configuration for GEN3PLUS inverters:
 inverters:
  - serial: Y17000000000000
    monitor_sn: 2000000000
-    node_id: PV-Garage
-    suggested_area: Garage
+    node_id: inv_1
+    suggested_area: Roof
    modbus_polling: true
    client_mode.host: 192.168.x.x
    client_mode.port: 8899
@@ -84,6 +84,21 @@ inverters:
    pv4.type: SF-M18/144550
 ```

+Example add-on configuration for GEN3PLUS energie storages:
+
+```yaml
+batteries:
+  - serial: 4100000000000000
+    monitor_sn: 2300000000
+    node_id: bat_1
+    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!_

 more information about the configuration can be found in the [configuration details page][configdetails].
--- a/ha_addon_rc/LICENSE.md
+++ b/ha_addon_rc/LICENSE.md
@@ -0,0 +1,11 @@
+# Copyright &copy; 2023 Stefan Allius
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--- a/ha_addon_rc/README.md
+++ b/ha_addon_rc/README.md
@@ -0,0 +1,23 @@
+# Home Assistant Add-on: TSUN-Proxy (Release Candidate)
+
+This is a release candidate of the `TSUN Proxy` Add-On.
+
+It is intended for testing the next release.
+For production, please use the stable version 'TSUN Proxy'.
+
+## Features
+
+- Supports TSUN GEN3 PLUS inverters: TSOL-MS2000, MS1800 and MS1600
+- Supports TSUN GEN3 PLUS batteries: TSOL-DC1000 (from version 0.13)
+- Supports TSUN GEN3 inverters: TSOL-MS3000, MS800, MS700, MS600, MS400, MS350 and MS300
+- `Home-Assistant` auto-discovery support
+- `MODBUS` support via MQTT topics
+- `AT-Command` support via MQTT topics (GEN3PLUS only)
+- Faster DataUp interval sends measurement data to the MQTT broker every minute
+- Self-sufficient island operation without internet
+- Security-Features:
+  - control access via `AT-commands`
+
+## About
+
+This Add-on and the TSUN Proxy is not related to the company TSUN. It is a private initiative that aims to connect TSUN inverters and storage systems with an MQTT broker. There is no support and no warranty from TSUN.
--- a/ha_addon_rc/apparmor.txt
+++ b/ha_addon_rc/apparmor.txt
@@ -0,0 +1,52 @@
+#include <tunables/global>
+
+profile tsun-proxy-rc flags=(attach_disconnected,mediate_deleted) {
+  #include <abstractions/base>
+
+  # Capabilities
+  file,
+  signal (send) set=(kill,term,int,hup,cont),
+
+  # S6-Overlay
+  /init ix,
+  /bin/** ix,
+  /usr/bin/** ix,
+  /run/{s6,s6-rc*,service}/** ix,
+  /package/** ix,
+  /command/** ix,
+  /etc/services.d/** rwix,
+  /etc/cont-init.d/** rwix,
+  /etc/cont-finish.d/** rwix,
+  /run/{,**} rwk,
+  /dev/tty rw,
+
+  # Bashio
+  /usr/lib/bashio/** ix,
+  /tmp/** rwk,
+
+  # Access to options.json and other files within your addon
+  /data/** rw,
+
+  # Start new profile for service
+  /usr/bin/myprogram cx -> myprogram,
+
+  profile myprogram flags=(attach_disconnected,mediate_deleted) {
+    #include <abstractions/base>
+
+    # Receive signals from S6-Overlay
+    signal (receive) peer=*_tsun-proxy-rc,
+
+    # Access to options.json and other files within your addon
+    /data/** rw,
+
+    # Access to mapped volumes specified in config.json
+    /share/** rw,
+
+    # Access required for service functionality
+    /usr/bin/myprogram r,
+    /bin/bash rix,
+    /bin/echo ix,
+    /etc/passwd r,
+    /dev/tty rw,
+  }
+}
--- a/ha_addon_rc/config.yaml
+++ b/ha_addon_rc/config.yaml
@@ -24,17 +24,15 @@ ports:
  5005/tcp: 5005
  10000/tcp: 10000

-# FIXME: we disabled the watchdog due to exceptions in the ha supervisor. See: https://github.com/s-allius/tsun-gen3-proxy/issues/249
-# watchdog: "http://[HOST]:[PORT:8127]/-/healthy"
+watchdog: "http://[HOST]:[PORT:8127]/-/healthy"

 # Definition of parameters in the configuration tab of the addon
 # 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

 schema:
  inverters:
-    - serial: match(^(R17|Y17|Y47).{13}$)
+    - serial: match(^(R17|R47|Y17|Y47).{13}$)
      monitor_sn: int?
      node_id: str
      suggested_area: str
@@ -42,11 +40,9 @@ schema:
      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
-      #    type: str
-      #    manufacturer: str
-      # daher diese variante
+      modbus_scanning.start: int(0,65535)?
+      modbus_scanning.step: int(0,65535)?
+      modbus_scanning.bytes: int(1,80)?
      pv1.manufacturer: str?
      pv1.type: str?
      pv2.manufacturer: str?
@@ -62,6 +58,19 @@ schema:
  tsun.enabled: bool
  solarman.enabled: bool
  inverters.allow_all: bool
+  batteries:
+    - serial: match(^(410).{13}$)
+      monitor_sn: int
+      node_id: str
+      suggested_area: str
+      modbus_polling: bool
+      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?
+      pv1.manufacturer: str?
+      pv1.type: str?
+      pv2.manufacturer: str?
+      pv2.type: str?

  # optionale parameter

@@ -90,17 +99,21 @@ schema:
 # If any default value is given, the option becomes a required value.
 options:
  inverters:
-    - serial: R17E760702080400
-      node_id: PV-Garage
+    - serial: R17E000000000000
+      monitor_sn: 0
+      node_id: inv_1
+      suggested_area: Roof
+      modbus_polling: false
+      pv1.manufacturer: Shinefar
+      pv1.type: SF-M18/144550
+      pv2.manufacturer: Shinefar
+      pv2.type: SF-M18/144550
+  batteries:
+    - serial: 4100000000000000
+      monitor_sn: 0
+      node_id: bat_1
      suggested_area: Garage
      modbus_polling: false
-      # strings:
-      #  - string: PV1
-      #    type: SF-M18/144550
-      #    manufacturer: Shinefar
-      #  - string: PV2
-      #    type: SF-M18/144550
-      #    manufacturer: Shinefar
      pv1.manufacturer: Shinefar
      pv1.type: SF-M18/144550
      pv2.manufacturer: Shinefar
--- a/ha_addon_rc/translations/de.yaml
+++ b/ha_addon_rc/translations/de.yaml
@@ -10,8 +10,21 @@ configuration:
      Weitere wechselrichterspezifische Parameter (z.B. Polling Mode) können im 
      Konfigurationsblock gesetzt werden.

-      Die Seriennummer der GEN3 Wechselrichter beginnen mit `R17` und die der GEN3PLUS
-      Wechselrichter mir `Y17`oder `47`!
+      Die Seriennummer der GEN3 Wechselrichter beginnen mit `R17` oder `R47` und die der GEN3PLUS
+      Wechselrichter mit `Y17`oder `Y47`!
+
+      Siehe Beispielkonfiguration im Dokumentations-Tab
+  batteries:
+    name: Batterien
+    description: >+
+      Für jeden Energiespeicher muss die Seriennummer des Speichers einer MQTT
+      Definition zugeordnet werden. Dazu wird der entsprechende Konfigurationsblock mit der
+      16-stellige Seriennummer gestartet, so dass alle nachfolgenden Parameter diesem 
+      Speicher zugeordnet sind.
+      Weitere speicherspezifische Parameter (z.B. Polling Mode) können im 
+      Konfigurationsblock gesetzt werden.
+
+      Die Seriennummer der GEN3PLUS Batteriespeicher beginnen mit `410`!

      Siehe Beispielkonfiguration im Dokumentations-Tab

@@ -25,14 +38,14 @@ configuration:
      ein => normaler Proxy-Betrieb.
      aus => Der Wechselrichter wird vom Internet isoliert.
  solarman.enabled:
-    name: Verbindung zur Solarman Cloud - nur für GEN3PLUS Wechselrichter
+    name: Verbindung zur Solarman/TSUN Cloud - nur für GEN3PLUS Wechselrichter
    description: >+
-      Schaltet die Verbindung zur Solarman Cloud ein/aus.
-      Diese Verbindung ist erforderlich, wenn Sie Daten an die Solarman Cloud senden möchten,
-      z.B. um die Solarman Apps zu nutzen oder Firmware-Updates zu erhalten.
+      Schaltet die Verbindung zur Solarman oder TSUN Cloud ein/aus.
+      Diese Verbindung ist erforderlich, wenn Sie Daten an die Cloud senden möchten,
+      z.B. um die Solarman App oder TSUN Smart App zu nutzen oder Firmware-Updates zu erhalten.
      
      ein => normaler Proxy-Betrieb.
-      aus => Der Wechselrichter wird vom Internet isoliert.
+      aus => Die GEN3PLUS Geräte werden vom Internet isoliert.
  inverters.allow_all:
    name: Erlaube Verbindungen von sämtlichen Wechselrichtern
    description: >-
--- a/ha_addon_rc/translations/en.yaml
+++ b/ha_addon_rc/translations/en.yaml
@@ -7,13 +7,27 @@ configuration:
      definition. To do this, the corresponding configuration block is started with
      16-digit serial number so that all subsequent parameters are assigned
      to this inverter. Further inverter-specific parameters (e.g. polling mode) can be set
-      in the configuration block
+      in the configuration block.

-      The serial numbers of all GEN3 inverters start with `R17` and that of the GEN3PLUS
-      inverters with ‘Y17’ or ‘47’!
+      The serial numbers of all GEN3 inverters start with `R17` or `R47` and that of the GEN3PLUS
+      inverters with ‘Y17’ or ‘Y47’!
      
      For reference see example configuration in Documentation Tab

+  batteries:
+    name: Energy Storages
+    description: >+
+      For each energy storage device, the serial number of the storage device must be
+      assigned to an MQTT definition. To do this, the corresponding configuration block
+      is started with the 16-digit serial number so that all subsequent parameters are
+      assigned to this energy storage. Further inverter-specific parameters (e.g. polling
+      mode) can be set in the configuration block.
+
+      The serial numbers of all GEN3PLUS energy storages start with ‘410’!
+
+      For reference see example configuration in Documentation Tab
+
+
  tsun.enabled:
    name: Connection to TSUN Cloud - for GEN3 inverter only
    description: >+
@@ -24,14 +38,14 @@ configuration:
      on => normal proxy operation.
      off => The Inverter become isolated from Internet.
  solarman.enabled:
-    name: Connection to Solarman Cloud - for GEN3PLUS inverter only
+    name: Connection to Solarman/TSUN Cloud - for GEN3PLUS inverter only
    description: >+
-      switch on/off connection to the Solarman cloud.
-      This connection is only required if you want send data to the Solarman cloud
-      eg. to use the Solarman APPs or receive firmware updates.
+      switch on/off connection to the Solarman or TSUN cloud.
+      This connection is only required if you want send data to the cloud
+      eg. to use the Solarman APP, the TSUN Smart APP or receive firmware updates.
      
      on => normal proxy operation.
-      off => The Inverter become isolated from Internet
+      off => The GEN3PLUS devices become isolated from Internet
  inverters.allow_all:
    name: Allow all connections from all inverters
    description: >-