emhass 0.13.3__tar.gz → 0.13.4__tar.gz

{emhass-0.13.3 → emhass-0.13.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: emhass
-Version: 0.13.3
+Version: 0.13.4
 Summary: An Energy Management System for Home Assistant
 Project-URL: Homepage, https://github.com/davidusb-geek/emhass
 Project-URL: Source, https://github.com/davidusb-geek/emhass
@@ -118,17 +118,10 @@ Description-Content-Type: text/markdown
 </div>
 
 <br>
-<p align="center">
-If you like this work please consider buying a coffee ;-) 
-</p>
-<p align="center">
-  <a href="https://www.buymeacoffee.com/davidusbgeek" target="_blank">
-    <img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" >
-  </a>
+<p align="left">
+EMHASS is a Python module designed to optimize your home energy interfacing with Home Assistant.
 </p>
 
-EHMASS is a Python module designed to optimize your home energy interfacing with Home Assistant.
-
 ## Introduction
 
 EMHASS (Energy Management for Home Assistant) is an optimization tool designed for residential households. The package uses a Linear Programming approach to optimize energy usage while considering factors such as electricity prices, power generation from solar panels, and energy storage from batteries. EMHASS provides a high degree of configurability, making it easy to integrate with Home Assistant and other smart home systems. Whether you have solar panels, energy storage, or just a controllable load, EMHASS can provide an optimized daily schedule for your devices, allowing you to save money and minimize your environmental impact.
@@ -197,12 +190,13 @@ _Note: Both EMHASS via Docker and EMHASS-Add-on contain the same Docker image. T
 
 ### Method 2) Running EMHASS in Docker
 
-You can also install EMHASS using Docker as a container. This can be in the same machine as Home Assistant (if your running Home Assistant as a Docker container) or in a different distant machine. To install first pull the latest image:
+You can also install EMHASS using Docker as a container. This can be in the same machine as Home Assistant (if your running Home Assistant as a Docker container) or in a different distant machine. The "share" folder is where EMHASS stores the config.json file. In the examples below adjust the "-v" volume mappings to reflect where your path to the local host directory needs to be mapped to.
+To install first pull the latest image:
 ```bash
 # pull Docker image
 docker pull ghcr.io/davidusb-geek/emhass:latest
-# run Docker image, mounting config.json and secrets_emhass.yaml from host
-docker run --rm -it --restart always  -p 5000:5000 --name emhass-container -v ./config.json:/share/config.json -v ./secrets_emhass.yaml:/app/secrets_emhass.yaml ghcr.io/davidusb-geek/emhass:latest
+# run Docker image, mounting the dir storing config.json and secrets_emhass.yaml from host
+docker run --rm -it --restart always  -p 5000:5000 --name emhass-container -v /emhass/share:/share/ -v /emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml ghcr.io/davidusb-geek/emhass:latest
 ```
 *Note it is not recommended to install the latest EMHASS image with `:latest` *(as you would likely want to control when you update EMHASS version)*. Instead, find the [latest version tag](https://github.com/davidusb-geek/emhass/pkgs/container/emhass) (E.g: `v0.2.1`) and replace `latest`*
 
@@ -216,7 +210,7 @@ cd emhass
 # may need to set architecture tag (docker build --build-arg TARGETARCH=amd64 -t emhass-local .)
 docker build -t emhass-local . 
 # run built Docker image, mounting config.json and secrets_emhass.yaml from host
-docker run --rm -it -p 5000:5000 --name emhass-container -v ./config.json:/share/config.json -v ./secrets_emhass.yaml:/app/secrets_emhass.yaml emhass-local
+docker run --rm -it -p 5000:5000 --name emhass-container -v /emhass/share:/share -v /emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml emhass-local
 ```
 
 Before running the docker container, make sure you have a designated folder for emhass on your host device and a `secrets_emhass.yaml` file. You can get a example of the secrets file from [`secrets_emhass(example).yaml`](https://github.com/davidusb-geek/emhass/blob/master/secrets_emhass(example).yaml) file on this repository.
@@ -232,23 +226,23 @@ Latitude: 45.83
 Longitude: 6.86
 Altitude: 4807.8
 EOT
-docker run --rm -it --restart always  -p 5000:5000 --name emhass-container -v ./config.json:/share/config.json -v ./secrets_emhass.yaml:/app/secrets_emhass.yaml ghcr.io/davidusb-geek/emhass:latest
+docker run --rm -it --restart always  -p 5000:5000 --name emhass-container -v /emhass/share:/share -v /emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml ghcr.io/davidusb-geek/emhass:latest
 ```
 
 #### Docker, things to note 
 
-- You can create a `config.json` file prior to running emhass. *(obtain a example from: [config_defaults.json](https://github.com/davidusb-geek/emhass/blob/enhass-standalone-addon-merge/src/emhass/data/config_defaults.json)* Alteratively, you can insert your parameters into the configuration page on the EMHASS web server. (for EMHASS to auto create a config.json) With either option, the volume mount `-v ./config.json:/share/config.json` should be applied to make sure your config is stored on the host device. (to be not deleted when the EMHASS container gets removed/image updated)*
+- You can create a `config.json` file prior to running emhass. *(obtain a example from: [config_defaults.json](https://github.com/davidusb-geek/emhass/blob/enhass-standalone-addon-merge/src/emhass/data/config_defaults.json)* Alteratively, you can insert your parameters into the configuration page on the EMHASS web server. (for EMHASS to auto create a config.json) With either option, the volume mount `-v /emhass/share:/share` should be applied to make sure your config is stored on the host device. (to be not deleted when the EMHASS container gets removed/image updated)*
 
 - If you wish to keep a local, semi-persistent copy of the EMHASS-generated data, create a local folder on your device, then mount said folder inside the container.  
   ```bash
   #create data folder 
   mkdir -p ~/emhass/data 
-  docker run -it --restart always -p 5000:5000 -e LOCAL_COSTFUN="profit" -v ~/emhass/config.json:/app/config.json -v ~/emhass/data:/data  -v ~/emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml --name DockerEMHASS <REPOSITORY:TAG>
+  docker run -it --restart always -p 5000:5000 -e LOCAL_COSTFUN="profit" -v /emhass/share:/share -v /emhass/data:/data  -v /emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml --name DockerEMHASS <REPOSITORY:TAG>
   ```
     
 - If you wish to set the web_server's homepage optimization diagrams to a timezone other than UTC, set `TZ` environment variable on docker run:
   ```bash
-  docker run -it --restart always -p 5000:5000  -e TZ="Europe/Paris" -v ~/emhass/config.json:/app/config.json -v ~/emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml --name DockerEMHASS <REPOSITORY:TAG>
+  docker run -it --restart always -p 5000:5000  -e TZ="Europe/Paris" -v /emhass/share:/share -v /emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml --name DockerEMHASS <REPOSITORY:TAG>
   ```  
 ### Method 3) Legacy method using a Python virtual environment *(Legacy CLI)*
 If you wish to run EMHASS optimizations with cli commands. *(no persistent web server session)* you can run EMHASS via the python package alone *(not wrapped in a Docker container)*.
@@ -320,12 +314,22 @@ Additional optimization strategies were developed later, that can be used in com
 
 ### Dayahead Optimization - Method 1) Add-on and docker standalone
 
-In `configuration.yaml`:
+We can use the `shell_command` integration in `configuration.yaml`:
 ```yaml
 shell_command:
   dayahead_optim: "curl -i -H \"Content-Type:application/json\" -X POST -d '{}' http://localhost:5000/action/dayahead-optim"
   publish_data: "curl -i -H \"Content-Type:application/json\" -X POST -d '{}' http://localhost:5000/action/publish-data"
 ```
+An alternative that will be useful when passing data at runtime (see dedicated section), we can use the the `rest_command` instead:
+```yaml
+rest_command:
+  url: http://127.0.0.1:5000/action/dayahead-optim
+  method: POST
+  headers:
+    content-type: application/json
+  payload: >-
+    {}
+```
 ### Dayahead Optimization - Method 2) Legacy method using a Python virtual environment
 
 In `configuration.yaml`:
@@ -388,8 +392,8 @@ In `automations.yaml`:
 ```
 in configuration page/`config.json` 
 ```json
-'method_ts_round': "first"
-'continual_publish': true
+"method_ts_round": "first"
+"continual_publish": true
 ```
 In this automation, the day-ahead optimization is performed once a day, every day at 5:30am. 
 If the `optimization_time_step` parameter is set to `30` *(default)* in the configuration, the results of the day-ahead optimization will generate 48 values *(for each entity)*, a value for every 30 minutes in a day *(i.e. 24 hrs x 2)*.
@@ -543,7 +547,7 @@ For users who wish to have full control of exactly when they would like to run a
 
 in configuration page/`config.json` :
 ```json
-'continual_publish': false
+"continual_publish": false
 ```
 POST action :
 ```bash
@@ -667,6 +671,25 @@ curl -i -H 'Content-Type:application/json' -X POST -d '{"pv_power_forecast":[0,
 curl -i -H 'Content-Type:application/json' -X POST -d '{"pv_power_forecast":[0, 70, 141.22, 246.18, 513.5, 753.27, 1049.89, 1797.93, 1697.3, 3078.93], "prediction_horizon":10, "soc_init":0.5,"soc_final":0.6,"operating_hours_of_each_deferrable_load":[1,3],"start_timesteps_of_each_deferrable_load":[0,3],"end_timesteps_of_each_deferrable_load":[0,6]}' http://localhost:5000/action/naive-mpc-optim
 ```
 
+For a more readable option we can use the `rest_command` integration:
+```yaml
+rest_command:
+  url: http://127.0.0.1:5000/action/dayahead-optim
+  method: POST
+  headers:
+    content-type: application/json
+  payload: >-
+    {
+      "pv_power_forecast": [0, 70, 141.22, 246.18, 513.5, 753.27, 1049.89, 1797.93, 1697.3, 3078.93],
+      "prediction_horizon":10,
+      "soc_init":0.5,
+      "soc_final":0.6,
+      "operating_hours_of_each_deferrable_load":[1,3],
+      "start_timesteps_of_each_deferrable_load":[0,3],
+      "end_timesteps_of_each_deferrable_load":[0,6]
+    }
+```
+
 ## A machine learning forecaster
 
 Starting in v0.4.0 a new machine learning forecaster class was introduced.

{emhass-0.13.3 → emhass-0.13.4}/README.md

@@ -62,17 +62,10 @@
 </div>
 
 <br>
-<p align="center">
-If you like this work please consider buying a coffee ;-) 
-</p>
-<p align="center">
-  <a href="https://www.buymeacoffee.com/davidusbgeek" target="_blank">
-    <img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" >
-  </a>
+<p align="left">
+EMHASS is a Python module designed to optimize your home energy interfacing with Home Assistant.
 </p>
 
-EHMASS is a Python module designed to optimize your home energy interfacing with Home Assistant.
-
 ## Introduction
 
 EMHASS (Energy Management for Home Assistant) is an optimization tool designed for residential households. The package uses a Linear Programming approach to optimize energy usage while considering factors such as electricity prices, power generation from solar panels, and energy storage from batteries. EMHASS provides a high degree of configurability, making it easy to integrate with Home Assistant and other smart home systems. Whether you have solar panels, energy storage, or just a controllable load, EMHASS can provide an optimized daily schedule for your devices, allowing you to save money and minimize your environmental impact.
@@ -141,12 +134,13 @@ _Note: Both EMHASS via Docker and EMHASS-Add-on contain the same Docker image. T
 
 ### Method 2) Running EMHASS in Docker
 
-You can also install EMHASS using Docker as a container. This can be in the same machine as Home Assistant (if your running Home Assistant as a Docker container) or in a different distant machine. To install first pull the latest image:
+You can also install EMHASS using Docker as a container. This can be in the same machine as Home Assistant (if your running Home Assistant as a Docker container) or in a different distant machine. The "share" folder is where EMHASS stores the config.json file. In the examples below adjust the "-v" volume mappings to reflect where your path to the local host directory needs to be mapped to.
+To install first pull the latest image:
 ```bash
 # pull Docker image
 docker pull ghcr.io/davidusb-geek/emhass:latest
-# run Docker image, mounting config.json and secrets_emhass.yaml from host
-docker run --rm -it --restart always  -p 5000:5000 --name emhass-container -v ./config.json:/share/config.json -v ./secrets_emhass.yaml:/app/secrets_emhass.yaml ghcr.io/davidusb-geek/emhass:latest
+# run Docker image, mounting the dir storing config.json and secrets_emhass.yaml from host
+docker run --rm -it --restart always  -p 5000:5000 --name emhass-container -v /emhass/share:/share/ -v /emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml ghcr.io/davidusb-geek/emhass:latest
 ```
 *Note it is not recommended to install the latest EMHASS image with `:latest` *(as you would likely want to control when you update EMHASS version)*. Instead, find the [latest version tag](https://github.com/davidusb-geek/emhass/pkgs/container/emhass) (E.g: `v0.2.1`) and replace `latest`*
 
@@ -160,7 +154,7 @@ cd emhass
 # may need to set architecture tag (docker build --build-arg TARGETARCH=amd64 -t emhass-local .)
 docker build -t emhass-local . 
 # run built Docker image, mounting config.json and secrets_emhass.yaml from host
-docker run --rm -it -p 5000:5000 --name emhass-container -v ./config.json:/share/config.json -v ./secrets_emhass.yaml:/app/secrets_emhass.yaml emhass-local
+docker run --rm -it -p 5000:5000 --name emhass-container -v /emhass/share:/share -v /emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml emhass-local
 ```
 
 Before running the docker container, make sure you have a designated folder for emhass on your host device and a `secrets_emhass.yaml` file. You can get a example of the secrets file from [`secrets_emhass(example).yaml`](https://github.com/davidusb-geek/emhass/blob/master/secrets_emhass(example).yaml) file on this repository.
@@ -176,23 +170,23 @@ Latitude: 45.83
 Longitude: 6.86
 Altitude: 4807.8
 EOT
-docker run --rm -it --restart always  -p 5000:5000 --name emhass-container -v ./config.json:/share/config.json -v ./secrets_emhass.yaml:/app/secrets_emhass.yaml ghcr.io/davidusb-geek/emhass:latest
+docker run --rm -it --restart always  -p 5000:5000 --name emhass-container -v /emhass/share:/share -v /emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml ghcr.io/davidusb-geek/emhass:latest
 ```
 
 #### Docker, things to note 
 
-- You can create a `config.json` file prior to running emhass. *(obtain a example from: [config_defaults.json](https://github.com/davidusb-geek/emhass/blob/enhass-standalone-addon-merge/src/emhass/data/config_defaults.json)* Alteratively, you can insert your parameters into the configuration page on the EMHASS web server. (for EMHASS to auto create a config.json) With either option, the volume mount `-v ./config.json:/share/config.json` should be applied to make sure your config is stored on the host device. (to be not deleted when the EMHASS container gets removed/image updated)*
+- You can create a `config.json` file prior to running emhass. *(obtain a example from: [config_defaults.json](https://github.com/davidusb-geek/emhass/blob/enhass-standalone-addon-merge/src/emhass/data/config_defaults.json)* Alteratively, you can insert your parameters into the configuration page on the EMHASS web server. (for EMHASS to auto create a config.json) With either option, the volume mount `-v /emhass/share:/share` should be applied to make sure your config is stored on the host device. (to be not deleted when the EMHASS container gets removed/image updated)*
 
 - If you wish to keep a local, semi-persistent copy of the EMHASS-generated data, create a local folder on your device, then mount said folder inside the container.  
   ```bash
   #create data folder 
   mkdir -p ~/emhass/data 
-  docker run -it --restart always -p 5000:5000 -e LOCAL_COSTFUN="profit" -v ~/emhass/config.json:/app/config.json -v ~/emhass/data:/data  -v ~/emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml --name DockerEMHASS <REPOSITORY:TAG>
+  docker run -it --restart always -p 5000:5000 -e LOCAL_COSTFUN="profit" -v /emhass/share:/share -v /emhass/data:/data  -v /emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml --name DockerEMHASS <REPOSITORY:TAG>
   ```
     
 - If you wish to set the web_server's homepage optimization diagrams to a timezone other than UTC, set `TZ` environment variable on docker run:
   ```bash
-  docker run -it --restart always -p 5000:5000  -e TZ="Europe/Paris" -v ~/emhass/config.json:/app/config.json -v ~/emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml --name DockerEMHASS <REPOSITORY:TAG>
+  docker run -it --restart always -p 5000:5000  -e TZ="Europe/Paris" -v /emhass/share:/share -v /emhass/secrets_emhass.yaml:/app/secrets_emhass.yaml --name DockerEMHASS <REPOSITORY:TAG>
   ```  
 ### Method 3) Legacy method using a Python virtual environment *(Legacy CLI)*
 If you wish to run EMHASS optimizations with cli commands. *(no persistent web server session)* you can run EMHASS via the python package alone *(not wrapped in a Docker container)*.
@@ -264,12 +258,22 @@ Additional optimization strategies were developed later, that can be used in com
 
 ### Dayahead Optimization - Method 1) Add-on and docker standalone
 
-In `configuration.yaml`:
+We can use the `shell_command` integration in `configuration.yaml`:
 ```yaml
 shell_command:
   dayahead_optim: "curl -i -H \"Content-Type:application/json\" -X POST -d '{}' http://localhost:5000/action/dayahead-optim"
   publish_data: "curl -i -H \"Content-Type:application/json\" -X POST -d '{}' http://localhost:5000/action/publish-data"
 ```
+An alternative that will be useful when passing data at runtime (see dedicated section), we can use the the `rest_command` instead:
+```yaml
+rest_command:
+  url: http://127.0.0.1:5000/action/dayahead-optim
+  method: POST
+  headers:
+    content-type: application/json
+  payload: >-
+    {}
+```
 ### Dayahead Optimization - Method 2) Legacy method using a Python virtual environment
 
 In `configuration.yaml`:
@@ -332,8 +336,8 @@ In `automations.yaml`:
 ```
 in configuration page/`config.json` 
 ```json
-'method_ts_round': "first"
-'continual_publish': true
+"method_ts_round": "first"
+"continual_publish": true
 ```
 In this automation, the day-ahead optimization is performed once a day, every day at 5:30am. 
 If the `optimization_time_step` parameter is set to `30` *(default)* in the configuration, the results of the day-ahead optimization will generate 48 values *(for each entity)*, a value for every 30 minutes in a day *(i.e. 24 hrs x 2)*.
@@ -487,7 +491,7 @@ For users who wish to have full control of exactly when they would like to run a
 
 in configuration page/`config.json` :
 ```json
-'continual_publish': false
+"continual_publish": false
 ```
 POST action :
 ```bash
@@ -611,6 +615,25 @@ curl -i -H 'Content-Type:application/json' -X POST -d '{"pv_power_forecast":[0,
 curl -i -H 'Content-Type:application/json' -X POST -d '{"pv_power_forecast":[0, 70, 141.22, 246.18, 513.5, 753.27, 1049.89, 1797.93, 1697.3, 3078.93], "prediction_horizon":10, "soc_init":0.5,"soc_final":0.6,"operating_hours_of_each_deferrable_load":[1,3],"start_timesteps_of_each_deferrable_load":[0,3],"end_timesteps_of_each_deferrable_load":[0,6]}' http://localhost:5000/action/naive-mpc-optim
 ```
 
+For a more readable option we can use the `rest_command` integration:
+```yaml
+rest_command:
+  url: http://127.0.0.1:5000/action/dayahead-optim
+  method: POST
+  headers:
+    content-type: application/json
+  payload: >-
+    {
+      "pv_power_forecast": [0, 70, 141.22, 246.18, 513.5, 753.27, 1049.89, 1797.93, 1697.3, 3078.93],
+      "prediction_horizon":10,
+      "soc_init":0.5,
+      "soc_final":0.6,
+      "operating_hours_of_each_deferrable_load":[1,3],
+      "start_timesteps_of_each_deferrable_load":[0,3],
+      "end_timesteps_of_each_deferrable_load":[0,6]
+    }
+```
+
 ## A machine learning forecaster
 
 Starting in v0.4.0 a new machine learning forecaster class was introduced.

{emhass-0.13.3 → emhass-0.13.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "emhass"
-version = "0.13.3"
+version = "0.13.4"
 description = "An Energy Management System for Home Assistant"
 readme = "README.md"
 requires-python = ">=3.10, <3.13"

{emhass-0.13.3 → emhass-0.13.4}/src/emhass/command_line.py

@@ -72,7 +72,9 @@ def retrieve_home_assistant_data(
         if optim_conf.get("set_use_pv", True):
             var_list.append(retrieve_hass_conf["sensor_power_photovoltaics"])
             if optim_conf.get("set_use_adjusted_pv", True):
-                var_list.append(retrieve_hass_conf["sensor_power_photovoltaics_forecast"])
+                var_list.append(
+                    retrieve_hass_conf["sensor_power_photovoltaics_forecast"]
+                )
         if not rh.get_data(
             days_list, var_list, minimal_response=False, significant_changes_only=False
         ):
@@ -302,7 +304,8 @@ def set_input_data_dict(
         else:
             P_PV_forecast = pd.Series(0, index=fcst.forecast_dates)
         P_load_forecast = fcst.get_load_forecast(
-            method=optim_conf["load_forecast_method"]
+            days_min_load_forecast=optim_conf["delta_forecast_daily"].days,
+            method=optim_conf["load_forecast_method"],
         )
         if isinstance(P_load_forecast, bool) and not P_load_forecast:
             logger.error(
@@ -400,6 +403,7 @@ def set_input_data_dict(
         else:
             P_PV_forecast = pd.Series(0, index=fcst.forecast_dates)
         P_load_forecast = fcst.get_load_forecast(
+            days_min_load_forecast=optim_conf["delta_forecast_daily"].days,
             method=optim_conf["load_forecast_method"],
             set_mix_forecast=set_mix_forecast,
             df_now=df_input_data,

{emhass-0.13.3 → emhass-0.13.4}/src/emhass/data/associations.csv

@@ -61,6 +61,10 @@ plant_conf,surface_azimuth,surface_azimuth,list_surface_azimuth
 plant_conf,modules_per_string,modules_per_string,list_modules_per_string
 plant_conf,strings_per_inverter,strings_per_inverter,list_strings_per_inverter
 plant_conf,inverter_is_hybrid,inverter_is_hybrid
+plant_conf,inverter_ac_output_max,inverter_ac_output_max
+plant_conf,inverter_ac_input_max,inverter_ac_input_max
+plant_conf,inverter_efficiency_dc_ac,inverter_efficiency_dc_ac
+plant_conf,inverter_efficiency_ac_dc,inverter_efficiency_ac_dc
 plant_conf,compute_curtailment,compute_curtailment
 plant_conf,Pd_max,battery_discharge_power_max
 plant_conf,Pc_max,battery_charge_power_max

{emhass-0.13.3 → emhass-0.13.4}/src/emhass/data/config_defaults.json

@@ -116,6 +116,10 @@
     1
   ],
   "inverter_is_hybrid": false,
+  "inverter_ac_output_max": 1000,
+  "inverter_ac_input_max": 1000,
+  "inverter_efficiency_dc_ac": 1.0,
+  "inverter_efficiency_ac_dc": 1.0,
   "compute_curtailment": false,
   "set_use_battery": false,
   "battery_discharge_power_max": 1000,

{emhass-0.13.3 → emhass-0.13.4}/src/emhass/forecast.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import bz2
 import copy
 import json
@@ -216,8 +214,7 @@ class Forecast:
                     ]
 
     def get_cached_open_meteo_forecast_json(
-        self,
-        max_age: int | None = 30,
+        self, max_age: int | None = 30, forecast_days: int = 3
     ) -> dict:
         r"""
         Get weather forecast json from Open-Meteo and cache it for re-use.
@@ -235,10 +232,30 @@ class Forecast:
             before it is discarded and a new version fetched from Open-Meteo.
             Defaults to 30 minutes.
         :type max_age: int, optional
+        :param forecast_days: The number of days of forecast data required from Open-Meteo.
+            One additional day is always fetched from Open-Meteo so there is an extra data in the cache.
+            Defaults to 2 days (3 days fetched) to match the prior default.
+        :type forecast_days: int, optional
         :return: The json containing the Open-Meteo forecast data
         :rtype: dict
 
         """
+
+        # Ensure at least 3 weather forecast days (and 1 more than requested)
+        if forecast_days is None:
+            self.logger.warning(
+                "Open-Meteo forecast_days is missing so defaulting to 3 days"
+            )
+            forecast_days = 3
+        elif forecast_days < 3:
+            self.logger.warning(
+                "Open-Meteo forecast_days is too low (%s) so defaulting to 3 days",
+                forecast_days,
+            )
+            forecast_days = 3
+        else:
+            forecast_days = forecast_days + 1
+
         json_path = os.path.abspath(
             self.emhass_conf["data_path"] / "cached-open-meteo-forecast.json"
         )
@@ -287,10 +304,13 @@ class Forecast:
                 + "shortwave_radiation_instant,"
                 + "diffuse_radiation_instant,"
                 + "direct_normal_irradiance_instant"
+                + "&forecast_days="
+                + str(forecast_days)
                 + "&timezone="
                 + quote(str(self.time_zone), safe="")
             )
             try:
+                self.logger.debug("Fetching data from Open-Meteo using URL: %s", url)
                 response = get(url, headers=headers)
                 self.logger.debug("Returned HTTP status code: %s", response.status_code)
                 response.raise_for_status()
@@ -349,7 +369,8 @@ class Forecast:
         ):  # The scrapper option is being left here for backward compatibility
             if not os.path.isfile(w_forecast_cache_path):
                 data_raw = self.get_cached_open_meteo_forecast_json(
-                    self.optim_conf["open_meteo_cache_max_age"]
+                    self.optim_conf["open_meteo_cache_max_age"],
+                    self.optim_conf["delta_forecast_daily"].days,
                 )
                 data_15min = pd.DataFrame.from_dict(data_raw["minutely_15"])
                 data_15min["time"] = pd.to_datetime(data_15min["time"])
@@ -671,6 +692,7 @@ class Forecast:
         alpha: float,
         beta: float,
         col: str,
+        ignore_pv_feedback: bool = False,
     ) -> pd.DataFrame:
         """A simple correction method for forecasted data using the current real values of a variable.
 
@@ -684,9 +706,15 @@ class Forecast:
         :type beta: float
         :param col: The column variable name
         :type col: str
+        :param ignore_pv_feedback: If True, bypass mixing and return original forecast (used during curtailment)
+        :type ignore_pv_feedback: bool
         :return: The output DataFrame with the corrected values
         :rtype: pd.DataFrame
         """
+        # If ignoring PV feedback (e.g., during curtailment), return original forecast
+        if ignore_pv_feedback:
+            return df_forecast
+
         first_fcst = alpha * df_forecast.iloc[0] + beta * df_now[col].iloc[-1]
         df_forecast.iloc[0] = int(round(first_fcst))
         return df_forecast
@@ -787,12 +815,14 @@ class Forecast:
                     # Extracting results for AC power
                     P_PV_forecast = mc.results.ac
         if set_mix_forecast:
+            ignore_pv_feedback = self.params["passed_data"].get("ignore_pv_feedback_during_curtailment", False)
             P_PV_forecast = Forecast.get_mix_forecast(
                 df_now,
                 P_PV_forecast,
                 self.params["passed_data"]["alpha"],
                 self.params["passed_data"]["beta"],
                 self.var_PV,
+                ignore_pv_feedback,
             )
         P_PV_forecast[P_PV_forecast < 0] = 0  # replace any negative PV values with zero
         self.logger.debug("get_power_from_weather returning:\n%s", P_PV_forecast)
@@ -1410,14 +1440,22 @@ class Forecast:
             forecast_out.index.name = "ts"
             forecast_out = forecast_out.rename(columns={"load": "yhat"})
         elif method == "naive":  # using a naive approach
-            mask_forecast_out = (
-                df.index > days_list[-1] - self.optim_conf["delta_forecast_daily"]
+            # Old code logic (shifted timestamp problem)
+            # mask_forecast_out = (
+            #     df.index > days_list[-1] - self.optim_conf["delta_forecast_daily"]
+            # )
+            # forecast_out = df.copy().loc[mask_forecast_out]
+            # forecast_out = forecast_out.rename(columns={self.var_load_new: "yhat"})
+            # forecast_out = forecast_out.iloc[0 : len(self.forecast_dates)]
+            # forecast_out.index = self.forecast_dates
+            # New code logic
+            forecast_horizon = len(self.forecast_dates)
+            historical_values = df.iloc[-forecast_horizon:]
+            forecast_out = pd.DataFrame(
+                historical_values.values,
+                index=self.forecast_dates,
+                columns=["yhat"]
             )
-            forecast_out = df.copy().loc[mask_forecast_out]
-            forecast_out = forecast_out.rename(columns={self.var_load_new: "yhat"})
-            # Force forecast_out length to avoid mismatches
-            forecast_out = forecast_out.iloc[0 : len(self.forecast_dates)]
-            forecast_out.index = self.forecast_dates
         elif (
             method == "mlforecaster"
         ):  # using a custom forecast model with machine learning
@@ -1506,12 +1544,14 @@ class Forecast:
             return False
         P_Load_forecast = copy.deepcopy(forecast_out["yhat"])
         if set_mix_forecast:
+            # Load forecasts don't need curtailment protection - always use feedback
             P_Load_forecast = Forecast.get_mix_forecast(
                 df_now,
                 P_Load_forecast,
                 self.params["passed_data"]["alpha"],
                 self.params["passed_data"]["beta"],
                 self.var_load_new,
+                False,  # Never ignore feedback for load forecasts
             )
         self.logger.debug("get_load_forecast returning:\n%s", P_Load_forecast)
         return P_Load_forecast

{emhass-0.13.3 → emhass-0.13.4}/src/emhass/machine_learning_forecaster.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import logging
 import time
 import warnings