emhass 0.12.8__tar.gz → 0.13.1__tar.gz

{emhass-0.12.8 → emhass-0.13.1}/.gitignore

@@ -14,6 +14,7 @@ secrets_emhass.yaml
 .devcontainer/devcontainer.json
 *.pkl
 **/app
+.cache.sqlite
 
 
 # Byte-compiled / optimized / DLL files
@@ -46,6 +47,8 @@ MANIFEST
 
 # Local session data 
 data/actionLogs.txt
+data/debug-*.csv
+data/cached-open-meteo-forecast.json
 data/entities/*.json
 
 # PyInstaller
@@ -161,3 +164,4 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+docs/EMHASS_presentation.pdf

{emhass-0.12.8 → emhass-0.13.1}/PKG-INFO

@@ -1,20 +1,26 @@
 Metadata-Version: 2.4
 Name: emhass
-Version: 0.12.8
+Version: 0.13.1
 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
+Project-URL: Issues, https://github.com/davidusb-geek/emhass/issues
+Project-URL: Documentation, https://emhass.readthedocs.io/en/latest/
+Project-URL: Community, https://community.home-assistant.io/t/emhass-an-energy-management-for-home-assistant
 Author-email: David HERNANDEZ <davidusb@gmail.com>
-License-Expression: MIT
+License: MIT
 License-File: LICENSE
 Keywords: energy,hass,management,optimization
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: <3.13,>=3.10
-Requires-Dist: beautifulsoup4>=4.12.3
 Requires-Dist: flask>=3.1.0
 Requires-Dist: gunicorn>=23.0.0
 Requires-Dist: h5py>=3.12.1
@@ -31,6 +37,8 @@ Requires-Dist: scipy>=1.15.0
 Requires-Dist: skforecast>=0.14.0
 Requires-Dist: tables>=3.10.0
 Requires-Dist: waitress>=3.0.2
+Provides-Extra: dev
+Requires-Dist: ruff; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: myst-parser; extra == 'docs'
 Requires-Dist: sphinx; extra == 'docs'

emhass-0.13.1/pyproject.toml

@@ -0,0 +1,104 @@
+[project]
+name = "emhass"
+version = "0.13.1"
+description = "An Energy Management System for Home Assistant"
+readme = "README.md"
+requires-python = ">=3.10, <3.13"
+authors = [
+    { name = "David HERNANDEZ", email = "davidusb@gmail.com" },
+]
+license = { text = "MIT" }
+keywords = ["energy", "management", "optimization", "hass"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "numpy>=2.0.0, <2.3.0",
+    "scipy>=1.15.0",
+    "pandas>=2.2.0",
+    "pvlib>=0.11.0",
+    "protobuf>=5.29.3",
+    "pytz>=2024.2",
+    "requests>=2.32.2",
+    "h5py>=3.12.1",
+    "pulp>=2.8.0",
+    "pyyaml>=6.0.2",
+    "tables>=3.10.0",
+    "skforecast>=0.14.0",
+    "flask>=3.1.0",
+    "waitress>=3.0.2",
+    "plotly>=6.0.0",
+    "gunicorn>=23.0.0",
+]
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[tool.uv.workspace]
+members = ["emhass"]
+
+[tool.uv.sources]
+emhass = { workspace = true }
+
+[tool.uv]
+default-groups = "all"
+package = true
+
+[project.optional-dependencies]
+docs = ["sphinx", "sphinx-rtd-theme", "myst-parser"]
+test = ["requests-mock", "pytest", "coverage", "snakeviz", "ruff", "tabulate", "hatchling"]
+dev = ["ruff"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/emhass"]
+package-data = { "emhass" = [
+    "templates/*",
+    "static/*",
+    "img/*",
+    "data/cec_modules.pbz2",
+    "data/cec_inverters.pbz2",
+    "data/associations.csv",
+    "data/config_defaults.json"]}
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/emhass/templates/",
+    "src/emhass/static/",
+    "src/emhass/img/",
+    "src/emhass/data/cec_modules.pbz2",
+    "src/emhass/data/cec_inverters.pbz2",
+    "src/emhass/data/associations.csv",
+    "src/emhass/data/config_defaults.json",
+]
+
+[project.scripts]
+emhass = "emhass.command_line:main"
+
+[project.urls]
+Homepage = "https://github.com/davidusb-geek/emhass"
+Source = "https://github.com/davidusb-geek/emhass"
+Issues = "https://github.com/davidusb-geek/emhass/issues"
+Documentation = "https://emhass.readthedocs.io/en/latest/"
+Community = "https://community.home-assistant.io/t/emhass-an-energy-management-for-home-assistant" 
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "C", "B", "Q", "UP", "YTT", "PYI"]
+ignore = ["E501", "B008", "B905", "C901"] 
+
+[dependency-groups]
+dev = [
+    "emhass",
+]
+
+[tool.ruff]
+target-version = "py311" 
+src = ["src", "tests"]

{emhass-0.12.8 → emhass-0.13.1}/src/emhass/data/associations.csv

@@ -2,6 +2,7 @@ config_categorie,legacy_parameter_name,parameter,list_name
 retrieve_hass_conf,freq,optimization_time_step
 retrieve_hass_conf,days_to_retrieve,historic_days_to_retrieve
 retrieve_hass_conf,var_PV,sensor_power_photovoltaics
+retrieve_hass_conf,var_PV_forecast,sensor_power_photovoltaics_forecast
 retrieve_hass_conf,var_load,sensor_power_load_no_var_loads
 retrieve_hass_conf,load_negative,load_negative
 retrieve_hass_conf,set_zero_min,set_zero_min
@@ -16,9 +17,13 @@ params_secrets,alt,Altitude
 optim_conf,costfun,costfun
 optim_conf,logging_level,logging_level
 optim_conf,set_use_pv,set_use_pv
+optim_conf,set_use_adjusted_pv,set_use_adjusted_pv
+optim_conf,adjusted_pv_regression_model,adjusted_pv_regression_model
+optim_conf,adjusted_pv_solar_elevation_threshold,adjusted_pv_solar_elevation_threshold
 optim_conf,set_use_battery,set_use_battery
 optim_conf,num_def_loads,number_of_deferrable_loads
 optim_conf,P_deferrable_nom,nominal_power_of_deferrable_loads,list_nominal_power_of_deferrable_loads
+optim_conf,minimum_power_of_deferrable_loads,minimum_power_of_deferrable_loads
 optim_conf,def_total_hours,operating_hours_of_each_deferrable_load,list_operating_hours_of_each_deferrable_load
 optim_conf,treat_def_as_semi_cont,treat_deferrable_load_as_semi_cont,list_treat_deferrable_load_as_semi_cont
 optim_conf,set_def_constant,set_deferrable_load_single_constant,list_set_deferrable_load_single_constant
@@ -33,6 +38,7 @@ optim_conf,prod_sell_price,photovoltaic_production_sell_price
 optim_conf,set_total_pv_sell,set_total_pv_sell
 optim_conf,lp_solver,lp_solver
 optim_conf,lp_solver_path,lp_solver_path
+optim_conf,lp_solver_timeout,lp_solver_timeout
 optim_conf,set_nocharge_from_grid,set_nocharge_from_grid
 optim_conf,set_nodischarge_to_grid,set_nodischarge_to_grid
 optim_conf,set_battery_dynamic,set_battery_dynamic
@@ -41,6 +47,7 @@ optim_conf,battery_dynamic_min,battery_dynamic_min
 optim_conf,weight_battery_discharge,weight_battery_discharge
 optim_conf,weight_battery_charge,weight_battery_charge
 optim_conf,weather_forecast_method,weather_forecast_method
+optim_conf,open_meteo_cache_max_age,open_meteo_cache_max_age
 optim_conf,def_start_timestep,start_timesteps_of_each_deferrable_load,list_start_timesteps_of_each_deferrable_load
 optim_conf,def_end_timestep,end_timesteps_of_each_deferrable_load,list_end_timesteps_of_each_deferrable_load
 optim_conf,list_hp_periods,load_peak_hour_periods

{emhass-0.12.8 → emhass-0.13.1}/src/emhass/data/config_defaults.json

@@ -2,24 +2,27 @@
   "logging_level": "INFO",
   "costfun": "profit",
   "optimization_time_step": 30,
-  "historic_days_to_retrieve": 2,
+  "historic_days_to_retrieve": 9,
   "method_ts_round": "nearest",
   "continual_publish": false,
   "data_path": "default",
   "set_total_pv_sell": false,
   "lp_solver": "default",
   "lp_solver_path": "empty",
+  "lp_solver_timeout": 45,
   "set_nocharge_from_grid": false,
   "set_nodischarge_to_grid": true,
   "set_battery_dynamic": false,
   "battery_dynamic_max": 0.9,
   "battery_dynamic_min": -0.9,
-  "weight_battery_discharge": 1.0,
-  "weight_battery_charge": 1.0,
+  "weight_battery_discharge": 0.0,
+  "weight_battery_charge": 0.0,
   "sensor_power_photovoltaics": "sensor.power_photovoltaics",
+  "sensor_power_photovoltaics_forecast": "sensor.p_pv_forecast",
   "sensor_power_load_no_var_loads": "sensor.power_load_no_var_loads",
   "sensor_replace_zero": [
-    "sensor.power_photovoltaics" 
+    "sensor.power_photovoltaics",
+    "sensor.p_pv_forecast"
   ],
   "sensor_linear_interp": [
     "sensor.power_photovoltaics",
@@ -32,11 +35,16 @@
     3000.0,
     750.0
   ],
+  "minimum_power_of_deferrable_loads": [
+    0.0,
+    0.0
+  ],
   "operating_hours_of_each_deferrable_load": [
     4,
     0
   ],
   "weather_forecast_method": "open-meteo",
+  "open_meteo_cache_max_age": 30,
   "load_forecast_method": "naive",
   "delta_forecast_daily": 1,
   "load_cost_forecast_method": "hp_hc_periods",
@@ -85,6 +93,9 @@
   "maximum_power_from_grid": 9000,
   "maximum_power_to_grid": 9000,
   "set_use_pv": false,
+  "set_use_adjusted_pv": false,
+  "adjusted_pv_regression_model": "LassoRegression",
+  "adjusted_pv_solar_elevation_threshold": 10,
   "pv_module_model": [
     "CSUN_Eurasia_Energy_Systems_Industry_and_Trade_CSUN295_60M"
   ],
@@ -114,4 +125,4 @@
   "battery_minimum_state_of_charge": 0.3,
   "battery_maximum_state_of_charge": 0.9,
   "battery_target_state_of_charge": 0.6
-}
+}

{emhass-0.12.8 → emhass-0.13.1}/src/emhass/static/data/param_definitions.json

@@ -12,11 +12,17 @@
       "default_value": "profit"
     },
     "sensor_power_photovoltaics": {
-      "friendly_name": "Sensor power sensor",
+      "friendly_name": "Sensor power photovoltaic",
       "Description": "This is the name of the photovoltaic power-produced sensor in Watts from Home Assistant. For example: ‘sensor.power_photovoltaics’.",
       "input": "string",
       "default_value": "sensor.power_photovoltaics"
     },
+    "sensor_power_photovoltaics_forecast": {
+      "friendly_name": "Sensor power photovoltaic forecast",
+      "Description": "This is the name of the photovoltaic forecast sensor in Watts from Home Assistant. For example: ‘sensor.p_pv_forecast’.",
+      "input": "string",
+      "default_value": "sensor.p_pv_forecast"
+    },
     "sensor_power_load_no_var_loads": {
       "friendly_name": "Sensor power loads with no variable loads",
       "Description": "The name of the household power consumption sensor in Watts from Home Assistant. The deferrable loads that we will want to include in the optimization problem should be subtracted from this sensor in HASS. For example: ‘sensor.power_load_no_var_loads’",
@@ -132,6 +138,12 @@
       "input": "text",
       "default_value": "/usr/bin/cbc"
     },
+    "lp_solver_timeout": {
+      "friendly_name": "Linear programming solver timeout",
+      "Description": "Set the maximum time (in seconds) for the LP solver. Defaults to 45.",
+      "input": "int",
+      "default_value": 45
+    },
     "weather_forecast_method": {
       "friendly_name": "Weather forecast method",
       "Description": "This will define the weather forecast method that will be used. options are 'open-meteo', 'Solcast', 'solar.forecast' (forecast.solar) and 'csv' to load a CSV file. When loading a CSV file this will be directly considered as the PV power forecast in Watts.",
@@ -144,6 +156,12 @@
       ],
       "default_value": "open-meteo"
     },
+    "open_meteo_cache_max_age": {
+      "friendly_name": "Open-Meteo Cache Max Age",
+      "Description": "The maximum age, in minutes, of the cached open-meteo json response, after which a new version will be fetched from Open-Meteo. Defaults to 30.",
+      "input": "int",
+      "default_value": 30
+    },
     "maximum_power_from_grid": {
       "friendly_name": "Max power from grid",
       "Description": "The maximum power that can be supplied by the utility grid in Watts (consumption). Defaults to 9000.",
@@ -236,6 +254,32 @@
       "input": "boolean",
       "default_value": false
     },
+    "set_use_adjusted_pv": {
+      "friendly_name": "Enable adjusted PV system",
+      "Description": "Set to True if we should consider an adjusted solar PV system. Defaults to False",
+      "input": "boolean",
+      "default_value": false
+    },
+    "adjusted_pv_regression_model": {
+      "friendly_name": "Regression model for adjusted PV",
+      "Description": "Set the type of regression model that will be used to adjust the solr PV production to local conditions. Defaults to LassoRegression",
+      "input": "select",
+      "select_options": [
+        "LinearRegression",
+        "RidgeRegression",
+        "LassoRegression",
+        "RandomForestRegression",
+        "GradientBoostingRegression",
+        "AdaBoostRegression"
+      ],
+      "default_value": "LassoRegression"
+    },
+    "adjusted_pv_solar_elevation_threshold": {
+      "friendly_name": "Solar elevation threshold",
+      "Description": "This is the solar elevation threshold parameter used to identify the early morning or late evening periods. Defaults to 10.",
+      "input": "int",
+      "default_value": 10
+    },
     "pv_module_model": {
       "friendly_name": "PV module model name",
       "Description": "The PV module model. This parameter can be a list of items to enable the simulation of mixed orientation systems.",
@@ -288,6 +332,12 @@
       "input": "array.float",
       "default_value": 3000.0
     },
+    "minimum_power_of_deferrable_loads": {
+      "friendly_name": "Deferrable load minimum power",
+      "Description": "The minimum power for each deferrable load in Watts.",
+      "input": "array.float",
+      "default_value": 0.0
+    },
     "operating_hours_of_each_deferrable_load": {
       "friendly_name": "Deferrable load operating hours",
       "Description": "The total number of hours that each deferrable load should operate",

emhass-0.12.8/pyproject.toml

@@ -1,84 +0,0 @@
-[build-system]
-# These are the assumed default build requirements from pip:
-# https://pip.pypa.io/en/stable/reference/pip/#pep-517-and-518-support
-requires = ["hatchling>=1.27.0"]
-build-backend = "hatchling.build"
-
-[tool.uv.workspace]
-members = ["emhass"]
-
-[tool.hatch.build.targets.wheel]
-packages = ["src/emhass"]
-
-[project]
-name = "emhass"
-version = "0.12.8"
-description = "An Energy Management System for Home Assistant"
-readme = "README.md"
-requires-python = ">=3.10, <3.13"
-authors = [{ name = "David HERNANDEZ", email = "davidusb@gmail.com" }]
-license = "MIT"
-keywords = ["energy", "management", "optimization", "hass"]
-classifiers = [
-    "Development Status :: 5 - Production/Stable",
-    "Intended Audience :: Developers",
-    "Topic :: Software Development :: Build Tools",
-    "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3.12",
-    "Operating System :: OS Independent",
-]
-dependencies = [
-    "numpy>=2.0.0, <2.3.0",
-    "scipy>=1.15.0",
-    "pandas>=2.2.0",
-    "pvlib>=0.11.0",
-    "protobuf>=5.29.3",
-    "pytz>=2024.2",
-    "requests>=2.32.2",
-    "beautifulsoup4>=4.12.3",
-    "h5py>=3.12.1",
-    "pulp>=2.8.0",
-    "pyyaml>=6.0.2",
-    "tables>=3.10.0",
-    "skforecast>=0.14.0",
-    "flask>=3.1.0",
-    "waitress>=3.0.2",
-    "plotly>=6.0.0",
-    "gunicorn>=23.0.0",
-]
-
-[project.optional-dependencies]
-docs = ["sphinx", "sphinx-rtd-theme", "myst-parser"]
-# can add "mypy"
-test = ["requests_mock", "pytest", "coverage", "snakeviz", "ruff", "tabulate", "hatchling"]
-
-[tool.hatch.build.targets.sdist]
-include = [
-    "/src/emhass/templates/index.html",
-    "/src/emhass/templates/template.html",
-    "/src/emhass/templates/configuration.html",
-    "/src/emhass/static/advanced.html",
-    "/src/emhass/static/basic.html",
-    "/src/emhass/static/script.js",
-    "/src/emhass/static/configuration_script.js",
-    "/src/emhass/static/style.css",
-    "/src/emhass/static/configuration_list.html",
-    "/src/emhass/static/img/emhass_icon.png",
-    "/src/emhass/static/img/emhass_logo_short.svg",
-    "/src/emhass/static/img/feather-sprite.svg",
-    "/src/emhass/static/data/param_definitions.json",
-    "/src/emhass/data/cec_modules.pbz2",
-    "/src/emhass/data/cec_inverters.pbz2",
-    "/src/emhass/data/associations.csv",
-    "/src/emhass/data/config_defaults.json"
-]
-
-[project.scripts]
-emhass = "emhass.command_line:main"
-
-[project.urls]
-Homepage = "https://github.com/davidusb-geek/emhass"
-
-#strict is strict
-#[tool.mypy]
-#strict =  true