emhass 0.11.4__py3-none-any.whl → 0.15.5__py3-none-any.whl

emhass/websocket_client.py

@@ -0,0 +1,224 @@
+import asyncio
+import logging
+import ssl
+import time
+import urllib.parse as urlparse
+from typing import Any
+
+import orjson
+import websockets
+
+logger = logging.getLogger(__name__)
+
+
+class WebSocketError(Exception):
+    pass
+
+
+class AuthenticationError(WebSocketError):
+    pass
+
+
+class ConnectionError(WebSocketError):
+    pass
+
+
+class RequestError(WebSocketError):
+    def __init__(self, code: str, message: str):
+        self.code = code
+        self.message = message
+        super().__init__(f"{code}: {message}")
+
+
+class AsyncWebSocketClient:
+    def __init__(
+        self,
+        hass_url: str,
+        long_lived_token: str,
+        logger: logging.Logger | None = None,
+        ping_interval: int = 30,
+        reconnect_delay: int = 5,
+        max_reconnect_attempts: int = 5,
+    ):
+        self.hass_url = hass_url
+        self.token = long_lived_token.strip()
+        self.logger = logger or logging.getLogger("AsyncWebSocketClient")
+        self.ping_interval = ping_interval
+        self.reconnect_delay = reconnect_delay
+        self.max_reconnect_attempts = max_reconnect_attempts
+
+        self._ws = None
+        self._connected = False
+        self._authenticated = False
+        self._id = 0
+        self._pending: dict[int, asyncio.Future] = {}
+        self._lock = asyncio.Lock()
+        self._ping_task: asyncio.Task | None = None
+        self._recv_task: asyncio.Task | None = None
+        self._reconnects = 0
+
+    @property
+    def websocket_url(self) -> str:
+        # For supervisor API, use the dedicated websocket endpoint
+        if self.hass_url.startswith("http://supervisor/core/api"):
+            return "ws://supervisor/core/websocket"
+        elif self.hass_url.startswith("https://supervisor/core/api"):
+            return "wss://supervisor/core/websocket"
+        else:
+            # Standard Home Assistant instance
+            parsed = urlparse.urlparse(self.hass_url)
+            ws_scheme = "wss" if parsed.scheme == "https" else "ws"
+            return f"{ws_scheme}://{parsed.netloc}/api/websocket"
+
+    @property
+    def connected(self) -> bool:
+        return self._connected and self._authenticated
+
+    def _get_ssl_context(self) -> ssl.SSLContext | None:
+        if self.websocket_url.startswith("wss://"):
+            return True  # Use Python's secure defaults
+        return None
+
+    def _next_id(self) -> int:
+        self._id += 1
+        return self._id
+
+    async def startup(self):
+        """Connect and authenticate."""
+        await self._connect()
+
+    async def shutdown(self):
+        """Cleanly close connection."""
+        async with self._lock:
+            await self._cleanup()
+
+    async def reconnect(self):
+        """Force a reconnect."""
+        async with self._lock:
+            await self._cleanup()
+            await asyncio.sleep(1)
+            try:
+                await asyncio.wait_for(self._connect(), timeout=10.0)
+            except TimeoutError as e:
+                self.logger.error("Reconnection timed out")
+                raise ConnectionError("Reconnection timed out") from e
+            except Exception as e:
+                self.logger.error(f"Reconnection failed: {e}")
+                raise
+
+    async def _connect(self):
+        """Internal connect/authenticate and start background tasks."""
+        ssl_ctx = self._get_ssl_context()
+        self._ws = await websockets.connect(
+            self.websocket_url, ssl=ssl_ctx, ping_interval=None, max_size=None
+        )
+        # Authenticate
+        msg = await asyncio.wait_for(self._ws.recv(), timeout=5.0)
+        data = orjson.loads(msg)
+        if data.get("type") != "auth_required":
+            raise AuthenticationError("No auth_required")
+        auth = orjson.dumps({"type": "auth", "access_token": self.token}).decode()
+        await self._ws.send(auth)
+        resp = orjson.loads(await asyncio.wait_for(self._ws.recv(), timeout=5.0))
+        if resp.get("type") != "auth_ok":
+            raise AuthenticationError("Invalid auth")
+        self._authenticated = True
+        self._connected = True
+        self._recv_task = asyncio.create_task(self._receiver())
+        self._ping_task = asyncio.create_task(self._ping_loop())
+        self._reconnects = 0
+        self.logger.info("Connected and authenticated")
+
+    async def _cleanup(self):
+        """Stop tasks and close ws."""
+        self._connected = False
+        self._authenticated = False
+        if self._ping_task:
+            self._ping_task.cancel()
+        if self._recv_task:
+            self._recv_task.cancel()
+        if self._ws:
+            await self._ws.close()
+            self._ws = None
+        for fut in self._pending.values():
+            if not fut.done():
+                fut.set_exception(ConnectionError("Connection closed"))
+        self._pending.clear()
+
+    async def _ping_loop(self):
+        """Keep alive ping loop."""
+        try:
+            while self.connected:
+                await asyncio.sleep(self.ping_interval)
+                await self._ws.send(orjson.dumps({"id": self._next_id(), "type": "ping"}).decode())
+        except Exception:
+            pass
+
+    async def _receiver(self):
+        """Receive messages and route to pending futures."""
+        try:
+            while self.connected:
+                msg = await self._ws.recv()
+                data = orjson.loads(msg)
+                # route by id
+                mid = data.get("id")
+                if mid and mid in self._pending:
+                    fut = self._pending.pop(mid)
+                    if data.get("type") == "result" and not data.get("success", True):
+                        err = data.get("error", {})
+                        fut.set_exception(RequestError(err.get("code", ""), err.get("message", "")))
+                    else:
+                        fut.set_result(data.get("result", None))
+        except Exception as e:
+            self.logger.error(f"Receiver error: {e}")
+            self._connected = False
+            # Cancel pending futures
+            for fut in self._pending.values():
+                if not fut.done():
+                    fut.set_exception(ConnectionError("Connection lost"))
+            self._pending.clear()
+
+    async def send(self, msg_type: str, **kwargs) -> Any:
+        """Send a command and await response."""
+        async with self._lock:
+            if not self.connected:
+                await self.reconnect()
+            mid = self._next_id()
+            payload = {"id": mid, "type": msg_type, **kwargs}
+            fut = asyncio.get_event_loop().create_future()
+            self._pending[mid] = fut
+            await self._ws.send(orjson.dumps(payload).decode())
+        return await fut
+
+    # Convenience API methods:
+    async def get_config(self) -> dict[str, Any]:
+        return await self.send("get_config")
+
+    async def get_states(self) -> list[dict[str, Any]]:
+        return await self.send("get_states")
+
+    async def get_state(self, entity_id: str) -> dict[str, Any] | None:
+        states = await self.get_states()
+        return next((s for s in states if s["entity_id"] == entity_id), None)
+
+    async def call_service(
+        self, domain: str, service: str, service_data: dict = None, target: dict = None
+    ):
+        return await self.send(
+            "call_service",
+            domain=domain,
+            service=service,
+            service_data=service_data or {},
+            target=target or {},
+        )
+
+    async def get_history(self, **kwargs):
+        return await self.send("history/history_during_period", **kwargs)
+
+    async def get_statistics(self, **kwargs):
+        return await self.send("recorder/statistics_during_period", **kwargs)
+
+    async def ping_time(self) -> float:
+        start = time.perf_counter()
+        await self.send("ping")
+        return (time.perf_counter() - start) * 1000

emhass-0.15.5.dist-info/METADATA

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: emhass
+Version: 0.15.5
+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 TORRES <davidusb@gmail.com>
+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 :: Libraries :: Python Modules
+Requires-Python: <3.13,>=3.10
+Requires-Dist: aiofiles
+Requires-Dist: aiohttp
+Requires-Dist: asyncio
+Requires-Dist: gunicorn>=23.0.0
+Requires-Dist: h5py>=3.12.1
+Requires-Dist: highspy>=1.10.0
+Requires-Dist: influxdb>=5.3.1
+Requires-Dist: jinja2
+Requires-Dist: numpy<2.3.0,>=2.0.0
+Requires-Dist: orjson
+Requires-Dist: pandas>=2.2.0
+Requires-Dist: plotly>=6.0.0
+Requires-Dist: protobuf>=5.29.3
+Requires-Dist: pulp>=2.8.0
+Requires-Dist: pvlib>=0.11.0
+Requires-Dist: pytz>=2024.2
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: quart
+Requires-Dist: scipy>=1.15.0
+Requires-Dist: skforecast<0.20.0,>=0.19.1
+Requires-Dist: tables>=3.10.0
+Requires-Dist: uvicorn>=0.30.0
+Requires-Dist: waitress>=3.0.2
+Requires-Dist: websockets
+Provides-Extra: dev
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: myst-parser; extra == 'docs'
+Requires-Dist: pydata-sphinx-theme; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-design; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: aioresponses; extra == 'test'
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: hatchling; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytz; extra == 'test'
+Requires-Dist: ruff; extra == 'test'
+Requires-Dist: snakeviz; extra == 'test'
+Requires-Dist: tabulate; extra == 'test'
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <br>
+  <img alt="EMHASS" src="https://raw.githubusercontent.com/davidusb-geek/emhass/master/docs/images/logo_docs.png" width="700px">
+  <h1>Energy Management for Home Assistant</h1>
+  <strong></strong>
+</div>
+<br>
+
+<p align="center">
+  <a style="text-decoration:none" href="https://pypi.org/project/emhass/">
+    <img alt="PyPI - Version" src="https://img.shields.io/pypi/v/emhass">
+  </a>
+  <a style="text-decoration:none" href="https://anaconda.org/channels/davidusb/packages/emhass/overview">
+    <img alt="Conda - Version" src="https://img.shields.io/conda/v/davidusb/emhass">
+  </a>
+  <a style="text-decoration:none" href="https://github.com/davidusb-geek/emhass/actions">
+    <img alt="EMHASS GitHub Workflow Status" src="https://github.com/davidusb-geek/emhass/actions/workflows/publish_docker.yaml/badge.svg?event=release">
+  </a>
+  <a style="text-decoration:none" href="https://github.com/davidusb-geek/emhass/blob/master/LICENSE">
+    <img alt="GitHub" src="https://img.shields.io/github/license/davidusb-geek/emhass">
+  </a>
+  <a style="text-decoration:none" href="https://pypi.org/project/emhass/">
+    <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/emhass">
+  </a>
+  <a style="text-decoration:none" href="https://pypi.org/project/emhass/">
+    <img alt="PyPI - Status" src="https://img.shields.io/pypi/status/emhass">
+  </a>
+  <a style="text-decoration:none" href="https://emhass.readthedocs.io/en/latest/">
+    <img alt="Read the Docs" src="https://img.shields.io/readthedocs/emhass">
+  </a>
+    <a hstyle="text-decoration:none" ref="https://codecov.io/github/davidusb-geek/emhass" >
+    <img src="https://codecov.io/github/davidusb-geek/emhass/branch/master/graph/badge.svg?token=BW7KSCHN90"/>
+  </a>
+  <a hstyle="text-decoration:none" ref="https://github.com/davidusb-geek/emhass/actions/workflows/codeql.yml" >
+    <img src="https://github.com/davidusb-geek/emhass/actions/workflows/codeql.yml/badge.svg?branch=master&event=schedule"/>
+  </a>
+  <a style="text-decoration:none" href="https://sonarcloud.io/summary/new_code?id=davidusb-geek_emhass">
+    <img alt="SonarQube security rating" src="https://sonarcloud.io/api/project_badges/measure?project=davidusb-geek_emhass&metric=security_rating">
+  </a>
+  <a style="text-decoration:none" href="https://sonarcloud.io/summary/new_code?id=davidusb-geek_emhass">
+    <img alt="SonarQube security Vulnerabilities" src="https://sonarcloud.io/api/project_badges/measure?project=davidusb-geek_emhass&metric=vulnerabilities">
+  </a>
+  <a style="text-decoration:none" href="https://sonarcloud.io/summary/new_code?id=davidusb-geek_emhass">
+    <img alt="SonarQube reliability" src="https://sonarcloud.io/api/project_badges/measure?project=davidusb-geek_emhass&metric=reliability_rating">
+  </a>
+  <a style="text-decoration:none" href="https://sonarcloud.io/summary/new_code?id=davidusb-geek_emhass">
+    <img alt="SonarQube bugs" src="https://sonarcloud.io/api/project_badges/measure?project=davidusb-geek_emhass&metric=bugs">
+  </a>
+  
+</p>
+
+<div align="center">
+ <a style="text-decoration:none" href="https://emhass.readthedocs.io/en/latest/">
+      <img src="https://raw.githubusercontent.com/davidusb-geek/emhass/master/docs/images/Documentation_button.svg" alt="Documentation">
+  </a>
+   <a style="text-decoration:none" href="https://community.home-assistant.io/t/emhass-an-energy-management-for-home-assistant/338126">
+      <img src="https://raw.githubusercontent.com/davidusb-geek/emhass/master/docs/images/Community_button.svg" alt="Community">
+  </a>
+  <a style="text-decoration:none" href="https://github.com/davidusb-geek/emhass/issues">
+      <img src="https://raw.githubusercontent.com/davidusb-geek/emhass/master/docs/images/Issues_button.svg" alt="Issues">
+  </a>
+  <a style="text-decoration:none" href="https://github.com/davidusb-geek/emhass-add-on">
+     <img src="https://raw.githubusercontent.com/davidusb-geek/emhass/master/docs/images/EMHASS_Add_on_button.svg" alt="EMHASS Add-on">
+  </a>
+</div>
+
+<br>
+<p align="left">
+EMHASS is a Python module designed to optimize your home energy interfacing with Home Assistant.
+</p>
+
+## 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.
+
+The complete documentation for this package is [available here](https://emhass.readthedocs.io/en/latest/).
+
+To get started you can follow our [🚀 Quick Start](/docs/quick_start.md) guide in the documentation.
+
+Here are the guides for:
+- [📦 Installation methods](/docs/installation_methods.md)
+- [📖 Usage](/docs/usage_guide.md)
+- [🤖 Home Assistant Automations](/docs/automations.md)
+
+## Development
+
+Pull requests are very much accepted on this project. For development, you can find some instructions here [Development](/docs/develop.md).
+
+## License
+
+MIT License
+
+Copyright (c) 2021-2025 David HERNANDEZ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

emhass-0.15.5.dist-info/RECORD

@@ -0,0 +1,34 @@
+emhass/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+emhass/command_line.py,sha256=qW-PYDgnm1EYRXFihGwZCMZQOOqMer-L33W9e5hC_n8,92691
+emhass/connection_manager.py,sha256=KDV46UrwSUwN_BhtemBvj3UA7940UaPXhqLuHyzFf8I,3611
+emhass/forecast.py,sha256=Tv-LlmQZhdIz5R8hWiXPc4bAz0RWkmjjhRi5DdHbIwA,83220
+emhass/machine_learning_forecaster.py,sha256=HazCCXOknBQ4y-P2kMubs3q9nycS2CIeY2AcC8RS744,28049
+emhass/machine_learning_regressor.py,sha256=yUQ15kEx7RkSk65KqljSaKJjrBWxFl7QNeoR0MLCqwg,10868
+emhass/optimization.py,sha256=m3fi8f9R4LkPgdjoLO8r-zI4N4gO9_v3zA2Hh-hrRx4,93773
+emhass/retrieve_hass.py,sha256=83j9oB5SD78UeN2N2SPZopjyc9XHn0fmYokShNYgcuM,54637
+emhass/utils.py,sha256=eiKk7M1LoJQUb5v9PPAQOs5QjjuYeCrOhgwSxyAAOs0,100809
+emhass/web_server.py,sha256=QwLNhID23nIyqpY9yduDN43BsVKb_R82HMYGupnMabM,34928
+emhass/websocket_client.py,sha256=FBw892hU_lzs2pi15ym96gIx8gjQ9iQbgeJwzI9AbuU,7830
+emhass/data/associations.csv,sha256=rdtZcT1djB0zTXERnO3yIlPGVw5dMZpBssOzWqdWBwU,5521
+emhass/data/cec_inverters.pbz2,sha256=KEo7IRiZNP_BwTAoj41h4IOX50mlFHAKahINtpQaoKE,189482
+emhass/data/cec_modules.pbz2,sha256=b_2MX_pGsDkIe6oXZdfWGnXFw-IB9pWq2S9SR-uHz20,1885793
+emhass/data/config_defaults.json,sha256=Wt_UZkgc3BaYFyDm1m5N2AvTrx5_lBnh-IjiVZ15w_Y,3846
+emhass/img/emhass_icon.png,sha256=Kyx6hXQ1huJLHAq2CaBfjYXR25H9j99PSWHI0lShkaQ,19030
+emhass/static/advanced.html,sha256=YtLZfvlUNZQwpbrMpA3OIYlc7jDAtd4RNUTijjlhmf8,2466
+emhass/static/basic.html,sha256=ro2WwWgJyoUhqx_nJFzKCEG8FA8863vSHLmrjGYcEgs,677
+emhass/static/configuration_list.html,sha256=ceVFzYnJaVmHQN0sqSNuYpHSfLTekWQc3M2A1aV8a44,1779
+emhass/static/configuration_script.js,sha256=tE-gmfkZbUexi7d9h3b4A-KEwz2RLryIN__3xgjfztQ,33909
+emhass/static/script.js,sha256=rahbdud8jd0MO5DF9dsVtZUzNw8T3aGHZ-aJg0e_TSY,17403
+emhass/static/style.css,sha256=R5P2Mai_wmRJ8aYLtk9n9sKF-_DVngCN-Q7GF5muR-k,19261
+emhass/static/data/param_definitions.json,sha256=IoyO9klhjPY2DRz-SjXi_MatBWPdkCR6uKqjg4o362s,28418
+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/configuration.html,sha256=eieTNS8cn5tcxmFvSe2yRfo6Ad38YfIKi0H0F-c8yjY,2954
+emhass/templates/index.html,sha256=bbaZ8jawK_3qtXKQBFOFHrvDGlJCR7T6NXpO_0rV2tA,3181
+emhass/templates/template.html,sha256=llc1BIXZ-c2Yuwag0diP2Jtvf-dra55_yRZQ3S6qLw4,165
+emhass-0.15.5.dist-info/METADATA,sha256=g12hQGW4rsPWMFWXwYUJkdDCQbyTM3IxTI-dm1WMyOQ,8905
+emhass-0.15.5.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+emhass-0.15.5.dist-info/entry_points.txt,sha256=7gkK0C-EsZAmILX7EHqYnHHpMZ-5_8-wZFG79hJcYmk,57
+emhass-0.15.5.dist-info/licenses/LICENSE,sha256=1X3-S1yvOCBDBeox1aK3dq00m7dA8NDtcPrpKPISzbE,1077
+emhass-0.15.5.dist-info/RECORD,,

{emhass-0.11.4.dist-info → emhass-0.15.5.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

emhass-0.15.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+emhass = emhass.command_line:main_sync