emhass 0.4.8__py3-none-any.whl → 0.4.10__py3-none-any.whl

emhass/command_line.py

@@ -517,6 +517,20 @@ def publish_data(input_data_dict: dict, logger: logging.Logger,
                                     custom_cost_fun_id["entity_id"], 
                                     custom_cost_fun_id["unit_of_measurement"],
                                     custom_cost_fun_id["friendly_name"])
+    # Publish unit_load_cost
+    custom_unit_load_cost_id = params['passed_data']['custom_unit_load_cost_id']
+    input_data_dict['rh'].post_data(opt_res_latest['unit_load_cost'], idx_closest, 
+                                    custom_unit_load_cost_id["entity_id"], 
+                                    custom_unit_load_cost_id["unit_of_measurement"],
+                                    custom_unit_load_cost_id["friendly_name"])
+    cols_published = cols_published+["unit_load_cost"]
+    # Publish unit_prod_price
+    custom_unit_prod_price_id = params['passed_data']['custom_unit_prod_price_id']
+    input_data_dict['rh'].post_data(opt_res_latest['unit_prod_price'], idx_closest, 
+                                    custom_unit_prod_price_id["entity_id"], 
+                                    custom_unit_prod_price_id["unit_of_measurement"],
+                                    custom_unit_prod_price_id["friendly_name"])
+    cols_published = cols_published+["unit_prod_price"]
     # Create a DF resuming what has been published
     opt_res = opt_res_latest[cols_published].loc[[opt_res_latest.index[idx_closest]]]
     return opt_res

emhass/machine_learning_forecaster.py

@@ -117,7 +117,7 @@ class mlforecaster:
         self.data_exo[self.var_model] = self.data[self.var_model]
         self.data_exo = self.data_exo.interpolate(method='linear', axis=0, limit=None)
         # train/test split
-        self.date_train = self.data_exo.index[-1]-pd.Timedelta('15days')+self.data_exo.index.freq # The last 15 days
+        self.date_train = self.data_exo.index[-1]-pd.Timedelta('5days')+self.data_exo.index.freq # The last 5 days
         self.date_split = self.data_exo.index[-1]-pd.Timedelta(split_date_delta)+self.data_exo.index.freq # The last 48h
         self.data_train = self.data_exo.loc[:self.date_split,:]
         self.data_test  = self.data_exo.loc[self.date_split:,:]

emhass/utils.py

@@ -136,6 +136,8 @@ def treat_runtimeparams(runtimeparams: str, params: str, retrieve_hass_conf: dic
                            'custom_batt_soc_forecast_id': {"entity_id": "sensor.soc_batt_forecast", "unit_of_measurement": "%", "friendly_name": "Battery SOC Forecast"},
                            'custom_grid_forecast_id': {"entity_id": "sensor.p_grid_forecast", "unit_of_measurement": "W", "friendly_name": "Grid Power Forecast"},
                            'custom_cost_fun_id': {"entity_id": "sensor.total_cost_fun_value", "unit_of_measurement": "", "friendly_name": "Total cost function value"},
+                           'custom_unit_load_cost_id': {"entity_id": "sensor.unit_load_cost", "unit_of_measurement": "€/kWh", "friendly_name": "Unit Load Cost"},
+                           'custom_unit_prod_price_id': {"entity_id": "sensor.unit_prod_price", "unit_of_measurement": "€/kWh", "friendly_name": "Unit Prod Price"},
                            'custom_deferrable_forecast_id': custom_deferrable_forecast_id}
     if 'passed_data' in params.keys():
         for key, value in default_passed_dict.items():
@@ -246,7 +248,7 @@ def treat_runtimeparams(runtimeparams: str, params: str, retrieve_hass_conf: dic
             params['passed_data']['prod_price_forecast'] = None
         # Treat passed data for forecast model fit/predict/tune at runtime
         if 'days_to_retrieve' not in runtimeparams.keys():
-            days_to_retrieve = 30
+            days_to_retrieve = 9
         else:
             days_to_retrieve = runtimeparams['days_to_retrieve']
         params['passed_data']['days_to_retrieve'] = days_to_retrieve
@@ -333,6 +335,10 @@ def treat_runtimeparams(runtimeparams: str, params: str, retrieve_hass_conf: dic
             params['passed_data']['custom_grid_forecast_id'] = runtimeparams['custom_grid_forecast_id']
         if 'custom_cost_fun_id' in runtimeparams.keys():
             params['passed_data']['custom_cost_fun_id'] = runtimeparams['custom_cost_fun_id']
+        if 'custom_unit_load_cost_id' in runtimeparams.keys():
+            params['passed_data']['custom_unit_load_cost_id'] = runtimeparams['custom_unit_load_cost_id']
+        if 'custom_unit_prod_price_id' in runtimeparams.keys():
+            params['passed_data']['custom_unit_prod_price_id'] = runtimeparams['custom_unit_prod_price_id']
         if 'custom_deferrable_forecast_id' in runtimeparams.keys():
             params['passed_data']['custom_deferrable_forecast_id'] = runtimeparams['custom_deferrable_forecast_id']
     # Serialize the final params

emhass/web_server.py

@@ -30,16 +30,23 @@ app.logger.addHandler(ch)
 def get_injection_dict(df, plot_size = 1366):
     # Create plots
     cols_p = [i for i in df.columns.to_list() if 'P_' in i]
+    n_colors = len(cols_p)
+    colors = px.colors.sample_colorscale("jet", [n/(n_colors -1) for n in range(n_colors)])
     fig_0 = px.line(df[cols_p], title='Systems powers schedule after optimization results', 
-                    template='presentation', width=plot_size, height=0.5*plot_size, line_shape="hv")
+                    template='presentation', width=plot_size, height=0.5*plot_size, line_shape="hv",
+                    color_discrete_sequence=colors)
     fig_0.update_layout(xaxis_title='Timestamp', yaxis_title='System powers (W)')
     if 'SOC_opt' in df.columns.to_list():
         fig_1 = px.line(df['SOC_opt'], title='Battery state of charge schedule after optimization results', 
-                        template='presentation', width=plot_size, height=0.5*plot_size, line_shape="hv")
+                        template='presentation', width=plot_size, height=0.5*plot_size, line_shape="hv",
+                        color_discrete_sequence=colors)
         fig_1.update_layout(xaxis_title='Timestamp', yaxis_title='Battery SOC (%)')
     cols_cost = [i for i in df.columns.to_list() if 'cost_' in i or 'unit_' in i]
+    n_colors = len(cols_cost)
+    colors = px.colors.sample_colorscale("jet", [n/(n_colors -1) for n in range(n_colors)])
     fig_2 = px.line(df[cols_cost], title='Systems costs obtained from optimization results', 
-                      template='presentation', width=plot_size, height=0.5*plot_size, line_shape="hv")
+                    template='presentation', width=plot_size, height=0.5*plot_size, line_shape="hv",
+                    color_discrete_sequence=colors)
     fig_2.update_layout(xaxis_title='Timestamp', yaxis_title='System costs (currency)')
     # Get full path to image
     image_path_0 = fig_0.to_html(full_html=False, default_width='75%')

{emhass-0.4.8.dist-info → emhass-0.4.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: emhass
-Version: 0.4.8
+Version: 0.4.10
 Summary: An Energy Management System for Home Assistant
 Home-page: https://github.com/davidusb-geek/emhass
 Author: David HERNANDEZ
@@ -67,22 +67,27 @@ EHMASS is a Python module designed to optimize your home energy interfacing with
 
 ## Introduction
 
-This module was conceived as an energy management optimization tool for residential electric power consumption and production systems.
-The main dependencies of this project are PVLib to model power from a PV residential installation and the PuLP Python package to perform the actual optimizations using the Linear Programming approach.
+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.
 
 The complete documentation for this package is [available here](https://emhass.readthedocs.io/en/latest/).
 
-## What is this?
+## What is Energy Management for Home Assistant (EMHASS)?
 
-The goal here is to optimize the energy use of your home in order to maximize a pre-defined cost function, for example: autoconsumption.
+EMHASS and Home Assistant provide a comprehensive energy management solution that can optimize energy usage and reduce costs for households. By integrating these two systems, households can take advantage of advanced energy management features that provide significant cost savings, increased energy efficiency, and greater sustainability.
 
-The main study case is a household where we have solar panels, a grid connection, one or more controllable (deferrable) electrical loads and an energy storage system with batteries. Of course, it is not necessary to have all these equipements to use EMHASS (PV panels, batteries, etc), in the minimal use case you have a controllable/deferrable load and you just want to obtain the optimized daily schedule for your load.
+EMHASS is a powerful energy management tool that generates an optimization plan based on variables such as solar power production, energy usage, and energy costs. The plan provides valuable insights into how energy can be better managed and utilized in the household. Even if households do not have all the necessary equipment, such as solar panels or batteries, EMHASS can still provide a minimal use case solution to optimize energy usage for controllable/deferrable loads.
+
+Home Assistant provides a platform for the automation of household devices based on the optimization plan generated by EMHASS. This includes devices such as batteries, pool pumps, hot water heaters, and electric vehicle (EV) chargers. By automating EV charging and other devices, households can take advantage of off-peak energy rates and optimize their EV charging schedule based on the optimization plan generated by EMHASS.
+
+One of the main benefits of integrating EMHASS and Home Assistant is the ability to customize and tailor the energy management solution to the specific needs and preferences of each household. With EMHASS, households can define their energy management objectives and constraints, such as maximizing self-consumption or minimizing energy costs, and the system will generate an optimization plan accordingly. Home Assistant provides a platform for the automation of devices based on the optimization plan, allowing households to create a fully customized and optimized energy management solution.
+
+Overall, the integration of EMHASS and Home Assistant offers a comprehensive energy management solution that provides significant cost savings, increased energy efficiency, and greater sustainability for households. By leveraging advanced energy management features and automation capabilities, households can achieve their energy management objectives while enjoying the benefits of a more efficient and sustainable energy usage, including optimized EV charging schedules.
 
 The package flow can be graphically represented as follows:
 
 ![](https://raw.githubusercontent.com/davidusb-geek/emhass/master/docs/images/ems_schema.png)
 
-So we have some data entering EMHASS (PV power, load, cost and selling prices forecasts), we have defined an objective function and some contraints (this is simply defined in a configuration file) and we have some controllable/deferrable loads. A call to an EMHASS optimization will yield the deferrable load schedule for future timestamps, the battery optimal power/SOC and the obtained value of the cost function. This information can published as sensors with attributes to Home Assistant and then we use the HA magic to automate our home energy consumption based on the optimization results.
+## Configuration and Installation
 
 The package is meant to be highly configurable with an object oriented modular approach and a main configuration file defined by the user.
 EMHASS was designed to be integrated with Home Assistant, hence it's name. 
@@ -104,8 +109,6 @@ A more detailed workflow is given below:
 
 ![](https://raw.githubusercontent.com/davidusb-geek/emhass/master/docs/images/workflow.png)
 
-## Installation
-
 ### Method 1) The EMHASS add-on for Home Assistant OS and supervised users
 
 For Home Assistant OS and HA Supervised users, I've developed an add-on that will help you use EMHASS. The add-on is more user friendly as the configuration can be modified directly in the add-on options pane and as with the standalone docker it exposes a web ui that can be used to inspect the optimization results and manually trigger a new optimization.
@@ -171,12 +174,15 @@ python3 -m pip install --upgrade emhass
 
 If using the add-on or the standalone docker installation, it exposes a simple webserver on port 5000. You can access it directly using your brower, ex: http://localhost:5000.
 
-With this web server you can perform RESTful POST commands on one ENDPOINT called `action` with four options:
+With this web server you can perform RESTful POST commands on multiple ENDPOINTS with prefix `action/*`:
 
 - A POST call to `action/perfect-optim` to perform a perfect optimization task on the historical data.
 - A POST call to `action/dayahead-optim` to perform a day-ahead optimization task of your home energy.
 - A POST call to `action/naive-mpc-optim` to perform a naive Model Predictive Controller optimization task. If using this option you will need to define the correct `runtimeparams` (see further below).
 - A POST call to `action/publish-data` to publish the optimization results data for the current timestamp.
+- A POST call to `action/forecast-model-fit` to train a machine learning forecaster model with the passed data (see the [dedicated section](https://emhass.readthedocs.io/en/latest/mlforecaster.html) for more help).
+- A POST call to `action/forecast-model-predict` to obtain a forecast from a pre-trained machine learning forecaster model (see the [dedicated section](https://emhass.readthedocs.io/en/latest/mlforecaster.html) for more help).
+- A POST call to `action/forecast-model-tune` to optimize the machine learning forecaster models hyperparameters using bayesian optimization (see the [dedicated section](https://emhass.readthedocs.io/en/latest/mlforecaster.html) for more help).
 
 A `curl` command can then be used to launch an optimization task like this: `curl -i -H 'Content-Type:application/json' -X POST -d '{}' http://localhost:5000/action/dayahead-optim`.
 
@@ -184,12 +190,13 @@ A `curl` command can then be used to launch an optimization task like this: `cur
 
 To run a command simply use the `emhass` CLI command followed by the needed arguments.
 The available arguments are:
-- `--action`: That is used to set the desired action, options are: `perfect-optim`, `dayahead-optim`, `naive-mpc-optim` and `publish-data`
+- `--action`: That is used to set the desired action, options are: `perfect-optim`, `dayahead-optim`, `naive-mpc-optim`, `publish-data`, `forecast-model-fit`, `forecast-model-predict` and `forecast-model-tune`.
 - `--config`: Define path to the config.yaml file (including the yaml file itself)
 - `--costfun`: Define the type of cost function, this is optional and the options are: `profit` (default), `cost`, `self-consumption`
 - `--log2file`: Define if we should log to a file or not, this is optional and the options are: `True` or `False` (default)
 - `--params`: Configuration as JSON. 
 - `--runtimeparams`: Data passed at runtime. This can be used to pass your own forecast data to EMHASS.
+- `--debug`: Use `True` for testing purposes.
 - `--version`: Show the current version of EMHASS.
 
 For example, the following line command can be used to perform a day-ahead optimization task:

emhass-0.4.10.dist-info/RECORD

@@ -0,0 +1,15 @@
+emhass/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+emhass/command_line.py,sha256=QSxkOmmjTEBcBwOo7C4p70_pHPHtpqJmHi7ZmBGgF3M,34580
+emhass/forecast.py,sha256=mJY846P_VWK_Ov-F-SZg_We55Y799a5b8Lwo1bO_JK8,43072
+emhass/machine_learning_forecaster.py,sha256=C0k3bkq0pXRmfwIMigrh0aI2ZRO-qa7WFtDcPoGwFEQ,14964
+emhass/optimization.py,sha256=QL9LpOhhpo_YgmF3_lvXWPGdz-ZeH62_zUCwm2swlyM,30582
+emhass/retrieve_hass.py,sha256=lsLSiWB2XC1TTlAw_GR7YWjVXti4ZXKhICROST8UlTw,15888
+emhass/utils.py,sha256=M1-E0o-X0D1uOrKARRTnvhzosd3pYCkPjbEvumc34Ic,23116
+emhass/web_server.py,sha256=z4oFYG_rzVhhyCd7vOLsJWM2LG8pbdPMJMmJpmwH7JI,18654
+emhass/static/style.css,sha256=5qGJl0MZGSaSvr0HUcGQ9UgMtDKP2CiyE-1H-jbsLuU,6760
+emhass/templates/index.html,sha256=DGP5PayjyDJnZo9LYRrGg0pYIfr-AwwITgKocmUbruU,6615
+emhass-0.4.10.dist-info/METADATA,sha256=tfIyU_0oLp1IYVLI1PjrURM-1NXMkxL96jtdG5uVVH4,27318
+emhass-0.4.10.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+emhass-0.4.10.dist-info/entry_points.txt,sha256=tJULCm7mHGYb_IxyzPN_4KFYvhxv209_jq68jPiByy0,53
+emhass-0.4.10.dist-info/top_level.txt,sha256=L7fIX4awfmxQbAePtSdVg2e6x_HhghfReHfsKSpKr9I,7
+emhass-0.4.10.dist-info/RECORD,,

emhass-0.4.8.dist-info/RECORD

@@ -1,15 +0,0 @@
-emhass/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-emhass/command_line.py,sha256=IbHexJGwDnqDVvRN1V07QXmE5sm1XtO8oHhBjp87Fi4,33594
-emhass/forecast.py,sha256=mJY846P_VWK_Ov-F-SZg_We55Y799a5b8Lwo1bO_JK8,43072
-emhass/machine_learning_forecaster.py,sha256=FaWZv8aMS8ihx1Z6RhY6yuNkbkouZV8CujXAMmcFnAI,14966
-emhass/optimization.py,sha256=QL9LpOhhpo_YgmF3_lvXWPGdz-ZeH62_zUCwm2swlyM,30582
-emhass/retrieve_hass.py,sha256=lsLSiWB2XC1TTlAw_GR7YWjVXti4ZXKhICROST8UlTw,15888
-emhass/utils.py,sha256=_EuITuTur7RwI3_oBRWEmEQk1F_Ke1wZ4pOSp57VRC4,22445
-emhass/web_server.py,sha256=wQT0HD8N86zC2V28L4zVUqVfP6sj0U-ZmltoUc51rXs,18255
-emhass/static/style.css,sha256=5qGJl0MZGSaSvr0HUcGQ9UgMtDKP2CiyE-1H-jbsLuU,6760
-emhass/templates/index.html,sha256=DGP5PayjyDJnZo9LYRrGg0pYIfr-AwwITgKocmUbruU,6615
-emhass-0.4.8.dist-info/METADATA,sha256=ppNVOXjCPNrfU2_zHH4FLCuf7tibxEQUm0jbTeoeYqM,24995
-emhass-0.4.8.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-emhass-0.4.8.dist-info/entry_points.txt,sha256=tJULCm7mHGYb_IxyzPN_4KFYvhxv209_jq68jPiByy0,53
-emhass-0.4.8.dist-info/top_level.txt,sha256=L7fIX4awfmxQbAePtSdVg2e6x_HhghfReHfsKSpKr9I,7
-emhass-0.4.8.dist-info/RECORD,,