emhass 0.8.0__py3-none-any.whl → 0.8.2__py3-none-any.whl

{emhass-0.8.0.dist-info → emhass-0.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: emhass
-Version: 0.8.0
+Version: 0.8.2
 Summary: An Energy Management System for Home Assistant
 Home-page: https://github.com/davidusb-geek/emhass
 Author: David HERNANDEZ
@@ -16,8 +16,8 @@ Requires-Python: >=3.9, <3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: wheel
-Requires-Dist: numpy <=1.26
-Requires-Dist: scipy <=1.11.3
+Requires-Dist: numpy ==1.26.4
+Requires-Dist: scipy ==1.12.0
 Requires-Dist: pandas <=2.0.3
 Requires-Dist: pvlib >=0.10.2
 Requires-Dist: protobuf >=3.0.0
@@ -132,38 +132,44 @@ These architectures are supported: `amd64`, `armv7`, `armhf` and `aarch64`.
 ### Method 2) Using Docker in standalone mode
 
 You can also install EMHASS using docker. This can be in the same machine as Home Assistant (if using the supervised install method) or in a different distant machine. To install first pull the latest image from docker hub:
-```
+```bash
 docker pull davidusb/emhass-docker-standalone
 ```
 
 You can also build your image locally. For this clone this repository, setup your `config_emhass.yaml` file and use the provided make file with this command:
-```
+```bash
 make -f deploy_docker.mk clean_deploy
 ```
 Then load the image in the .tar file:
-```
+```bash
 docker load -i <TarFileName>.tar
 ```
 Finally check your image tag with `docker images` and launch the docker itself:
-```
+```bash
 docker run -it --restart always -p 5000:5000 -e "LOCAL_COSTFUN=profit" -v $(pwd)/config_emhass.yaml:/app/config_emhass.yaml -v $(pwd)/secrets_emhass.yaml:/app/secrets_emhass.yaml --name DockerEMHASS <REPOSITORY:TAG>
 ```
+  - If you wish to keep a local, persistent copy of the EMHASS generated data, create a local folder on your device, then mount said folder inside the container.  
+    ```bash
+    mkdir -p $(pwd)/data #linux: create data folder on local device
+
+    docker run -it --restart always -p 5000:5000 -e "LOCAL_COSTFUN=profit" -v $(pwd)/config_emhass.yaml:/app/config_emhass.yaml -v $(pwd)/data:/app/data  -v $(pwd)/secrets_emhass.yaml:/app/secrets_emhass.yaml --name DockerEMHASS <REPOSITORY:TAG>
+    ```
 
 ### Method 3) Legacy method using a Python virtual environment
 
 With this method it is recommended to install on a virtual environment.
 For this you will need `virtualenv`, install it using:
-```
+```bash
 sudo apt install python3-virtualenv
 ```
 Then create and activate the virtual environment:
-```
+```bash
 virtualenv -p /usr/bin/python3 emhassenv
 cd emhassenv
 source bin/activate
 ```
 Install using the distribution files:
-```
+```bash
 python3 -m pip install emhass
 ```
 Clone this repository to obtain the example configuration files.
@@ -174,7 +180,7 @@ We will suppose that this repository is cloned to:
 This will be the root path containing the yaml configuration files (`config_emhass.yaml` and `secrets_emhass.yaml`) and the different needed folders (a `data` folder to store the optimizations results and a `scripts` folder containing the bash scripts described further below).
 
 To upgrade the installation in the future just use:
-```
+```bash
 python3 -m pip install --upgrade emhass
 ```
 
@@ -210,7 +216,7 @@ The available arguments are:
 - `--version`: Show the current version of EMHASS.
 
 For example, the following line command can be used to perform a day-ahead optimization task:
-```
+```bash
 emhass --action 'dayahead-optim' --config '/home/user/emhass/config_emhass.yaml' --costfun 'profit'
 ```
 Before running any valuable command you need to modify the `config_emhass.yaml` and `secrets_emhass.yaml` files. These files should contain the information adapted to your own system. To do this take a look at the special section for this in the [documentation](https://emhass.readthedocs.io/en/latest/config.html).
@@ -224,7 +230,7 @@ Then additional optimization strategies were developed, that can be used in comb
 ### Dayahead Optimization - Method 1) Add-on and docker standalone
 
 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"
@@ -232,25 +238,25 @@ shell_command:
 ### Dayahead Optimization - Method 2) Legacy method using a Python virtual environment
 
 In `configuration.yaml`:
-```
+```yaml
 shell_command:
   dayahead_optim: /home/user/emhass/scripts/dayahead_optim.sh
   publish_data: /home/user/emhass/scripts/publish_data.sh
 ```
 Create the file `dayahead_optim.sh` with the following content:
-```
+```bash
 #!/bin/bash
 . /home/user/emhassenv/bin/activate
 emhass --action 'dayahead-optim' --config '/home/user/emhass/config_emhass.yaml'
 ```
 And the file `publish_data.sh` with the following content:
-```
+```bash
 #!/bin/bash
 . /home/user/emhassenv/bin/activate
 emhass --action 'publish-data' --config '/home/user/emhass/config_emhass.yaml'
 ```
 Then specify user rights and make the files executables:
-```
+```bash
 sudo chmod -R 755 /home/user/emhass/scripts/dayahead_optim.sh
 sudo chmod -R 755 /home/user/emhass/scripts/publish_data.sh
 sudo chmod +x /home/user/emhass/scripts/dayahead_optim.sh
@@ -259,7 +265,7 @@ sudo chmod +x /home/user/emhass/scripts/publish_data.sh
 ### Common for any installation method
 
 In `automations.yaml`:
-```
+```yaml
 - alias: EMHASS day-ahead optimization
   trigger:
     platform: time
@@ -276,7 +282,7 @@ In `automations.yaml`:
 In these automations the day-ahead optimization is performed everyday at 5:30am and the data is published every 5 minutes.
 
 The final action will be to link a sensor value in Home Assistant to control the switch of a desired controllable load. For example imagine that I want to control my water heater and that the `publish-data` action is publishing the optimized value of a deferrable load that I want to be linked to my water heater desired behavior. In this case we could use an automation like this one below to control the desired real switch:
-```
+```yaml
 automation:
 - alias: Water Heater Optimized ON
   trigger:
@@ -291,7 +297,7 @@ automation:
       entity_id: switch.water_heater_switch
 ```
 A second automation should be used to turn off the switch:
-```
+```yaml
 automation:
 - alias: Water Heater Optimized OFF
   trigger:
@@ -313,7 +319,7 @@ The `publish-data` command will push to Home Assistant the optimization results
 The `publish-data` command will also publish PV and load forecast data on sensors `p_pv_forecast` and `p_load_forecast`. If using a battery, then the battery optimized power and the SOC will be published on sensors `p_batt_forecast` and `soc_batt_forecast`. On these sensors the future values are passed as nested attributes.
 
 It is possible to provide custm sensor names for all the data exported by the `publish-data` command. For this, when using the `publish-data` endpoint just add some runtime parameters as dictionaries like this:
-```
+```yaml
 shell_command:
   publish_data: "curl -i -H \"Content-Type:application/json\" -X POST -d '{\"custom_load_forecast_id\": {\"entity_id\": \"sensor.p_load_forecast\", \"unit_of_measurement\": \"W\", \"friendly_name\": \"Load Power Forecast\"}}' http://localhost:5000/action/publish-data"
 ```
@@ -321,7 +327,7 @@ shell_command:
 These keys are available to modify: `custom_pv_forecast_id`, `custom_load_forecast_id`, `custom_batt_forecast_id`, `custom_batt_soc_forecast_id`,  `custom_grid_forecast_id`, `custom_cost_fun_id`, `custom_deferrable_forecast_id`, `custom_unit_load_cost_id` and `custom_unit_prod_price_id`.
 
 If you provide the `custom_deferrable_forecast_id` then the passed data should be a list of dictionaries, like this:
-```
+```yaml
 shell_command:
   publish_data: "curl -i -H \"Content-Type:application/json\" -X POST -d '{\"custom_deferrable_forecast_id\": [{\"entity_id\": \"sensor.p_deferrable0\",\"unit_of_measurement\": \"W\", \"friendly_name\": \"Deferrable Load 0\"},{\"entity_id\": \"sensor.p_deferrable1\",\"unit_of_measurement\": \"W\", \"friendly_name\": \"Deferrable Load 1\"}]}' http://localhost:5000/action/publish-data"
 ```
@@ -371,11 +377,11 @@ The valid values to pass for both forecast data and MPC related data are explain
 It is possible to provide EMHASS with your own forecast data. For this just add the data as list of values to a data dictionary during the call to `emhass` using the `runtimeparams` option. 
 
 For example if using the add-on or the standalone docker installation you can pass this data as list of values to the data dictionary during the `curl` POST:
-```
+```bash
 curl -i -H 'Content-Type:application/json' -X POST -d '{"pv_power_forecast":[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 70, 141.22, 246.18, 513.5, 753.27, 1049.89, 1797.93, 1697.3, 3078.93, 1164.33, 1046.68, 1559.1, 2091.26, 1556.76, 1166.73, 1516.63, 1391.13, 1720.13, 820.75, 804.41, 251.63, 79.25, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]}' http://localhost:5000/action/dayahead-optim
 ```
 Or if using the legacy method using a Python virtual environment:
-```
+```bash
 emhass --action 'dayahead-optim' --config '/home/user/emhass/config_emhass.yaml' --runtimeparams '{"pv_power_forecast":[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 70, 141.22, 246.18, 513.5, 753.27, 1049.89, 1797.93, 1697.3, 3078.93, 1164.33, 1046.68, 1559.1, 2091.26, 1556.76, 1166.73, 1516.63, 1391.13, 1720.13, 820.75, 804.41, 251.63, 79.25, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]}'
 ```
 
@@ -448,10 +454,16 @@ When applying this controller, the following `runtimeparams` should be defined:
 
 A correct call for a MPC optimization should look like:
 
+```bash
+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}' http://192.168.3.159:5000/action/naive-mpc-optim
 ```
-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,"def_total_hours":[1,3],"def_start_timestep":[0,3],"def_end_timestep":[0,6],}' http://localhost:5000/action/naive-mpc-optim
+*Example with :`def_total_hours`, `def_start_timestep`, `def_end_timestep`.*
+```bash
+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,"def_total_hours":[1,3],"def_start_timestep":[0,3],"def_end_timestep":[0,6]}' http://localhost:5000/action/naive-mpc-optim
 ```
 
+
+
 ## A machine learning forecaster
 
 Starting in v0.4.0 a new machine learning forecaster class was introduced.

emhass-0.8.2.dist-info/RECORD

@@ -0,0 +1,23 @@
+emhass/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+emhass/command_line.py,sha256=f8u1gNo5NhXF1dYMTFPDc3En34yH0sW4lFu3dqTJNf0,37424
+emhass/forecast.py,sha256=2_Dm03_XyEVPYnKnJzA5TABYgt3tCe9_zRDGOOfFtEM,43555
+emhass/machine_learning_forecaster.py,sha256=8Rm0-pltsjIYqLv01zCeO_Ij_n2HKC62dv_kCno7UsU,15640
+emhass/optimization.py,sha256=M9BlbJ4f38APoIsHKLY_pfKszVWA61cPv_QnmtazkRA,37181
+emhass/retrieve_hass.py,sha256=0v-CRFvhJgtT27AlDh0QL8f3PlZYNNMfw1fxGVwobg4,18356
+emhass/utils.py,sha256=Slme0gYyXE9LwWO-8yOALZua7civhdhCoiv0h89ivdA,46114
+emhass/web_server.py,sha256=u5UEAI4EsrZg35_M2pctwPMOK2SPblBZX8l0zjLWp5A,21300
+emhass/static/advanced.html,sha256=AsT3lMD0AjvAqzAYvUPmslyOYk2C3LA-VfoSB2PwnYA,1747
+emhass/static/basic.html,sha256=hJ4EgCXVNHL5nMQWkIHWjsTm_bJb0N_ZN4zFUjhxEzU,608
+emhass/static/script.js,sha256=k3srZCNWLAduZzHzEjSyS2qttjKXpiI1WAh8CrJpQKY,17512
+emhass/static/style.css,sha256=2sGD6OF33tx3-sAoZQvDvVcF67RkGNf3Xi0PMoRB34A,14952
+emhass/static/img/emhass_icon.png,sha256=Kyx6hXQ1huJLHAq2CaBfjYXR25H9j99PSWHI0lShkaQ,19030
+emhass/static/img/emhass_logo_short.svg,sha256=yzMcqtBRCV8rH84-MwnigZh45_f9Eoqwho9P8nCodJA,66736
+emhass/static/img/feather-sprite.svg,sha256=VHjMJQg88wXa9CaeYrKGhNtyK0xdd47zCqwSIa-hxo8,60319
+emhass/templates/index.html,sha256=OwmgZW8a4Powuzz9KOL-F3XAwSK5i0oi8RF4vJ8ptnQ,2652
+emhass/templates/template.html,sha256=MXQsd1a1UcrwBUXEly7bq0jlS7Yj4kzvrLYEtjKhwtQ,237
+emhass-0.8.2.dist-info/LICENSE,sha256=1X3-S1yvOCBDBeox1aK3dq00m7dA8NDtcPrpKPISzbE,1077
+emhass-0.8.2.dist-info/METADATA,sha256=5CAGAS2Gb9Im0iuxfh_QMaVNyA44faS4gq43nify0PQ,34393
+emhass-0.8.2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+emhass-0.8.2.dist-info/entry_points.txt,sha256=6Bp1NFOGNv_fSTxYl1ke3K3h3aqAcBxI-bgq5yq-i1M,52
+emhass-0.8.2.dist-info/top_level.txt,sha256=L7fIX4awfmxQbAePtSdVg2e6x_HhghfReHfsKSpKr9I,7
+emhass-0.8.2.dist-info/RECORD,,

emhass-0.8.0.dist-info/RECORD

@@ -1,19 +0,0 @@
-emhass/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-emhass/command_line.py,sha256=f8u1gNo5NhXF1dYMTFPDc3En34yH0sW4lFu3dqTJNf0,37424
-emhass/forecast.py,sha256=5g-UIzYZAr91KRhjUaUeat1zkhluTIeqaMLmKCRtGkI,43428
-emhass/machine_learning_forecaster.py,sha256=8Rm0-pltsjIYqLv01zCeO_Ij_n2HKC62dv_kCno7UsU,15640
-emhass/optimization.py,sha256=7CM5_oA16ai40RSBk_izwOPxnq-GPyGQDUjTffIp0lI,36887
-emhass/retrieve_hass.py,sha256=i9kPsrIRLsl985wZERGdYbGcB79KV-NQYSmrs-_cZAk,18314
-emhass/utils.py,sha256=Slme0gYyXE9LwWO-8yOALZua7civhdhCoiv0h89ivdA,46114
-emhass/web_server.py,sha256=qGfkjlMr5UDD-UsuWpTPiJG-yyGm8cONsokws5qzB8s,18177
-emhass/static/style.css,sha256=E1whggyNxv7U8nF-KSJMic6ZBuakjkJm_wIEXvaWcFI,13293
-emhass/static/img/emhass_icon.png,sha256=Kyx6hXQ1huJLHAq2CaBfjYXR25H9j99PSWHI0lShkaQ,19030
-emhass/static/img/emhass_logo_short.svg,sha256=yzMcqtBRCV8rH84-MwnigZh45_f9Eoqwho9P8nCodJA,66736
-emhass/templates/index.html,sha256=1TNIX34_Z92RGBan-8M_dF5ptO4b-D9V40KCpjdJzgc,17939
-emhass/templates/template.html,sha256=TkGgMecQEbFUZA4ymPwMUzNjKHsENvCgroUWbPt7G4Y,158
-emhass-0.8.0.dist-info/LICENSE,sha256=1X3-S1yvOCBDBeox1aK3dq00m7dA8NDtcPrpKPISzbE,1077
-emhass-0.8.0.dist-info/METADATA,sha256=-06Yn_Uyb32Etf0U375lePGY9h3VQUiUiLfjPVSezuo,33456
-emhass-0.8.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-emhass-0.8.0.dist-info/entry_points.txt,sha256=6Bp1NFOGNv_fSTxYl1ke3K3h3aqAcBxI-bgq5yq-i1M,52
-emhass-0.8.0.dist-info/top_level.txt,sha256=L7fIX4awfmxQbAePtSdVg2e6x_HhghfReHfsKSpKr9I,7
-emhass-0.8.0.dist-info/RECORD,,