juham-automation 0.0.10__tar.gz → 0.0.12__tar.gz

{juham_automation-0.0.10 → juham_automation-0.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: juham-automation
-Version: 0.0.10
+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>
@@ -44,10 +44,9 @@ Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE.rst
-Requires-Dist: masterpiece>=0.1.21
-Requires-Dist: masterpiece_influx>=0.0.2
-Requires-Dist: masterpiece_pahomqtt>=0.0.3
-Requires-Dist: juham_core>=0.0.7
+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

{juham_automation-0.0.10 → juham_automation-0.0.12}/juham_automation/automation/hotwateroptimizer.py

@@ -19,30 +19,24 @@ class HotWaterOptimizer(Juham):
     water radiators. Reads spot prices, electricity forecast and temperatures to minimize electricity bill.
     Additional control over heating is provided by the following attributes
 
-    Attributes:
-        schedule_start_hour (float):  hour heating can start, in local time
-        schedule_stop_hour (float):  hour heating is forced to stop
-        start_hour (float): start_hour (int): ordinal of the first allowed electricity price slot to be consumed
-        num_hours (int): the number of hour slots allowed
-
     Computes UOI - optimization utilization index for each hour, based on the spot price and the solar power forecast.
     Value of 0 means the hour is expensive, value of 1 means the hour is free. The UOI threshold determines the slots
     that are allowed to be consumed.
 
 
     """
-
-    maximum_boiler_temperature = 70
-    minimum_boiler_temperature = 40
+    #: Description of the attribute
+    maximum_boiler_temperature : float = 70
+    minimum_boiler_temperature : float = 40
     energy_balancing_interval: float = 3600
-    radiator_power = 3000  # 3 kW
-    operation_threshold = 5 * 60
-    heating_hours_per_day = 4  # use the four cheapest hours per day
+    radiator_power : float = 3000
+    operation_threshold : float = 5 * 60
+    heating_hours_per_day : float = 4 
     schedule_start_hour: float = 0
     schedule_stop_hour: float = 0
-    timezone = "Europe/Helsinki"
-    expected_average_price = 0.2  # 20 eur per kWh
-    uoi_threshold = 0.8
+    timezone : str = "Europe/Helsinki"
+    expected_average_price : float = 0.2
+    uoi_threshold : float = 0.8
 
     def __init__(
         self,

{juham_automation-0.0.10 → juham_automation-0.0.12}/juham_automation/automation/spothintafi.py

@@ -12,7 +12,7 @@ class SpotHintaFiThread(JuhamCloudThread):
     """Thread running SpotHinta.fi.
 
     Periodically fetches the spot electricity prices and publishes them
-    to  'spot' topic.
+    to 'spot' topic.
     """
 
     _spot_topic: str = ""
@@ -52,25 +52,30 @@ class SpotHintaFiThread(JuhamCloudThread):
 
         spot = []
         for e in data:
-            ts = time.mktime(time.strptime(e["DateTime"], "%Y-%m-%dT%H:%M:%S%z"))
-            hour = datetime.utcfromtimestamp(ts).strftime("%H")
-            total_price: float
-            grid_cost: float
-            if int(hour) < 22 and int(hour) >= 6:
+            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 = e["PriceWithTax"] + grid_cost + self.grid_cost_tax
+
+            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 + self.grid_cost_tax,
+                "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")
+        # self.info(f"Spot electricity prices published for the next {len(spot)} days")
 
 
 class SpotHintaFi(JuhamThread):
@@ -78,6 +83,7 @@ class SpotHintaFi(JuhamThread):
     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
@@ -119,7 +125,7 @@ class SpotHintaFi(JuhamThread):
     @override
     def to_dict(self) -> Dict[str, Any]:
         data: Dict[str, Any] = super().to_dict()
-        data["_spothintafi"] = {
+        data[self._SPOTHINTAFI] = {
             "topic": self.spot_topic,
             "url": self.url,
             "interval": self.update_interval,
@@ -129,6 +135,6 @@ class SpotHintaFi(JuhamThread):
     @override
     def from_dict(self, data: Dict[str, Any]) -> None:
         super().from_dict(data)
-        if "_spothintafi" in data:
-            for key, value in data["_spothintafi"].items():
+        if self._SPOTHINTAFI in data:
+            for key, value in data[self._SPOTHINTAFI].items():
                 setattr(self, key, value)

{juham_automation-0.0.10 → juham_automation-0.0.12}/juham_automation.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: juham-automation
-Version: 0.0.10
+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>
@@ -44,10 +44,9 @@ Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE.rst
-Requires-Dist: masterpiece>=0.1.21
-Requires-Dist: masterpiece_influx>=0.0.2
-Requires-Dist: masterpiece_pahomqtt>=0.0.3
-Requires-Dist: juham_core>=0.0.7
+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

juham_automation-0.0.12/juham_automation.egg-info/SOURCES.txt

@@ -0,0 +1,42 @@
+LICENSE.rst
+MANIFEST.in
+README.rst
+pyproject.toml
+examples/myapp.py
+juham_automation/__init__.py
+juham_automation/japp.py
+juham_automation/py.typed
+juham_automation.egg-info/PKG-INFO
+juham_automation.egg-info/SOURCES.txt
+juham_automation.egg-info/dependency_links.txt
+juham_automation.egg-info/entry_points.txt
+juham_automation.egg-info/requires.txt
+juham_automation.egg-info/top_level.txt
+juham_automation/automation/__init__.py
+juham_automation/automation/energycostcalculator.py
+juham_automation/automation/hotwateroptimizer.py
+juham_automation/automation/powermeter_simulator.py
+juham_automation/automation/spothintafi.py
+juham_automation/automation/watercirculator.py
+juham_automation/ts/__init__.py
+juham_automation/ts/electricityprice_ts.py
+juham_automation/ts/energycostcalculator_ts.py
+juham_automation/ts/forecast_ts.py
+juham_automation/ts/log_ts.py
+juham_automation/ts/power_ts.py
+juham_automation/ts/powermeter_ts.py
+juham_automation/ts/powerplan_ts.py
+tests/__init__.py
+tests/test_japp.py
+tests/automation/__init__.py
+tests/automation/test_energycostcalculator.py
+tests/automation/test_hotwateroptimizer.py
+tests/automation/test_juham.py
+tests/automation/test_spothintafi.py
+tests/ts/__init__.py
+tests/ts/test_energycostcalculator_ts.py
+tests/ts/test_forecast_ts.py
+tests/ts/test_log_ts.py
+tests/ts/test_power_ts.py
+tests/ts/test_powermeter_ts.py
+tests/ts/test_powerplan_ts.py

juham_automation-0.0.12/juham_automation.egg-info/requires.txt

@@ -0,0 +1,9 @@
+masterpiece_influx>=0.1.9
+masterpiece_pahomqtt>=0.1.5
+juham_core>=0.1.1
+requests>=2.31
+pytz>=2024.1
+
+[dev]
+check-manifest
+types-pyz

{juham_automation-0.0.10 → juham_automation-0.0.12}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "juham-automation"
-version = "0.0.10"
+version = "0.0.12"
 description = "Juha's Ultimate Home Automation Masterpiece"
 readme = {file = "README.rst", content-type = "text/markdown"}
 requires-python = ">=3.8"
@@ -27,10 +27,9 @@ classifiers = [
 ]
 
 dependencies = [
-  "masterpiece >= 0.1.21",
-  "masterpiece_influx >= 0.0.2",
-  "masterpiece_pahomqtt >= 0.0.3",
-  "juham_core >= 0.0.7",
+  "masterpiece_influx >= 0.1.9",
+  "masterpiece_pahomqtt >= 0.1.5",
+  "juham_core >= 0.1.1",
   "requests >= 2.31",
   "pytz >= 2024.1",
 ]

juham_automation-0.0.12/tests/automation/test_hotwateroptimizer.py

@@ -0,0 +1,109 @@
+import unittest
+from typing import Any
+from masterpiece import MqttMsg
+from unittest.mock import MagicMock, patch
+from masterpiece.mqtt import MqttMsg
+from juham_automation.automation.hotwateroptimizer import HotWaterOptimizer
+
+
+class SimpleMqttMsg(MqttMsg):
+    def __init__(self, topic: str, payload: Any):
+        self._topic = topic
+        self._payload = payload
+
+    @property
+    def payload(self) -> Any:
+        return self._payload
+
+    @payload.setter
+    def payload(self, value: Any) -> None:
+        self._payload = value
+
+    @property
+    def topic(self) -> str:
+        return self._topic
+
+    @topic.setter
+    def topic(self, value: str) -> None:
+        self._topic = value
+
+
+class TestHotWaterOptimizer(unittest.TestCase):
+    def setUp(self) -> None:
+        self.optimizer = HotWaterOptimizer(
+            name="test_optimizer",
+            temperature_sensor="temp_sensor",
+            start_hour=5,
+            num_hours=3,
+            spot_limit=0.25,
+        )
+
+        # Use patch.object to mock instance methods dynamically
+        self.patcher_subscribe = patch.object(
+            self.optimizer, "subscribe", autospec=True
+        )
+        self.patcher_debug = patch.object(self.optimizer, "debug", autospec=True)
+        self.patcher_info = patch.object(self.optimizer, "info", autospec=True)
+        self.patcher_error = patch.object(self.optimizer, "error", autospec=True)
+        self.patcher_warning = patch.object(self.optimizer, "warning", autospec=True)
+
+        # Start the patches
+        self.mock_subscribe = self.patcher_subscribe.start()
+        self.mock_debug = self.patcher_debug.start()
+        self.mock_info = self.patcher_info.start()
+        self.mock_error = self.patcher_error.start()
+        self.mock_warning = self.patcher_warning.start()
+
+    def tearDown(self) -> None:
+        # Stop the patches to clean up
+        self.patcher_subscribe.stop()
+        self.patcher_debug.stop()
+        self.patcher_info.stop()
+        self.patcher_error.stop()
+        self.patcher_warning.stop()
+
+    def test_initialization(self) -> None:
+        self.assertEqual(self.optimizer.heating_hours_per_day, 3)
+        self.assertEqual(self.optimizer.start_hour, 5)
+        self.assertEqual(self.optimizer.spot_limit, 0.25)
+        self.assertEqual(self.optimizer.current_temperature, 100)
+        self.assertFalse(self.optimizer.relay)
+
+    def test_on_connect(self) -> None:
+        self.optimizer.on_connect(None, None, 0, 0)
+        self.mock_subscribe.assert_any_call(self.optimizer.topic_spot)
+        self.mock_subscribe.assert_any_call(self.optimizer.topic_forecast)
+        self.mock_subscribe.assert_any_call(self.optimizer.topic_temperature)
+        self.mock_subscribe.assert_any_call(self.optimizer.topic_in_powerconsumption)
+        self.mock_subscribe.assert_any_call(self.optimizer.topic_in_net_energy_balance)
+
+    def test_sort_by_rank(self) -> None:
+        test_data = [
+            {"Rank": 2, "Timestamp": 2000},
+            {"Rank": 1, "Timestamp": 3000},
+            {"Rank": 3, "Timestamp": 1000},
+        ]
+        sorted_data = self.optimizer.sort_by_rank(test_data, 1500)
+        self.assertEqual(sorted_data[0]["Rank"], 1)
+        self.assertEqual(sorted_data[1]["Rank"], 2)
+
+    def test_sort_by_power(self) -> None:
+        test_data = [
+            {"solarenergy": 50, "ts": 2000},
+            {"solarenergy": 100, "ts": 3000},
+            {"solarenergy": 10, "ts": 1000},
+        ]
+        sorted_data = self.optimizer.sort_by_power(test_data, 1500)
+        self.assertEqual(sorted_data[0]["solarenergy"], 100)
+        self.assertEqual(sorted_data[1]["solarenergy"], 50)
+
+    def test_on_message_temperature_update(self) -> None:
+        mock_msg = SimpleMqttMsg(
+            topic=self.optimizer.topic_temperature, payload=b'{"temperature": 55}'
+        )
+        self.optimizer.on_message(None, None, mock_msg)
+        self.assertEqual(self.optimizer.current_temperature, 55)
+
+
+if __name__ == "__main__":
+    unittest.main()

juham_automation-0.0.12/tests/automation/test_spothintafi.py

@@ -0,0 +1,67 @@
+import unittest
+from unittest import TestCase, mock
+from unittest.mock import MagicMock, patch
+import json
+from typing import Dict, Any
+from juham_core import JuhamCloudThread
+
+from juham_automation.automation.spothintafi import (
+    SpotHintaFiThread,
+    SpotHintaFi,
+)
+
+
+class TestSpotHintaFiThread(TestCase):
+
+    @patch("juham_automation.automation.spothintafi.Mqtt")
+    def test_make_weburl(self, mock_mqtt) -> None:
+
+        thread = SpotHintaFiThread(mock_mqtt)
+        thread.init("test/topic", "http://test.url", 60)
+
+        # Test make_weburl method
+        self.assertEqual(thread.make_weburl(), "http://test.url")
+
+
+class TestSpotHintaFi(unittest.TestCase):
+
+    def test_to_dict(self) -> None:
+        spot_hinta = SpotHintaFi("spot")
+        spot_hinta.url = "http://test.url"
+        expected_dict = {
+            "_class": "SpotHintaFi",
+            "_version": 0,
+            "_object": {"name": "spot", "payload": None},
+            "_base": {},
+            "_spothintafi": {
+                "topic": "/spot",
+                "url": "http://test.url",
+                "interval": 43200,
+            },
+        }
+
+        actual_dict: Dict[str, Any] = spot_hinta.to_dict()
+        self.assertEqual(actual_dict, expected_dict)
+
+    def test_from_dict(self) -> None:
+        spot_hinta = SpotHintaFi()
+        data = {
+            "_class": "SpotHintaFi",
+            "_object": {"name": "rspothintafi"},
+            "_base": {},
+            "_spothintafi": {
+                "topic": "spot/topic",
+                "url": "http://test.url",
+                "interval": 60,
+            },
+        }
+
+        spot_hinta.from_dict(data)
+
+        self.assertEqual(spot_hinta.spot_topic, "/spot")
+        self.assertEqual(spot_hinta.url, "http://test.url")
+        self.assertEqual(spot_hinta.update_interval, 43200)
+
+
+if __name__ == "__main__":
+    unittest.main()

juham_automation-0.0.10/docs/build/html/.buildinfo

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 7048f60e49aacf57039dd4753bf8844f
-tags: 645f666f9bcd5a90fca523b33c5a78b7

juham_automation-0.0.10/docs/build/html/.buildinfo.bak

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 64f67e183e88374ef9504a7d68e8136b
-tags: 645f666f9bcd5a90fca523b33c5a78b7

juham_automation-0.0.10/docs/build/html/_modules/index.html

@@ -1,148 +0,0 @@
-
-<!DOCTYPE html>
-
-<html lang="en" data-content_root="../">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; juham  documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
-    <link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css?v=4468db6d" />
-    <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
-    <link rel="stylesheet" type="text/css" href="../_static/juham.css?v=7a3aeb84" />
-    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
-    <script src="../_static/doctools.js?v=9a2dae69"></script>
-    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
-    <link rel="index" title="Index" href="../genindex.html" />
-    <link rel="search" title="Search" href="../search.html" />
-<meta charset='utf-8'>
-<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
-<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
-<meta name="apple-mobile-web-app-capable" content="yes">
-<script type="text/javascript" src="../_static/js/jquery-1.12.4.min.js"></script>
-<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
-<script type="text/javascript" src="../_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
-<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
-
-  </head><body>
-
-  <div id="navbar" class="navbar navbar-default navbar-fixed-top">
-    <div class="container">
-      <div class="navbar-header">
-        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
-        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
-          <span class="icon-bar"></span>
-          <span class="icon-bar"></span>
-          <span class="icon-bar"></span>
-        </button>
-        <a class="navbar-brand" href="../index.html">
-          juham</a>
-        <span class="navbar-text navbar-version pull-left"><b></b></span>
-      </div>
-
-        <div class="collapse navbar-collapse nav-collapse">
-          <ul class="nav navbar-nav">
-            
-            
-              <li class="dropdown globaltoc-container">
-  <a role="button"
-     id="dLabelGlobalToc"
-     data-toggle="dropdown"
-     data-target="#"
-     href="../index.html">Site <b class="caret"></b></a>
-  <ul class="dropdown-menu globaltoc"
-      role="menu"
-      aria-labelledby="dLabelGlobalToc"><p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../juham_automation/index.html">juham_automation</a></li>
-</ul>
-</ul>
-</li>
-              
-                <li class="dropdown">
-  <a role="button"
-     id="dLabelLocalToc"
-     data-toggle="dropdown"
-     data-target="#"
-     href="#">Page <b class="caret"></b></a>
-  <ul class="dropdown-menu localtoc"
-      role="menu"
-      aria-labelledby="dLabelLocalToc"></ul>
-</li>
-              
-            
-            
-              
-                
-              
-            
-            
-            
-            
-              <li class="hidden-sm"></li>
-            
-          </ul>
-
-          
-            
-<form class="navbar-form navbar-right" action="../search.html" method="get">
- <div class="form-group">
-  <input type="text" name="q" class="form-control" placeholder="Search" />
- </div>
-  <input type="hidden" name="check_keywords" value="yes" />
-  <input type="hidden" name="area" value="default" />
-</form>
-          
-        </div>
-    </div>
-  </div>
-
-<div class="container">
-  <div class="row">
-      <div class="col-md-3">
-        <div id="sidebar" class="bs-sidenav" role="complementary">
-<form action="../search.html" method="get">
- <div class="form-group">
-  <input type="text" name="q" class="form-control" placeholder="Search" />
- </div>
-  <input type="hidden" name="check_keywords" value="yes" />
-  <input type="hidden" name="area" value="default" />
-</form>
-        </div>
-      </div>
-    <div class="body col-md-9 content" role="main">
-      
-  <h1>All modules for which code is available</h1>
-<ul><li><a href="juham_automation/automation/energycostcalculator.html">juham_automation.automation.energycostcalculator</a></li>
-<li><a href="juham_automation/automation/hotwateroptimizer.html">juham_automation.automation.hotwateroptimizer</a></li>
-<li><a href="juham_automation/automation/powermeter_simulator.html">juham_automation.automation.powermeter_simulator</a></li>
-<li><a href="juham_automation/automation/spothintafi.html">juham_automation.automation.spothintafi</a></li>
-<li><a href="juham_automation/automation/watercirculator.html">juham_automation.automation.watercirculator</a></li>
-<li><a href="juham_automation/japp.html">juham_automation.japp</a></li>
-<li><a href="juham_automation/ts/electricityprice_ts.html">juham_automation.ts.electricityprice_ts</a></li>
-<li><a href="juham_automation/ts/energycostcalculator_ts.html">juham_automation.ts.energycostcalculator_ts</a></li>
-<li><a href="juham_automation/ts/forecast_ts.html">juham_automation.ts.forecast_ts</a></li>
-<li><a href="juham_automation/ts/log_ts.html">juham_automation.ts.log_ts</a></li>
-<li><a href="juham_automation/ts/power_ts.html">juham_automation.ts.power_ts</a></li>
-<li><a href="juham_automation/ts/powermeter_ts.html">juham_automation.ts.powermeter_ts</a></li>
-<li><a href="juham_automation/ts/powerplan_ts.html">juham_automation.ts.powerplan_ts</a></li>
-</ul>
-
-    </div>
-      
-  </div>
-</div>
-<footer class="footer">
-  <div class="container">
-    <p class="pull-right">
-      <a href="#">Back to top</a>
-      
-    </p>
-    <p>
-        &copy; Copyright 2024, juha meskanen.<br/>
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
-    </p>
-  </div>
-</footer>
-  </body>
-</html>