Merge pull request #25 from ohAnd/develop

Develop

Author: ohAnd

.github/workflows/docker_feature.yml

@@ -0,0 +1,36 @@
+name: feature - build image and push
+# This workflow builds and pushes a Docker image to GitHub Container Registry.
+# It is triggered on pushes to branches other than "main" and "develop", and can also be triggered manually.
+# The image is tagged with the branch name of the push event.
+# The workflow uses the GITHUB_TOKEN secret for authentication with GitHub Container Registry.
+
+on:
+  push:
+    branches-ignore:
+      - "main"
+      - "develop"
+  workflow_dispatch: # allows manual triggering of the workflow
+
+jobs:
+  publish_image:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Convert repository owner to lowercase
+        run: echo "owner=$(echo '${{ github.repository_owner }}' | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
+
+      - name: Build image
+        run: docker build -t ghcr.io/${{ env.owner }}/eos_connect:feature .
+
+      # Only run tagging and pushing tasks for "push" events
+      - name: Log in to GitHub Container Registry
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+
+      - name: Tag image with develop version
+        run: docker tag ghcr.io/${{ env.owner }}/eos_connect:feature ghcr.io/${{ env.owner }}/eos_connect:feature_dev_${{ github.ref_name }}
+
+      - name: Push Docker image to GitHub Container Registry
+        run: |
+          docker push ghcr.io/${{ env.owner }}/eos_connect:feature_dev_${{ github.ref_name }}

src/CONFIG_README.md

@@ -175,6 +175,44 @@ pv_forecast:
 
 ---
 
+### **MQTT Configuration**
+
+The `mqtt` section allows you to configure the MQTT broker and Home Assistant MQTT Auto Discovery settings.
+
+#### **Parameters**
+
+- **`mqtt.enabled`**:  
+  Enable or disable MQTT functionality.  
+  - `true`: Enable MQTT.  
+  - `false`: Disable MQTT.  
+
+- **`mqtt.broker`**:  
+  The address of the MQTT broker (e.g., `localhost` or `192.168.1.10`).
+
+- **`mqtt.port`**:  
+  The port of the MQTT broker. Default: `1883`.
+
+- **`mqtt.user`**:  
+  The username for authenticating with the MQTT broker (optional).
+
+- **`mqtt.password`**:  
+  The password for authenticating with the MQTT broker (optional).
+
+- **`mqtt.tls`**:  
+  Enable or disable TLS for secure MQTT connections.  
+  - `true`: Use TLS for secure connections.  
+  - `false`: Do not use TLS.  
+
+- **`mqtt.ha_mqtt_auto_discovery`**:  
+  Enable or disable Home Assistant MQTT Auto Discovery.  
+  - `true`: Enable Auto Discovery.  
+  - `false`: Disable Auto Discovery.  
+
+- **`mqtt.ha_mqtt_auto_discovery_prefix`**:  
+  The prefix for Home Assistant MQTT Auto Discovery topics. Default: `homeassistant`.
+
+---
+
 ### **Other Configuration Settings**
 
 - **`refresh_time`**:  
@@ -253,6 +291,15 @@ inverter:
 # EVCC configuration
 evcc:
   url: http://yourEVCCserver:7070  # URL for EVCC server - default: http://yourEVCCserver:7070
+mqtt:
+  enabled: false # Enable MQTT - default: false
+  broker: localhost # URL for MQTT server - default: mqtt://yourMQTTserver
+  port: 1883 # Port for MQTT server - default: 1883
+  user: mqtt_user # Username for MQTT server - default: mqtt
+  password: mqtt_password # Password for MQTT server - default: mqtt
+  tls: false # Use TLS for MQTT server - default: false
+  ha_mqtt_auto_discovery: true # Enable Home Assistant MQTT auto discovery - default: true
+  ha_mqtt_auto_discovery_prefix: homeassistant # Prefix for Home Assistant MQTT auto discovery - default: homeassistant
 refresh_time: 3 # Default refresh time of EOS connect in minutes - default: 3
 time_zone: Europe/Berlin # Default time zone - default: Europe/Berlin
 eos_connect_web_port: 8081 # Default port for EOS connect server - default: 8081

src/config.py

@@ -110,6 +110,21 @@ def create_default_config(self):
                         "url": "http://yourEVCCserver:7070",  # URL for EVCC server
                     }
                 ),
+                "mqtt": CommentedMap(
+                    {
+                        "enabled": False, # Enable MQTT - default: false
+                        # URL for MQTT server - default: mqtt://yourMQTTserver
+                        "broker": "homeassistant",
+                        "port": 1883, # Port for MQTT server - default: 1883
+                        "user": "username", # Username for MQTT server - default: mqtt
+                        "password": "password", # Password for MQTT server - default: mqtt
+                        "tls": False, # Use TLS for MQTT server - default: false
+                        # Enable Home Assistant MQTT auto discovery - default: true
+                        "ha_mqtt_auto_discovery": True,
+                        # Prefix for Home Assistant MQTT auto discovery - default: homeassistant
+                        "ha_mqtt_auto_discovery_prefix": "homeassistant",
+                    }
+                ),
                 "refresh_time": 3,  # Default refresh time in minutes
                 "time_zone": "Europe/Berlin",  # Add default time zone
                 "eos_connect_web_port": 8081,  # Default port for EOS connect server
@@ -268,6 +283,37 @@ def create_default_config(self):
             "URL for EVCC server - default: http://yourEVCCserver:7070",
             "url",
         )
+        # mqtt configuration
+        config.yaml_set_comment_before_after_key(
+            "mqtt", before="MQTT configuration"
+        )
+        config["mqtt"].yaml_add_eol_comment(
+            "Enable MQTT - default: false", "enabled"
+        )
+        config["mqtt"].yaml_add_eol_comment(
+            "URL for MQTT server - default: mqtt://yourMQTTserver", "broker"
+        )
+        config["mqtt"].yaml_add_eol_comment(
+            "Port for MQTT server - default: 1883", "port"
+        )
+        config["mqtt"].yaml_add_eol_comment(
+            "Username for MQTT server - default: mqtt", "user"
+        )
+        config["mqtt"].yaml_add_eol_comment(
+            "Password for MQTT server - default: mqtt", "password"
+        )
+        config["mqtt"].yaml_add_eol_comment(
+            "Use TLS for MQTT server - default: false", "tls"
+        )
+        config["mqtt"].yaml_add_eol_comment(
+            "Enable Home Assistant MQTT auto discovery - default: true",
+            "ha_mqtt_auto_discovery",
+        )
+        config["mqtt"].yaml_add_eol_comment(
+            "Prefix for Home Assistant MQTT auto discovery - default: homeassistant",
+            "ha_mqtt_auto_discovery_prefix",
+        )
+
         # refresh time configuration
         config.yaml_add_eol_comment(
             "Default refresh time of EOS connect in minutes - default: 3",

src/eos_connect.py

@@ -22,6 +22,7 @@
 from interfaces.evcc_interface import EvccInterface
 from interfaces.eos_interface import EosInterface
 from interfaces.price_interface import PriceInterface
+from interfaces.mqtt_interface import MqttInterface
 
 EOS_TGT_DURATION = 48
 EOS_API_GET_PV_FORECAST = "https://api.akkudoktor.net/forecast"
@@ -119,6 +120,10 @@ def charging_state_callback(new_state):
     change_control_state()
 
 
+mqtt_interface = MqttInterface(
+    config_manager.config["mqtt"]
+)
+
 evcc_interface = EvccInterface(
     url=config_manager.config["evcc"]["url"],
     update_interval=10,
@@ -140,7 +145,7 @@ def charging_state_callback(new_state):
     config_manager.config.get("battery", {}).get("url", ""),
     config_manager.config.get("battery", {}).get("soc_sensor", ""),
     config_manager.config.get("battery", {}).get("access_token", ""),
-    config_manager.config.get("battery", {})
+    config_manager.config.get("battery", {}),
 )
 
 price_interface = PriceInterface(
@@ -300,9 +305,7 @@ def get_pv_akku_data():
             "max_charge_power_w": config_manager.config["battery"][
                 "max_charge_power_w"
             ],
-            "initial_soc_percentage": round(
-                battery_interface.get_current_soc()
-            ),
+            "initial_soc_percentage": round(battery_interface.get_current_soc()),
             "min_soc_percentage": config_manager.config["battery"][
                 "min_soc_percentage"
             ],
@@ -525,6 +528,13 @@ def run_optimization(self):
         ) as file:
             json.dump(json_optimize_input, file, indent=4)
 
+        mqtt_interface.update_publish_topics(
+        {
+            "optimization/state": {
+                "value": self.get_current_state()["request_state"]
+            }
+        }
+    )
         optimized_response = eos_interface.eos_set_optimize_request(
             json_optimize_input, config_manager.config["eos"]["timeout"]
         )
@@ -560,6 +570,14 @@ def run_optimization(self):
         sleeptime = (next_eval - loop_now).total_seconds()
         minutes, seconds = divmod(sleeptime, 60)
         self.__set_state_next_run(next_eval.astimezone(time_zone).isoformat())
+        mqtt_interface.update_publish_topics(
+            {
+                "optimization/last_run": {
+                    "value": self.get_current_state()["last_response_timestamp"]},
+                "optimization/next_run": {
+                    "value": self.get_current_state()["next_run"]},
+            }
+        )
         logger.info(
             "[Main] Next optimization at %s. Sleeping for %d min %.0f seconds\n",
             next_eval.strftime("%H:%M:%S"),
@@ -585,6 +603,19 @@ def setting_control_data(ac_charge_demand_rel, dc_charge_demand_rel, discharge_a
     base_control.set_current_ac_charge_demand(ac_charge_demand_rel)
     base_control.set_current_dc_charge_demand(dc_charge_demand_rel)
     base_control.set_current_discharge_allowed(bool(discharge_allowed))
+    mqtt_interface.update_publish_topics(
+        {
+            "control/eos_ac_charge_demand": {
+                "value": base_control.get_current_ac_charge_demand()
+            },
+            "control/eos_dc_charge_demand": {
+                "value": base_control.get_current_dc_charge_demand()
+            },
+            "control/eos_discharge_allowed": {
+                "value": base_control.get_current_discharge_allowed()
+            }
+        }
+    )
     # set the current battery state of charge
     base_control.set_current_battery_soc(battery_interface.get_current_soc())
     # getting the current charging state from evcc
@@ -616,6 +647,23 @@ def change_control_state():
     current_overall_state = base_control.get_current_overall_state_number()
     current_overall_state_text = base_control.get_current_overall_state()
 
+    mqtt_interface.update_publish_topics(
+        {
+            "control/overall_state": {
+                "value": base_control.get_current_overall_state_number()
+                },
+            "optimization/state": {
+                "value": optimization_scheduler.get_current_state()["request_state"]
+            },
+            "control/override_remain_time": { "value": "01:00" },
+            "battery/soc": {"value": battery_interface.get_current_soc()},
+            "battery/remaining_energy": {
+                "value": battery_interface.get_current_usable_capacity()
+            },
+            "status": {"value": "online"},
+        }
+    )
+
     # Check if the overall state of the inverter was changed recently
     if base_control.was_overall_state_changed_recently(180):
         logger.debug("[Main] Overall state changed recently")
@@ -761,6 +809,7 @@ def get_controls():
         "evcc": {
             "charging_state": base_control.get_current_evcc_charging_state(),
             "charging_mode": base_control.get_current_evcc_charging_mode(),
+            "current_session": evcc_interface.get_current_detail_data(),
         },
         "battery": {
             "soc": current_battery_soc,
@@ -799,6 +848,7 @@ def get_controls():
             and inverter_interface is not None
         ):
             inverter_interface.shutdown()
+        mqtt_interface.shutdown()
         evcc_interface.shutdown()
         battery_interface.shutdown()
         logger.info("[Main] Server stopped")

src/interfaces/base_control.py

@@ -72,7 +72,7 @@ def was_overall_state_changed_recently(self, time_window_seconds):
 
     def get_current_ac_charge_demand(self):
         """
-        Returns the current AC charge demand.
+        Returns the current AC charge demand calculated based on maximum battery charge power.
         """
         return self.current_ac_charge_demand