openhems 0.3.2__tar.gz → 0.3.2.2__tar.gz

{openhems-0.3.2 → openhems-0.3.2.2}/MANIFEST.in

@@ -1,11 +1,7 @@
-graft data
-graft lib
-
-include_package_data data
+include pyproject.toml
 
 recursive-include data *.yaml
 recursive-include emhass *
 global-exclude */__pycache__/*
 global-exclude *.pyc
 
-include pyproject.toml

{openhems-0.3.2/src/openhems.egg-info → openhems-0.3.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openhems
-Version: 0.3.2
+Version: 0.3.2.2
 Summary: A sample Home Energy Managment System based on Home-Assistant
 Home-page: https://github.com/abriotde/openhems-sample.git
 Author: OpenHomeSystem

{openhems-0.3.2 → openhems-0.3.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "openhems"
-version = "0.3.2"
+version = "0.3.2.2"
 dynamic = [
 	# "version" # , "description"
 ]
@@ -69,18 +69,9 @@ Homepage = "https://openhomesystem.com"
 Issues = "https://github.com/abriotde/openhems-sample/issues"
 Documentation = "https://openhems.readthedocs.io/en/latest/"
 Repository = "https://github.com/abriotde/openhems-sample.git"
-	
+
 [build-system]
-requires = [
-	'requests', "pandas", "pyyaml", 'packaging', 'astral',
-	'GitPython', 'toml', 'scikit-opt',
-	# For EMHASS
-	'numpy', 'plotly', 'scikit-learn', 'skforecast', 'pvlib', 'beautifulsoup4' , 'protobuf',
-	'pandas', 'scipy', 'h5py', 'pulp',
-	'flit_core >=3.2,<4', "setuptools>=42", "wheel"
-]
-# build-backend = "flit_core.buildapi"
-# build-backend = "openhems.build"
+requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [tool.pytest.ini_options]
@@ -116,10 +107,6 @@ ignore_errors = true
 [tool.coverage.html]
 directory = "coverage_html_report"
 
-
-[tool.setuptools.data-files]
-# "share/openhems" = ["data/*.yaml"]
-
 [tool.setuptools]
 include-package-data = true
 
@@ -140,24 +127,6 @@ openhems = [
 		"emhass/scripts/*.json",
 		"emhass/src/emhass/static/data/*.json",
 		"emhass/src/emhass/data/*.json",
-		"pyproject.toml"
-]
-
-[tool.flit.sdist]
-include = [
-    "LICENSE",
-    "CHANGELOG.md",
-    # Documentation
-    "doc/",
-    # "CODE_OF_CONDUCT.rst",  # used as an include in the Documentation
-    # "EXAMPLES.rst",  # used as an include in the Documentation
-    # Tests
-    "tests/",
-    # "tox.ini",
-    # Utilities
-    "data/",
-    "lib/",
-    # "babel.cfg",
 ]
 
 [dependency-groups]

openhems-0.3.2.2/src/openhems/data/openhems.schema.yaml

@@ -0,0 +1,213 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "OpenHEMS Configuration Schema",
+  "description": "Schéma de validation pour openhems.yaml",
+  "type": "object",
+  "properties": {
+    "api": {
+      "type": "object",
+      "properties": {
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL de l'API Home Assistant (ex: http://...:8123/api)"
+        },
+        "long_lived_token": {
+          "type": "string",
+          "description": "Token d'accès permanent Home Assistant"
+        },
+        "ssl_certificate": {
+          "type": "string",
+          "description": "Chemin ou contenu du certificat SSL (optionnel)"
+        }
+      },
+      "required": ["url", "long_lived_token"],
+      "additionalProperties": false
+    },
+    "localization": {
+      "type": "object",
+      "properties": {
+        "latitude": {
+          "type": "number",
+          "minimum": -90,
+          "maximum": 90,
+          "description": "Latitude en degrés décimaux"
+        },
+        "longitude": {
+          "type": "number",
+          "minimum": -180,
+          "maximum": 180,
+          "description": "Longitude en degrés décimaux"
+        },
+        "altitude": {
+          "type": "integer",
+          "description": "Altitude en mètres (optionnel)"
+        },
+        "timeZone": {
+          "type": "string",
+          "description": "Fuseau horaire (ex: Europe/Paris)"
+        }
+      },
+      "required": ["latitude", "longitude", "timeZone"],
+      "additionalProperties": false
+    },
+    "server": {
+      "type": "object",
+      "properties": {
+        "loglevel": {
+          "type": "string",
+          "enum": ["debug", "info", "warning", "error", "critical"],
+          "default": "info",
+          "description": "Niveau de journalisation"
+        },
+        "loopDelay": {
+          "type": "integer",
+          "minimum": 1,
+          "default": 30,
+          "description": "Délai entre les cycles d'optimisation (secondes)"
+        },
+        "network": {
+          "type": "string",
+          "enum": ["homeassistant", "local", "mqtt"],
+          "default": "homeassistant",
+          "description": "Type d'API réseau utilisée"
+        },
+        "strategies": {
+          "type": "array",
+          "description": "Liste des stratégies actives",
+          "items": {
+            "type": "object",
+            "properties": {
+              "class": {
+                "type": "string",
+                "description": "Nom de la classe de stratégie (ex: offpeak, self_consumption)"
+              },
+              "id": {
+                "type": "string",
+                "description": "Identifiant unique de la stratégie"
+              }
+            },
+            "required": ["class", "id"],
+            "additionalProperties": false
+          }
+        }
+      },
+      "required": ["loopDelay", "network"],
+      "additionalProperties": false
+    },
+    "network": {
+      "type": "object",
+      "properties": {
+        "nodes": {
+          "type": "array",
+          "description": "Liste des nœuds (équipements, sources, charges)",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Identifiant unique du nœud"
+              },
+              "class": {
+                "type": "string",
+                "enum": ["PublicPowerGrid", "switch", "battery", "pv", "heater", "ev"],
+                "description": "Type de nœud"
+              },
+              "strategy": {
+                "type": "string",
+                "description": "Référence à une stratégie (optionnelle)"
+              },
+              "currentPower": {
+                "type": "string",
+                "description": "Entité Home Assistant pour la puissance instantanée"
+              },
+              "maxPower": {
+                "type": "number",
+                "description": "Puissance maximale (W)"
+              },
+              "minPower": {
+                "type": "number",
+                "description": "Puissance minimale (W)"
+              },
+              "powerMargin": {
+                "type": "number",
+                "description": "Marge de puissance (W) – pour le réseau public"
+              },
+              "isOn": {
+                "type": "string",
+                "description": "Entité Home Assistant pour l'état marche/arrêt (pour les commutateurs)"
+              },
+              "constraints": {
+                "type": "object",
+                "properties": {
+                  "minPower": {
+                    "type": "number",
+                    "description": "Puissance minimale admissible (W)"
+                  },
+                  "minPowerDelay": {
+                    "type": "integer",
+                    "description": "Durée minimale de maintien de minPower (secondes)"
+                  }
+                },
+                "additionalProperties": false
+              },
+              "contract": {
+                "type": "object",
+                "description": "Contrat d'électricité (pour PublicPowerGrid)",
+                "properties": {
+                  "class": {
+                    "type": "string",
+                    "enum": ["RTETempo", "Base", "HeuresCreuses"],
+                    "description": "Type de contrat"
+                  },
+                  "color": {
+                    "type": "string",
+                    "description": "Entité HA pour la couleur Tempo (bleu/blanc/rouge)"
+                  },
+                  "nextcolor": {
+                    "type": "string",
+                    "description": "Entité HA pour la couleur du lendemain"
+                  },
+                  "offpeakhoursranges": {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "pattern": "^\\d{1,2}:|h(\\d{1,2})?\\s*-\\s*\\d{1,2}(:|h)(\\d{1,2})?$",
+                      "description": "Plage horaire ex: '22h05 - 6h'"
+                    },
+                    "description": "Plages heures creuses"
+                  }
+                },
+                "required": ["class"],
+                "additionalProperties": false
+              }
+            },
+            "required": ["id", "class", "currentPower", "maxPower"],
+            "allOf": [
+              {
+                "if": {
+                  "properties": { "class": { "const": "PublicPowerGrid" } }
+                },
+                "then": {
+                  "required": ["powerMargin", "contract"]
+                }
+              },
+              {
+                "if": {
+                  "properties": { "class": { "const": "switch" } }
+                },
+                "then": {
+                  "required": ["isOn"]
+                }
+              }
+            ]
+          }
+        }
+      },
+      "required": ["nodes"],
+      "additionalProperties": false
+    }
+  },
+  "required": ["api", "localization", "server", "network"],
+  "additionalProperties": false
+}

{openhems-0.3.2 → openhems-0.3.2.2}/src/openhems/main.py

@@ -10,8 +10,11 @@ import sys
 import logging
 from threading import Thread
 import argparse
+import threading
 import traceback
 from pathlib import Path
+
+from openhems.modules.util.project_configuration import ProjectConfiguration
 openhemsPath = Path(__file__).parents[1]
 sys.path.append(str(openhemsPath))
 # pylint: disable=wrong-import-position
@@ -120,20 +123,37 @@ class OpenHEMSApplication:
 			self.logger.info("OpenHEMS loaded.")
 			network.notify("Start OpenHEMS.")
 
-	def runManagementServer(self):
+	def runManagementServer(self, event:threading.Event=None):
 		"""
 		Run core server (Smart part) without the webserver part. 
 		"""
+
 		if self.server is not None:
+			schedule = self.server.getSchedule()
+			network = self.server.getNetwork()
+		else: # Create a UnixSocketServer even if there is no core server.
+			# In order to allow webserver to start and display error messages / reconfigure server.
+			schedule = {}
+			network = FakeNetwork(ProjectConfiguration())
+		try:
 			socket = UnixSocketServer(
-				self.server.getSchedule(),
-				self.server.getNetwork(),
+				schedule,
+				network,
 				socket_path=self.configurator.get("server.socketpath"),
 				logger=self.logger
 			)
 			socket.start()
+		except Exception as e: # pylint: disable=broad-exception-caught
+			self.logger.error("Error occurred while starting management server: %s", e)
+		if event:
+			event.set()
+
+		if self.server is not None:
 			# server.run() is infinite loop (never give hand back)
-			self.server.run()
+			try:
+				self.server.run()
+			except Exception as e: # pylint: disable=broad-exception-caught
+				self.logger.error("Error occurred while running management server: %s", e)
 		else:
 			self.logger.error(
 				"Core server cannot start because of "
@@ -150,10 +170,13 @@ class OpenHEMSApplication:
 		"""
 		Run wall OpenHEMS Application
 		"""
+		event = threading.Event()
+		t1 = Thread(target=self.runManagementServer, args=[event])
+		t1.start()
+		# Wait UnixSocketServer started (before web server try listen to it)
+		event.wait()
 		t0 = Thread(target=self.runWebServer, args=[])
 		t0.start()
-		t1 = Thread(target=self.runManagementServer, args=[])
-		t1.start()
 		# t.join()
 		# t.run()
 

{openhems-0.3.2 → openhems-0.3.2.2}/src/openhems/modules/util/configuration_manager.py

@@ -182,7 +182,10 @@ class ConfigurationManager():
 		if dictConfig is not None:
 			self._load(dictConfig, init)
 		self._cache = {}
-		self.filepaths.append(yamlConfig)
+		if isinstance(yamlConfig, str):
+			yamlConfig = Path(yamlConfig)
+		absPath = yamlConfig.resolve()
+		self.filepaths.append(absPath)
 		# print(self._conf)
 
 	def add(self, key, value, init=False, prekey=''):

openhems-0.3.2.2/src/openhems/modules/util/project_configuration.py

@@ -0,0 +1,70 @@
+"""
+Usefull to get informations from pyproject.toml
+"""
+
+from pathlib import Path
+import toml # pylint: disable=E0401
+ROOT_DIR = Path(__file__).parents[2]
+# In your openhems/__init__.py
+from importlib.metadata import version, metadata
+
+__version__ = version("openhems")
+# or read other metadata:
+name = metadata("openhems")["Name"]
+class ProjectConfiguration:
+	"""
+	Usefull function to do something like a cast : Convertion of types
+	"""
+
+	def __init__(self, openHemsProjectConfPath=None):
+		# In your openhems/__init__.py
+			self._version = version("openhems")
+			self._conf = metadata("openhems")
+
+	def getVersion(self):
+		"""
+		Return current project version.
+		"""
+		return self._version
+
+	def getMaintainers(self):
+		"""
+		Return current project maintainers.
+		"""
+		print("Project configuration:", self._conf)
+		return self._conf.get('Maintainer', 'Unknown')
+
+	def getUrls(self):
+		"""
+		get projects urls
+		"""
+		url_entries = self._conf.get_all('Project-URL')
+		all_urls = {}
+		for entry in url_entries:
+			label, url = entry.split(", ", 1)
+			all_urls[label] = url
+		return all_urls
+
+	def getConf(self):
+		"""
+		get all configurations
+		"""
+		return self._conf
+
+	def getLicence(self):
+		"""
+		Get Licence
+		"""
+		return "GPL-3.0-or-later"
+
+	def getContact(self):
+		"""
+		Get contact information
+		"""
+		return self._conf.get('Maintainer-email', 'Unknown')
+
+	def getName(self):
+		"""
+		Get project name
+		"""
+		return self._conf['Name']

{openhems-0.3.2 → openhems-0.3.2.2}/src/openhems/modules/web/pages/02_Configuration.py

@@ -19,8 +19,8 @@ from openhems.modules.util.json import json_default
 from openhems.modules.web.web_streamlit import get_logger
 
 # pylint: disable=wrong-import-position
-ROOT_PATH = Path(__file__).parents[5]
-sys.path.append(str(ROOT_PATH / "src"))
+ROOT_PATH = Path(__file__).parents[4]
+sys.path.append(str(ROOT_PATH))
 from openhems.modules.web import OpenhemsHTTPServer
 # from openhems.modules.util import (
 # 	ConfigurationManager, ConfigurationException, CastUtililty, CastException, ProjectConfiguration
@@ -75,7 +75,7 @@ def load_schema():
     """
     Load the schema for OpenHEMS configuration validation.
     """
-    with open(str(ROOT_PATH / "config/openhems.schema.yaml"), "r", encoding="utf-8") as f:
+    with open(str(ROOT_PATH / "openhems/data/openhems.schema.yaml"), "r", encoding="utf-8") as f:
         return yaml.safe_load(f)
 
 def validate_config(config:dict|str, schema=None):
@@ -112,7 +112,7 @@ def snake_case(s):
 
 def save_basic_config(
         basic_config: BasicConfiguration,
-        config_page=ROOT_PATH / "config/openhems.yaml"):
+        config_page=ROOT_PATH / "../config/openhems.yaml"):
     """
     Convert the basic configuration and merge it 
     to OpenHEMS configuration file and then save it.
@@ -483,7 +483,7 @@ def basic_configure_supplier():
     Display the electricity supplier configuration page.
     """
     st.write("**Quel est votre fournisseur d'électricité ?**")
-    contracts = load_config(str(ROOT_PATH / "src/openhems/data/ennergy_supplier.yaml"))
+    contracts = load_config(str(ROOT_PATH / "openhems/data/ennergy_supplier.yaml"))
     suppliers_dict = get_suplliers_dict(contracts)
     contract = st.session_state.config.contract
     supplier_key = basic_configure_supplier_select(suppliers_dict, contract)
@@ -693,6 +693,8 @@ def configure_page():
     configurator_path = st.session_state.configurator_path
     with open(configurator_path, "r", encoding="utf-8") as f1:
         conf = yaml.safe_load(f1)
+        if conf is None:
+            conf = {}
         has_nodes = len(conf.get("network", {}).get("nodes", [])) != 0
         if "config_ui_editor" in st.session_state:
             edition_state = st.session_state.config_ui_editor

{openhems-0.3.2 → openhems-0.3.2.2}/src/openhems/modules/web/pages/04_About.py

@@ -18,7 +18,12 @@ def about_page():
     st.markdown(f"""
     **{conf.getName()}** version {conf.getVersion()}
     Licence : {conf.getLicence()}
-    [Site web]({conf.getUrls()['Homepage']}) | [Documentation]({conf.getUrls()['Documentation']})
+    [Site web]({conf.getUrls().get('Homepage', '#')}) | [Documentation]({conf.getUrls().get('Documentation', '#')})
+    [Source code]({conf.getUrls().get('Repository', '#')}) | [Bug tracker]({conf.getUrls().get('Issues', '#')})
+    Contact : {conf.getContact()}
+
+    N'hésitez pas à contribuer au projet sur [GitHub]({conf.getUrls().get('Source', '#')})
     """)
+    # Merci à tous les contributeurs qui ont participé au développement d'OpenHEMS :
 
 about_page()

{openhems-0.3.2 → openhems-0.3.2.2/src/openhems.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openhems
-Version: 0.3.2
+Version: 0.3.2.2
 Summary: A sample Home Energy Managment System based on Home-Assistant
 Home-page: https://github.com/abriotde/openhems-sample.git
 Author: OpenHomeSystem

{openhems-0.3.2 → openhems-0.3.2.2}/src/openhems.egg-info/SOURCES.txt

@@ -22,6 +22,7 @@ src/openhems.egg-info/top_level.txt
 src/openhems/data/ennergy_supplier.yaml
 src/openhems/data/keys_en.yaml
 src/openhems/data/keys_fr.yaml
+src/openhems/data/openhems.schema.yaml
 src/openhems/data/openhems_default.yaml
 src/openhems/data/openhems_default_docker.yaml
 src/openhems/data/openhems_tooltips_en.yaml

openhems-0.3.2/src/openhems/modules/util/project_configuration.py

@@ -1,52 +0,0 @@
-"""
-Usefull to get informations from pyproject.toml
-"""
-
-from pathlib import Path
-import toml # pylint: disable=E0401
-
-
-class ProjectConfiguration:
-	"""
-	Usefull function to do something like a cast : Convertion of types
-	"""
-
-	def __init__(self, openHemsProjectConfPath=None):
-		if openHemsProjectConfPath is None:
-			# openHemsProjectConfPath = Path(__file__).parents[4] / "pyproject.toml"
-			for path in Path(__file__).parents:
-				openHemsProjectConfPath = path / "pyproject.toml"
-				if openHemsProjectConfPath.is_file():
-					break
-		with openHemsProjectConfPath.open('r', encoding="utf-8") as file:
-			self._conf = toml.loads(file.read())
-
-	def getVersion(self):
-		"""
-		Return current project version.
-		"""
-		return self._conf['project']['version']
-
-	def getMaintainers(self):
-		"""
-		Return current project maintainers.
-		"""
-		return self._conf['project']['maintainers']
-
-	def getUrls(self):
-		"""
-		get projects urls
-		"""
-		return self._conf['project']['urls']
-
-	def getLicence(self):
-		"""
-		Get Licence
-		"""
-		return "GPL-3.0-or-later"
-
-	def getName(self):
-		"""
-		Get project name
-		"""
-		return "OpenHEMS"