Merge master into Beta

.editorconfig

@@ -6,6 +6,10 @@ charset = utf-8
 end_of_line = lf
 insert_final_newline = true
 
+[simpleAPI/**.php]
+indent_style = space
+indent_size = 4
+
 [*.{py,yml,lock}]
 indent_style = space
 indent_size = 4

.github/workflows/publish_docs_to_wiki.yml

@@ -9,9 +9,9 @@ on:
       - master # This can be changed to any branch of your preference
 
 env:
-  USER_TOKEN: ${{ secrets.WIKI_ACTION_TOKEN }} # This is the repository secret
-  USER_NAME: LKuemmel # Enter the username of your (bot) account
-  USER_EMAIL: lena.kuemmel@openwb.de # Enter the e-mail of your (bot) account
+  WIKI_TOKEN: ${{ secrets.WIKI_ACTION_TOKEN }} # Personal Access Token with repo scope
+  USER_NAME: "GitHub Actions" # Enter the username of your (bot) account  
+  USER_EMAIL: "actions@github.com" # Enter the e-mail of your (bot) account
   OWNER: ${{ github.event.repository.owner.name }} # This is the repository owner
   REPOSITORY_NAME: ${{ github.event.repository.name }} # This is the repository name
 
@@ -31,15 +31,15 @@ jobs:
           mkdir tmp_wiki
           cd tmp_wiki
           git init
-          git config user.name $USER_NAME
-          git config user.email $USER_EMAIL
-          git pull https://$USER_TOKEN@github.com/$OWNER/$REPOSITORY_NAME.wiki.git
+          git pull https://$WIKI_TOKEN@github.com/$OWNER/$REPOSITORY_NAME.wiki.git
       # 4. Synchronize differences between `docs` & `tmp_wiki`
       # 5. Push new Wiki content
       - name: Push content to wiki
         run: |
           rsync -av --delete docs/ tmp_wiki/ --exclude .git
           cd tmp_wiki
+          git config user.name "$USER_NAME"
+          git config user.email "$USER_EMAIL"
           git add .
-          git commit -m "Update Wiki content"
-          git push -f --set-upstream https://$USER_TOKEN@github.com/$OWNER/$REPOSITORY_NAME.wiki.git master
+          git commit -m "Update Wiki content" || echo "No changes to commit"
+          git push -f --set-upstream https://$WIKI_TOKEN@github.com/$OWNER/$REPOSITORY_NAME.wiki.git master

.gitignore

@@ -10,11 +10,13 @@
 .vscode/*
 __pycache__/
 node_modules/
+data/config/eebus/certs/*
 data/log/*
 data/charge_log/*
 data/daily_log/*
 data/monthly_log/*
 data/backup/*.tar.gz
+data/backup/*.openwb-backup*
 data/restore/*.tar.gz
 data/data_migration/*.tar.gz
 ramdisk/*

data/config/mosquitto/mosquitto.acl

@@ -1,4 +1,4 @@
-# openwb-version:2
+# openwb-version:3
 # allow publishing set topics
 topic write openWB/set/#
 # allow clearing system messages
@@ -11,3 +11,5 @@ topic read openWB/#
 topic read openWB-remote/#
 # allow brach "others" for devices other than openWB
 topic readwrite others/#
+# allow read write access for simpleAPI
+topic readwrite openWB/simpleAPI/#

data/config/openwb-simpleAPI.service

@@ -0,0 +1,15 @@
+# openwb-version:1
+[Unit]
+Description="openWB mqtt simpleAPI"
+After=mosquitto.service
+
+[Service]
+User=openwb
+WorkingDirectory=/var/www/html/openWB
+ExecStart=/var/www/html/openWB/simpleAPI/simpleAPI_mqtt.py
+Restart=always
+# extend timeout to 15min for long running atreboot
+TimeoutStartSec=900
+
+[Install]
+WantedBy=multi-user.target

data/config/simpleAPI_mqtt_config.json

@@ -0,0 +1,11 @@
+{
+  "host": "localhost",
+  "port": 1883,
+  "username": null,
+  "password": null,
+  "use_tls": false,
+  "qos": 0,
+  "retain": true,
+  "reconnect_delay": 10,
+  "log_level": "INFO"
+}

docs/Neues Modul programmieren.md

@@ -44,4 +44,37 @@ Bei manchen Fahrzeugen kann der SoC nicht während der Ladung abgefragt werden.
 
 Nach dreimaliger fehlgeschlagener Abfrage wird der SoC auf 0% gesetzt, damit in jedem Fall geladen wird.
 
-_Bei Fragen programmiert Ihr das SoC-Modul vorerst, wie Ihr es versteht, und erstellt einen (Draft-)PR. Wir unterstützen Euch gerne per Review.
+_Bei Fragen programmiert Ihr das SoC-Modul vorerst, wie Ihr es versteht, und erstellt einen (Draft-)PR. Wir unterstützen Euch gerne per Review._
+
+### Breaking Changes und Ergänzen von neuen Einstellungen
+
+Die Klasse `UpdateConfig` verwaltet automatische Migrationen bei Breaking Changes und neuen Einstellungen. Das System funktioniert folgendermaßen:
+- Für jede notwendige Anpassung wird eine nummerierte Upgrade-Funktion erstellt.
+- Beim Systemstart werden alle noch nicht ausgeführten Upgrade-Funktionen automatisch aufgerufen
+- Die Nummern der bereits ausgeführten Funktionen werden persistent gespeichert, um mehrfache Ausführung zu verhindern. Der aktuelle Migrations-Status wird im MQTT-Topic `openWB/system/datastore_version` veröffentlicht.
+
+Alle Upgrade-Funktionen folgen einem einheitlichen Schema:
+```python
+def upgrade_datastore_104(self) -> None:
+    """Upgrade-Funktion für Datastore-Version 104: Ergänzt fehlende aWATTar-Konfigurationsparameter"""
+    def upgrade(topic: str, payload) -> None:
+        """Prüft und migriert ein einzelnes MQTT-Topic"""
+        # Topic finden, das aktualisiert werden soll
+        if "openWB/optional/ep/flexible_tariff/provider" == topic:
+            provider = decode_payload(payload)
+            # Nur für aWATTar-Provider ausführen
+            if provider["type"] == "awattar":
+                # Prüfen, ob das "net"-Feld fehlt (neue Konfiguration)
+                if provider["configuration"].get("net") is None:
+                    # Standardwerte für fehlende Konfigurationsparameter setzen
+                    provider["configuration"]["net"] = False
+                    provider["configuration"]["fix"] = 0.015
+                    provider["configuration"]["proportional"] = 0.03
+                    provider["configuration"]["tax"] = 0.2
+                    # Aktualisierte Konfiguration zurückgeben
+                    return {topic: provider}
+    # Alle gespeicherten MQTT-Topics durchlaufen und Upgrade-Funktion anwenden
+    self._loop_all_received_topics(upgrade)
+    # Diese Upgrade-Funktion als ausgeführt markieren (Version 104)
+    self._append_datastore_version(104)
+```

docs/samples/sample_modbus/sample_modbus/bat.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+from enum import IntEnum
 from typing import Optional, TypedDict, Any
 from modules.common.abstract_device import AbstractBat
 from modules.common.component_state import BatState
@@ -15,7 +16,23 @@ class KwargsDict(TypedDict):
     client: ModbusTcpClient_
 
 
+class Register(IntEnum):
+    CURRENT_L1 = 0x06
+    POWER = 0x0C
+    SOC = 0x46
+    IMPORTED = 0x48
+    EXPORTED = 0x4A
+
+
 class SampleBat(AbstractBat):
+    REG_MAPPING = (
+        (Register.CURRENT_L1, [ModbusDataType.FLOAT_32]*3),
+        (Register.POWER, [ModbusDataType.FLOAT_32]*3),
+        (Register.SOC, ModbusDataType.FLOAT_32),
+        (Register.IMPORTED, ModbusDataType.FLOAT_32),
+        (Register.EXPORTED, ModbusDataType.FLOAT_32),
+    )
+
     def __init__(self, component_config: SampleBatSetup, **kwargs: Any) -> None:
         self.component_config = component_config
         self.kwargs: KwargsDict = kwargs
@@ -29,6 +46,20 @@ def initialize(self) -> None:
 
     def update(self) -> None:
         unit = self.component_config.configuration.modbus_id
+        # Modbus-Bulk reader, liest einen Block von Registern und gibt ein Dictionary mit den Werten zurück
+        # read_input_registers_bulk benötigit als Parameter das Startregister, die Anzahl der Register,
+        # Register-Mapping und die Modbus-ID
+        resp = self.client.read_input_registers_bulk(
+            Register.CURRENT_L1, 70, mapping=self.REG_MAPPING, unit=self.id)
+        bat_state = BatState(
+            power=resp[Register.POWER],
+            soc=resp[Register.SOC],
+            imported=resp[Register.IMPORTED],
+            exported=resp[Register.EXPORTED],
+        )
+        self.store.set(bat_state)
+
+        # Einzelregister lesen (dauert länger, bei sehr weit >100 auseinanderliegenden Registern sinnvoll)
         power = self.client.read_holding_registers(reg, ModbusDataType.INT_32, unit=unit)
         soc = self.client.read_holding_registers(reg, ModbusDataType.INT_32, unit=unit)
         imported, exported = self.sim_counter.sim_count(power)