juham-automation 0.0.12__py3-none-any.whl → 0.2.11__py3-none-any.whl

juham_automation/automation/spothintafi.py

@@ -1,140 +0,0 @@
-from datetime import datetime
-import time
-import json
-from typing import Any, Dict, Optional, cast
-from typing_extensions import override
-
-from masterpiece.mqtt import Mqtt, MqttMsg
-from juham_core import JuhamCloudThread, JuhamThread
-
-
-class SpotHintaFiThread(JuhamCloudThread):
-    """Thread running SpotHinta.fi.
-
-    Periodically fetches the spot electricity prices and publishes them
-    to 'spot' topic.
-    """
-
-    _spot_topic: str = ""
-    _url: str = ""
-    _interval: float = 12 * 3600
-    grid_cost_day: float = 0.0314
-    grid_cost_night: float = 0.0132
-    grid_cost_tax: float = 0.028272
-
-    def __init__(self, client: Optional[Mqtt] = None) -> None:
-        super().__init__(client)
-        self._interval = 60
-
-    def init(self, topic: str, url: str, interval: float) -> None:
-        self._spot_topic = topic
-        self._url = url
-        self._interval = interval
-
-    @override
-    def make_weburl(self) -> str:
-        return self._url
-
-    @override
-    def update_interval(self) -> float:
-        return self._interval
-
-    @override
-    def process_data(self, rawdata: Any) -> None:
-        """Publish electricity price message to Juham topic.
-
-        Args:
-            rawdata (dict): electricity prices
-        """
-
-        super().process_data(rawdata)
-        data = rawdata.json()
-
-        spot = []
-        for e in data:
-            dt = datetime.fromisoformat(e["DateTime"])  # Correct timezone handling
-            ts = int(dt.timestamp())  # Ensure integer timestamps like in the test
-
-            hour = dt.strftime("%H")  # Correctly extract hour
-
-            if 6 <= int(hour) < 22:
-                grid_cost = self.grid_cost_day
-            else:
-                grid_cost = self.grid_cost_night
-
-            total_price = round(e["PriceWithTax"] + grid_cost + self.grid_cost_tax, 6)
-            grid_cost_total = round(grid_cost + self.grid_cost_tax, 6)
-
-            h = {
-                "Timestamp": ts,
-                "hour": hour,
-                "Rank": e["Rank"],
-                "PriceWithTax": total_price,
-                "GridCost": grid_cost_total,
-            }
-            spot.append(h)
-
-        self.publish(self._spot_topic, json.dumps(spot), 1, True)
-        # self.info(f"Spot electricity prices published for the next {len(spot)} days")
-
-
-class SpotHintaFi(JuhamThread):
-    """Spot electricity price for reading hourly electricity prices from
-    https://api.spot-hinta.fi site.
-    """
-
-    _SPOTHINTAFI: str = "_spothintafi"
-    worker_thread_id = SpotHintaFiThread.get_class_id()
-    url = "https://api.spot-hinta.fi/TodayAndDayForward"
-    update_interval = 12 * 3600
-
-    def __init__(self, name: str = "rspothintafi") -> None:
-        super().__init__(name)
-        self.active_liter_lpm = -1
-        self.update_ts = None
-        self.spot_topic = self.make_topic_name("spot")
-
-    @override
-    def on_connect(self, client: object, userdata: Any, flags: int, rc: int) -> None:
-        super().on_connect(client, userdata, flags, rc)
-        if rc == 0:
-            self.subscribe(self.spot_topic)
-
-    @override
-    def on_message(self, client: object, userdata: Any, msg: MqttMsg) -> None:
-        if msg.topic == self.spot_topic:
-            em = json.loads(msg.payload.decode())
-            self.on_spot(em)
-        else:
-            super().on_message(client, userdata, msg)
-
-    def on_spot(self, m: dict[Any, Any]) -> None:
-        """Write hourly spot electricity prices to time series database.
-
-        Args:
-            m (dict): holding hourly spot electricity prices
-        """
-        pass
-
-    @override
-    def run(self) -> None:
-        self.worker = cast(SpotHintaFiThread, self.instantiate(self.worker_thread_id))
-        self.worker.init(self.spot_topic, self.url, self.update_interval)
-        super().run()
-
-    @override
-    def to_dict(self) -> Dict[str, Any]:
-        data: Dict[str, Any] = super().to_dict()
-        data[self._SPOTHINTAFI] = {
-            "topic": self.spot_topic,
-            "url": self.url,
-            "interval": self.update_interval,
-        }
-        return data
-
-    @override
-    def from_dict(self, data: Dict[str, Any]) -> None:
-        super().from_dict(data)
-        if self._SPOTHINTAFI in data:
-            for key, value in data[self._SPOTHINTAFI].items():
-                setattr(self, key, value)

juham_automation-0.0.12.dist-info/METADATA

@@ -1,109 +0,0 @@
-Metadata-Version: 2.2
-Name: juham-automation
-Version: 0.0.12
-Summary: Juha's Ultimate Home Automation Masterpiece
-Author-email: J Meskanen <juham.api@gmail.com>
-Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
-License: LICENSE
-        =======
-        
-        Copyright (c) 2024, Juha Meskanen
-        
-        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. **
-        
-        
-Project-URL: Homepage, https://gitlab.com/juham/juham/juham-automation.git
-Project-URL: Bug Reports, https://gitlab.com/juham/juham/juham-automation.git
-Project-URL: Funding, https://meskanen.com
-Project-URL: Say Thanks!, http://meskanen.com
-Project-URL: Source, https://gitlab.com/juham/juham/juham-automation.git
-Keywords: home,automation,juham
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development
-Classifier: License :: Public Domain
-Classifier: Programming Language :: Python :: 3.8
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE.rst
-Requires-Dist: masterpiece_influx>=0.1.9
-Requires-Dist: masterpiece_pahomqtt>=0.1.5
-Requires-Dist: juham_core>=0.1.1
-Requires-Dist: requests>=2.31
-Requires-Dist: pytz>=2024.1
-Provides-Extra: dev
-Requires-Dist: check-manifest; extra == "dev"
-Requires-Dist: types-pyz; extra == "dev"
-
-Welcome to Juham™ - Juha's Ultimate Home Automation Masterpiece
-================================================================
-
-Project Description
--------------------
-
-This package extends the ``juham_core`` package, providing home automation building blocks that cover most common needs.
-It consists of two main sub-modules:
-
-.. image:: _static/images/juham_automation.png
-   :alt: Basic automation classes for optimizing energy consumption and minimizing electricity costs.
-   :width: 640px
-   :align: center  
-
-
-- ``automation``
-
-  * **spothintafi**: Acquires electricity prices in Finland.
-  * **watercirculator**: Automates a water circulator pump based on hot water temperature and motion detection.
-  * **hotwateroptimizer**: Controls hot water radiators based on temperature sensors and electricity price data.
-  * **energycostcalculator**: Monitors power consumption and electricity prices, and computes the energy balance in euros.
-
-
-- ``ts``
-
-  * This folder contains time series recorders that listen for Juham™ topics and store the data in a time series database
-    for later inspection.
-
-
-Project Status
---------------
-
-**Current State**: **Pre-Alpha (Status 2)**
-
-All classes have been tested to some extent, and no known bugs have been reported. However, the code still requires work in
-terms of design and robustness. For instance, electricity prices are currently hard-coded to use euros, but this should be
-configurable to support multiple currencies.
-
-
-Special Thanks
---------------
-
-This project would not have been possible without the generous support of two exceptional individuals: Teppo K. and Mahi.
-
-Teppo K. provided the initial spark for this project by donating a Raspberry Pi, a temperature sensor, and giving an inspiring
-demonstration of his own home automation system—effectively dragging me down the rabbit hole of endless tinkering.
-
-Mahi has been instrumental in translating my half-baked ideas into Python code, offering invaluable support and
-encouragement—while also ensuring that every time I thought I was done, I wasn’t.
-
-Because of these two gentlemen, my already minimal spare time dropped into the negatives as I desperately tried to push the
-system to some semblance of professionalism.
-
-I’m truly grateful to both—really. 😅

juham_automation-0.0.12.dist-info/RECORD

@@ -1,23 +0,0 @@
-juham_automation/__init__.py,sha256=FSk6iuBWwWckbT_brwQNSzOQ8MrzyufVXxDRFZRdRwk,812
-juham_automation/japp.py,sha256=DuxMpoI3u9xP5-HaF1s3xI29PWa05jzBcOR8JNn0M0U,1471
-juham_automation/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-juham_automation/automation/__init__.py,sha256=HV67cq9oXTcoAk5uBbHw3F1vR_saKztsHQxlFizqnHQ,460
-juham_automation/automation/energycostcalculator.py,sha256=R9BjsPw04ZxmpYEnn67zqiQzGFQYVT6bq-S2b3x6trg,10825
-juham_automation/automation/hotwateroptimizer.py,sha256=FNRukp-a4dPiw8TUEiaCzrSfBNzaAO8wyHu4TUu35FU,21833
-juham_automation/automation/powermeter_simulator.py,sha256=3WZcjByRTdqnC77l7LjP-TEjmZ8XBEO4hClYsrjxmBE,4549
-juham_automation/automation/spothintafi.py,sha256=cZbi7w2fVweHX_fh1r5MTjGdesX9wDQta2mfVjtiwvw,4331
-juham_automation/automation/watercirculator.py,sha256=a8meMNaONbHcIH3y0vP0UulJc1-gZiLZpw7H8kAOreY,6410
-juham_automation/ts/__init__.py,sha256=SinjhBcaRVP5FUyCMFWJGR3P7ZetL7ya8-VqhRb2skg,525
-juham_automation/ts/electricityprice_ts.py,sha256=BYs120V4teVjSqPc8PpPDjOTc5dOrVM9Maqse7E8cvk,1684
-juham_automation/ts/energycostcalculator_ts.py,sha256=MbeYEGlziVgq4zI40Tk71zxeDPeKafEG3s0LqDRiz0g,1277
-juham_automation/ts/forecast_ts.py,sha256=Gk46hIlS8ijxs-zyy8fBvXrhI7J-8e5Gt2QEe6gFB6s,3158
-juham_automation/ts/log_ts.py,sha256=XsNaazuPmRUZLUqxU0DZae_frtT6kAFcXJTc598CtOA,1750
-juham_automation/ts/power_ts.py,sha256=e7bSeZjitY4C_gLup9L0NjvU_WnQsl3ayDhVShj32KY,1399
-juham_automation/ts/powermeter_ts.py,sha256=wkCROQj9kXHgDdMuIbbAjhgP5Pr6TA6eT2T-r9sHidw,2351
-juham_automation/ts/powerplan_ts.py,sha256=LZeE7TnzPCDaugggKlaV-K48lDwwnC1ZNum50JYAWaY,1482
-juham_automation-0.0.12.dist-info/LICENSE.rst,sha256=QVHD5V5_HSys2PdPdig_xKggDj8cGX33ALKqRsYyjtI,1089
-juham_automation-0.0.12.dist-info/METADATA,sha256=N8gB9QmKA57s9T5J6J2fNNGJFlipzIVwbCXyt_aCGRQ,4747
-juham_automation-0.0.12.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-juham_automation-0.0.12.dist-info/entry_points.txt,sha256=di8tXChhP8B_98bQ44u-1zkOha2kZCoJpCAXxTgoSw8,491
-juham_automation-0.0.12.dist-info/top_level.txt,sha256=jfohvtocvX_gfT21AhJk7Iay5ZiQsS3HzrDjF7S4Qp0,17
-juham_automation-0.0.12.dist-info/RECORD,,