juham-automation 0.0.2__py3-none-any.whl

juham_automation/__init__.py

@@ -0,0 +1,37 @@
+"""
+Description
+===========
+
+Juham - Juha's Ultimate Home Automation Masterpiece
+
+"""
+
+from .automation.energycostcalculator import EnergyCostCalculator
+from .ts.energycostcalculator_ts import EnergyCostCalculatorTs
+from .ts.forecast_ts import ForecastTs
+from .ts.log_ts import LogTs
+from .ts.power_ts import PowerTs
+from .ts.powerplan_ts import PowerPlanTs
+from .ts.powermeter_ts import PowerMeterTs
+from .ts.electricityprice_ts import ElectricityPriceTs
+from .automation.spothintafi import SpotHintaFi
+from .automation.watercirculator import WaterCirculator
+from .automation.hotwateroptimizer import HotWaterOptimizer
+from .japp import JApp
+from .automation.powermeter_simulator import PowerMeterSimulator
+
+__all__ = [
+    "EnergyCostCalculator",
+    "EnergyCostCalculatorTs",
+    "ForecastTs",
+    "HotWaterOptimizer",
+    "LogTs",
+    "PowerTs",
+    "PowerPlanTs",
+    "PowerMeterTs",
+    "SpotHintaFi",
+    "WaterCirculator",
+    "JApp",
+    "PowerMeterSimulator",
+    "ElectricityPriceTs",
+]

juham_automation/japp.py

@@ -0,0 +1,55 @@
+from masterpiece import Application
+from juham_core import Juham
+from juham_systemstatus import SystemStatus
+
+from .ts.forecast_ts import ForecastTs
+from .ts.power_ts import PowerTs
+from .ts.powerplan_ts import PowerPlanTs
+from .ts.powermeter_ts import PowerMeterTs
+from .ts.log_ts import LogTs
+from .ts.energycostcalculator_ts import EnergyCostCalculatorTs
+from .ts.electricityprice_ts import ElectricityPriceTs
+from .automation.spothintafi import SpotHintaFi
+from .automation.energycostcalculator import EnergyCostCalculator
+
+
+class JApp(Application):
+    """Juham home automation application base class. Registers new plugin
+    group 'juham' on which general purpose Juham plugins can be written on.
+    """
+
+    def __init__(self, name: str) -> None:
+        """Creates home automation application with the given name.
+        If --enable_plugins is False create hard coded configuration
+        by calling instantiate_classes() method.
+
+        Args:
+            name (str): name for the application
+        """
+        super().__init__(name, Juham(name))
+
+    def instantiate_classes(self) -> None:
+        """Instantiate automation classes .
+
+        Returns:
+            None
+        """
+        self.add(ForecastTs())
+        self.add(PowerTs())
+        self.add(PowerPlanTs())
+        self.add(PowerMeterTs())
+        self.add(LogTs())
+        self.add(SpotHintaFi())
+        self.add(EnergyCostCalculator())
+        self.add(EnergyCostCalculatorTs())
+        self.add(ElectricityPriceTs())
+
+        # install plugins
+        self.add(self.instantiate_plugin_by_name("SystemStatus"))
+        self.add(self.instantiate_plugin_by_name("VisualCrossing"))
+        self.add(self.instantiate_plugin_by_name("OpenWeatherMap"))
+
+    @classmethod
+    def register(cls) -> None:
+        """Register plugin group `juham`."""
+        Application.register_plugin_group("juham")

juham_automation/py.typed

@@ -0,0 +1 @@
+

juham_automation-0.0.2.dist-info/LICENSE.rst

@@ -0,0 +1,25 @@
+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. **
+

juham_automation-0.0.2.dist-info/METADATA

@@ -0,0 +1,103 @@
+Metadata-Version: 2.2
+Name: juham-automation
+Version: 0.0.2
+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>=0.1.19
+Requires-Dist: masterpiece_influx>=0.0.2
+Requires-Dist: masterpiece_pahomqtt>=0.0.3
+Requires-Dist: juham_core>=0.0.4
+Requires-Dist: requests>=2.31
+Requires-Dist: pytz>=2024.1
+Requires-Dist: importlib-metadata
+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:
+
+- ``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.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+juham_automation/__init__.py,sha256=ibC2uN4z7PHdkg-A4wcFrX91jU_PIhMwhcaBsZeFOdk,1035
+juham_automation/japp.py,sha256=HjCPU4mG6MLeZQztxw1e8NkWwg11peWBd27glJPQzYE,1931
+juham_automation/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+juham_automation-0.0.2.dist-info/LICENSE.rst,sha256=D3SSbUrv10lpAZ91lTMCQAke-MXMvrjFDsDyM3vEKJI,1114
+juham_automation-0.0.2.dist-info/METADATA,sha256=RxItoeHCWpunLKgmTCt-1eGj-RFQoZhBoq9kTiMfl3o,4727
+juham_automation-0.0.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+juham_automation-0.0.2.dist-info/entry_points.txt,sha256=7yrw-Tdpm3xqJcxdUI5E5iSfSyd3s5Kj1-hAjB3aoHI,502
+juham_automation-0.0.2.dist-info/top_level.txt,sha256=jfohvtocvX_gfT21AhJk7Iay5ZiQsS3HzrDjF7S4Qp0,17
+juham_automation-0.0.2.dist-info/RECORD,,

juham_automation-0.0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

juham_automation-0.0.2.dist-info/entry_points.txt

@@ -0,0 +1,10 @@
+[juham_automation.plugins]
+electricityprice_plugin = juham_automation:ElectricityPriceTs
+energycostcalculator_plugin = juham_automation:EnergyCostCalculator
+forecast_plugin = juham_automation:ForecastTs
+hotwateroptimizer_plugin = juham_automation:HotWaterOptimizer
+logts_plugin = juham_automation:LogTs
+powerplan_plugin = juham_automation:PowerPlanTs
+powerts_plugin = juham_automation:PowerTs
+rwatercirculator_plugin = juham_automation:WaterCirculator
+spothintafi_plugin = juham_automation:SpotHintaFi

juham_automation-0.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+juham_automation