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

{juham_automation-0.0.12 → juham_automation-0.0.14}/LICENSE.rst

@@ -1,25 +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. **
-
+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.12 → juham_automation-0.0.14}/MANIFEST.in

@@ -1,12 +1,12 @@
-include docs/source/README.rst
-include docs/source/CHANGELOG.rst
-include docs/source/LICENSE.rst
-include docs/source/CONTRIBUTING.rst
-
-recursive-include examples *
-recursive-include tests *
-recursive-include docs/build/html *
-
-# files to be excluded
-global-exclude *~ \#*
-config/*
+include docs/source/README.rst
+include docs/source/CHANGELOG.rst
+include docs/source/LICENSE.rst
+include docs/source/CONTRIBUTING.rst
+
+recursive-include examples *
+recursive-include tests *
+recursive-include docs/build/html *
+
+# files to be excluded
+global-exclude *~ \#*
+config/*

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

@@ -1,109 +1,105 @@
-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. 😅
+Metadata-Version: 2.2
+Name: juham-automation
+Version: 0.0.14
+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: juham_core>=0.1.3
+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 → juham_automation-0.0.14}/README.rst

@@ -1,54 +1,54 @@
-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. 😅
+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.14/docs/source/CHANGELOG.rst

@@ -0,0 +1,27 @@
+Changelog
+=========
+
+[0.1.11] - March 03, 2025
+-------------------------
+
+* Updated for the new modularized ci-templates and docs
+* New unit tests written, for better coverage. Not nearly there yet.
+
+
+[0.1.8-10] - February 23, 2025
+------------------------------
+
+* Support for grid (network) prices and tax added.
+
+* Bug fix in the computation of the utilization optimization index: solar power was previously
+  given in kW, while radiator power was in W, which underestimated the effect of available solar power.
+
+* New attribute added to time series: GridCost (cost and tax per kWh)
+  
+
+
+[0.1.7] - February 08, 2025
+---------------------------
+
+Initial release for GitLab. Pre-alpha!
+

juham_automation-0.0.14/docs/source/CONTRIBUTING.rst

@@ -0,0 +1,44 @@
+Contributing to Juham™ - Juha's Ultimate Home Automation Masterpiece
+====================================================================
+
+Thank You!
+----------
+
+Thank you in advance for your forthcoming contributions, whether they are bug fixes, 
+documentation improvements, entirely new features, or simply feedback. Your efforts 
+will be highly appreciated and will help turn this project from its current mission 
+state into an actual masterpiece.
+
+
+Design Patterns
+---------------
+
+Please read the developer documentation and understand the few design patterns behind Juham™ before contributing. 
+This will help ensure that your contributions align with the project's design and goals.
+.. todo:: (okay, the documentation is currently lacking many essential chapters, add.)
+
+
+Code Formatting
+---------------
+
+To help maintain consistent code formatting across different developers, we use 'black' python formatter, by Microsoft.
+
+Strange, the formatter doesn't seem to format that much, it doesn't organize imports, 
+doesn't adjust docstring lenghts
+.. todo:: most likely I don't know how to use it properly, read the docs.
+
+
+Using Emacs and Makefile
+------------------------
+
+Despite my attempts to fall in love with Eclipse, VSCode and other IDEs, I still find Emacs and Makefile the best
+tools for many workflows. 
+So there is a Makefile in the root folder. For those old dogs who are like me
+::
+    
+    make help
+
+More Stuff
+----------
+.. todo:: TBA
+

juham_automation-0.0.14/docs/source/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.14/docs/source/README.rst

@@ -0,0 +1,54 @@
+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. 😅