juham-automation 0.2.20__tar.gz → 0.2.23__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. {juham_automation-0.2.20/juham_automation.egg-info → juham_automation-0.2.23}/PKG-INFO +1 -1
  2. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/automation/heatingoptimizer.py +29 -16
  3. {juham_automation-0.2.20 → juham_automation-0.2.23/juham_automation.egg-info}/PKG-INFO +1 -1
  4. juham_automation-0.2.23/juham_automation.egg-info/SOURCES.txt +47 -0
  5. {juham_automation-0.2.20 → juham_automation-0.2.23}/pyproject.toml +1 -1
  6. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/automation/test_heatingoptimizer.py +1 -2
  7. juham_automation-0.2.20/docs/source/CHANGELOG.rst +0 -204
  8. juham_automation-0.2.20/docs/source/CONTRIBUTING.rst +0 -44
  9. juham_automation-0.2.20/docs/source/LICENSE.rst +0 -25
  10. juham_automation-0.2.20/docs/source/README.rst +0 -172
  11. juham_automation-0.2.20/juham_automation.egg-info/SOURCES.txt +0 -86
  12. juham_automation-0.2.20/tests/__pycache__/__init__.cpython-312.pyc +0 -0
  13. juham_automation-0.2.20/tests/__pycache__/test_japp.cpython-312-pytest-9.0.1.pyc +0 -0
  14. juham_automation-0.2.20/tests/__pycache__/test_japp.cpython-312.pyc +0 -0
  15. juham_automation-0.2.20/tests/automation/__pycache__/__init__.cpython-312.pyc +0 -0
  16. juham_automation-0.2.20/tests/automation/__pycache__/test_energybalancer.cpython-312-pytest-9.0.1.pyc +0 -0
  17. juham_automation-0.2.20/tests/automation/__pycache__/test_energybalancer.cpython-312.pyc +0 -0
  18. juham_automation-0.2.20/tests/automation/__pycache__/test_energycostcalculator.cpython-312-pytest-9.0.1.pyc +0 -0
  19. juham_automation-0.2.20/tests/automation/__pycache__/test_energycostcalculator.cpython-312.pyc +0 -0
  20. juham_automation-0.2.20/tests/automation/__pycache__/test_heatingoptimizer.cpython-312-pytest-9.0.1.pyc +0 -0
  21. juham_automation-0.2.20/tests/automation/__pycache__/test_heatingoptimizer.cpython-312.pyc +0 -0
  22. juham_automation-0.2.20/tests/automation/__pycache__/test_juham.cpython-312-pytest-9.0.1.pyc +0 -0
  23. juham_automation-0.2.20/tests/automation/__pycache__/test_juham.cpython-312.pyc +0 -0
  24. juham_automation-0.2.20/tests/automation/__pycache__/test_leakdetector.cpython-312-pytest-9.0.1.pyc +0 -0
  25. juham_automation-0.2.20/tests/automation/__pycache__/test_leakdetector.cpython-312.pyc +0 -0
  26. juham_automation-0.2.20/tests/automation/__pycache__/test_spothintafi.cpython-312-pytest-9.0.1.pyc +0 -0
  27. juham_automation-0.2.20/tests/automation/__pycache__/test_spothintafi.cpython-312.pyc +0 -0
  28. juham_automation-0.2.20/tests/automation/__pycache__/test_watercirculator.cpython-312-pytest-9.0.1.pyc +0 -0
  29. juham_automation-0.2.20/tests/automation/__pycache__/test_watercirculator.cpython-312.pyc +0 -0
  30. juham_automation-0.2.20/tests/ts/__pycache__/__init__.cpython-312.pyc +0 -0
  31. juham_automation-0.2.20/tests/ts/__pycache__/test_electricityprice_ts.cpython-312-pytest-9.0.1.pyc +0 -0
  32. juham_automation-0.2.20/tests/ts/__pycache__/test_electricityprice_ts.cpython-312.pyc +0 -0
  33. juham_automation-0.2.20/tests/ts/__pycache__/test_energybalancer_ts.cpython-312-pytest-9.0.1.pyc +0 -0
  34. juham_automation-0.2.20/tests/ts/__pycache__/test_energybalancer_ts.cpython-312.pyc +0 -0
  35. juham_automation-0.2.20/tests/ts/__pycache__/test_energycostcalculator_ts.cpython-312-pytest-9.0.1.pyc +0 -0
  36. juham_automation-0.2.20/tests/ts/__pycache__/test_energycostcalculator_ts.cpython-312.pyc +0 -0
  37. juham_automation-0.2.20/tests/ts/__pycache__/test_forecast_ts.cpython-312-pytest-9.0.1.pyc +0 -0
  38. juham_automation-0.2.20/tests/ts/__pycache__/test_forecast_ts.cpython-312.pyc +0 -0
  39. juham_automation-0.2.20/tests/ts/__pycache__/test_log_ts.cpython-312-pytest-9.0.1.pyc +0 -0
  40. juham_automation-0.2.20/tests/ts/__pycache__/test_log_ts.cpython-312.pyc +0 -0
  41. juham_automation-0.2.20/tests/ts/__pycache__/test_power_ts.cpython-312-pytest-9.0.1.pyc +0 -0
  42. juham_automation-0.2.20/tests/ts/__pycache__/test_power_ts.cpython-312.pyc +0 -0
  43. juham_automation-0.2.20/tests/ts/__pycache__/test_powermeter_ts.cpython-312-pytest-9.0.1.pyc +0 -0
  44. juham_automation-0.2.20/tests/ts/__pycache__/test_powermeter_ts.cpython-312.pyc +0 -0
  45. juham_automation-0.2.20/tests/ts/__pycache__/test_powerplan_ts.cpython-312-pytest-9.0.1.pyc +0 -0
  46. juham_automation-0.2.20/tests/ts/__pycache__/test_powerplan_ts.cpython-312.pyc +0 -0
  47. {juham_automation-0.2.20 → juham_automation-0.2.23}/LICENSE.rst +0 -0
  48. {juham_automation-0.2.20 → juham_automation-0.2.23}/MANIFEST.in +0 -0
  49. {juham_automation-0.2.20 → juham_automation-0.2.23}/README.rst +0 -0
  50. {juham_automation-0.2.20 → juham_automation-0.2.23}/examples/myapp.py +0 -0
  51. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/__init__.py +0 -0
  52. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/automation/__init__.py +0 -0
  53. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/automation/energybalancer.py +0 -0
  54. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/automation/energycostcalculator.py +0 -0
  55. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/automation/leakdetector.py +0 -0
  56. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/automation/watercirculator.py +0 -0
  57. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/japp.py +0 -0
  58. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/py.typed +0 -0
  59. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/ts/__init__.py +0 -0
  60. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/ts/electricityprice_ts.py +0 -0
  61. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/ts/energybalancer_ts.py +0 -0
  62. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/ts/energycostcalculator_ts.py +0 -0
  63. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/ts/forecast_ts.py +0 -0
  64. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/ts/log_ts.py +0 -0
  65. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/ts/power_ts.py +0 -0
  66. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/ts/powermeter_ts.py +0 -0
  67. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation/ts/powerplan_ts.py +0 -0
  68. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation.egg-info/dependency_links.txt +0 -0
  69. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation.egg-info/entry_points.txt +0 -0
  70. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation.egg-info/requires.txt +0 -0
  71. {juham_automation-0.2.20 → juham_automation-0.2.23}/juham_automation.egg-info/top_level.txt +0 -0
  72. {juham_automation-0.2.20 → juham_automation-0.2.23}/setup.cfg +0 -0
  73. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/__init__.py +0 -0
  74. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/automation/__init__.py +0 -0
  75. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/automation/test_energybalancer.py +0 -0
  76. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/automation/test_energycostcalculator.py +0 -0
  77. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/automation/test_juham.py +0 -0
  78. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/automation/test_leakdetector.py +0 -0
  79. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/automation/test_watercirculator.py +0 -0
  80. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/test_japp.py +0 -0
  81. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/ts/__init__.py +0 -0
  82. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/ts/test_electricityprice_ts.py +0 -0
  83. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/ts/test_energybalancer_ts.py +0 -0
  84. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/ts/test_energycostcalculator_ts.py +0 -0
  85. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/ts/test_forecast_ts.py +0 -0
  86. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/ts/test_log_ts.py +0 -0
  87. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/ts/test_power_ts.py +0 -0
  88. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/ts/test_powermeter_ts.py +0 -0
  89. {juham_automation-0.2.20 → juham_automation-0.2.23}/tests/ts/test_powerplan_ts.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: juham-automation
3
- Version: 0.2.20
3
+ Version: 0.2.23
4
4
  Summary: Juha's Ultimate Home Automation Masterpiece
5
5
  Author-email: J Meskanen <juham.api@gmail.com>
6
6
  Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
@@ -44,6 +44,15 @@ class HeatingOptimizer(Juham):
44
44
  radiator_power: float = 6000 # W
45
45
  """Radiator power in Watts. This is the maximum power that the radiator can consume."""
46
46
 
47
+ heating_slots_per_day: float = 4
48
+ """ Number of slots per day the radiator is allowed to heat."""
49
+
50
+ schedule_start_slot: float = 0
51
+ """Start slots of the heating schedule."""
52
+
53
+ schedule_stop_slot: float = 0
54
+ """Stop slot of the heating schedule. Heating is allowed only between start-stop slots."""
55
+
47
56
  timezone: str = "Europe/Helsinki"
48
57
  """ Timezone of the heating system. This is used to convert UTC timestamps to local time."""
49
58
 
@@ -138,7 +147,7 @@ class HeatingOptimizer(Juham):
138
147
  super().__init__(name)
139
148
 
140
149
  self.heating_slots_per_day = num_hours * ( 3600 / self.energy_balancing_interval)
141
- self.schedule_start_slot = start_hour * (3600 / self.energy_balancing_interval)
150
+ self.start_slot = start_hour * (3600 / self.energy_balancing_interval)
142
151
  self.spot_limit = spot_limit
143
152
 
144
153
  self.topic_in_spot = self.make_topic_name("spot")
@@ -455,8 +464,6 @@ class HeatingOptimizer(Juham):
455
464
  """
456
465
  self.spot_prices = m
457
466
  self.ranked_spot_prices = self.sort_by_rank(m, ts_quantized)
458
- # reset the current state of the relay
459
- self.current_relay_state = -1
460
467
 
461
468
  def on_forecast(
462
469
  self, forecast: list[dict[str, Any]], ts_utc_quantized: float
@@ -565,7 +572,11 @@ class HeatingOptimizer(Juham):
565
572
  if not self.heating_plan:
566
573
  self.error(f"{self.name} failed to create heating plan")
567
574
  return
568
- self.info(f"{self.name} heating plan of length {len(self.heating_plan)} created", str(self.heating_plan))
575
+ else:
576
+ self.info(
577
+ f"{self.name} heating plan of length {len(self.heating_plan)} created",
578
+ "",
579
+ )
569
580
 
570
581
  self.publish_heating_plan(self.heating_plan)
571
582
 
@@ -619,7 +630,6 @@ class HeatingOptimizer(Juham):
619
630
 
620
631
  # check if we have excess energy to spent within the current slot
621
632
  if self.net_energy_balance_mode:
622
- self.debug("Energy balancing active, bypass plan")
623
633
  return 1
624
634
 
625
635
  slot : int = self.timestamp_slot(ts)
@@ -634,7 +644,7 @@ class HeatingOptimizer(Juham):
634
644
  break
635
645
 
636
646
  if state == -1:
637
- self.error(f"Cannot find heating plan for slot {slot}, no heating")
647
+ self.error(f"{self.name} cannot find heating plan for slot {slot}")
638
648
  return 0
639
649
 
640
650
  # don't heat if the current temperature is already high enough
@@ -663,13 +673,13 @@ class HeatingOptimizer(Juham):
663
673
  """
664
674
 
665
675
  if not self.is_slot_within_schedule(
666
- slot, self.schedule_start_slot, self.schedule_start_slot + self.heating_slots_per_day
676
+ slot, self.schedule_start_slot, self.schedule_stop_slot
667
677
  ):
668
678
  return 0.0
669
679
 
670
- if price < 0.01:
680
+ if price < 0.0001:
671
681
  return 1.0 # use
672
- elif price > 3*self.expected_average_price:
682
+ elif price > self.expected_average_price:
673
683
  return 0.0 # try not to use
674
684
  else:
675
685
  fom = self.expected_average_price / price
@@ -870,6 +880,8 @@ class HeatingOptimizer(Juham):
870
880
  # factor = 0 -> uses monthly_temp_max (full monthly default capacity)
871
881
  max_temp_today = (factor * T_max_target) + ((1 - factor) * monthly_temp_max)
872
882
 
883
+
884
+
873
885
  # adjust the temperature limits based on the electricity prices
874
886
  ts : float = timestamp()
875
887
  num_hours : float = self.heating_slots_per_day * self.energy_balancing_interval / 3600.0
@@ -889,7 +901,10 @@ class HeatingOptimizer(Juham):
889
901
  self, slot: int, spot: float, fom: float, end_slot: int
890
902
  ) -> bool:
891
903
  return (
892
- slot >= self.schedule_start_slot and slot < end_slot
904
+ slot >= self.start_slot
905
+ and slot < end_slot
906
+ and float(spot) < 3*self.spot_limit
907
+ #and fom > self.uoi_threshold
893
908
  )
894
909
 
895
910
  def create_heating_plan(self) -> list[dict[str, Any]]:
@@ -906,12 +921,12 @@ class HeatingOptimizer(Juham):
906
921
  ts: float = hp["Timestamp"]
907
922
  fom = hp["FOM"]
908
923
  spot = hp["Spot"]
909
- end_slot: int = self.schedule_start_slot + self.heating_slots_per_day
924
+ end_slot: int = self.start_slot + self.heating_slots_per_day
910
925
  slot: int = self.timestamp_slot(ts)
911
926
  schedule_on: bool = self.is_slot_within_schedule(
912
- slot, self.schedule_start_slot, self.schedule_start_slot + self.heating_slots_per_day
927
+ slot, self.schedule_start_slot, self.schedule_stop_slot
913
928
  )
914
-
929
+
915
930
  if self.enable_relay(slot, spot, fom, end_slot) and schedule_on:
916
931
  state = 1
917
932
  else:
@@ -924,12 +939,10 @@ class HeatingOptimizer(Juham):
924
939
  "UOI": fom,
925
940
  "Spot": spot,
926
941
  }
927
- print(f"Slot {slot}, start_slot={self.schedule_start_slot}, end_slot={end_slot}, schedule on {schedule_on} and enable_relay {self.enable_relay(slot, spot, fom, end_slot)}")
928
-
929
942
  heating_plan.append(heat)
930
943
 
931
944
 
932
- self.info(f"{self.name} heating plan of {len(heating_plan)} slots created", str(heating_plan))
945
+ self.info(f"{self.name} heating plan of {len(heating_plan)} slots created", "")
933
946
  return heating_plan
934
947
 
935
948
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: juham-automation
3
- Version: 0.2.20
3
+ Version: 0.2.23
4
4
  Summary: Juha's Ultimate Home Automation Masterpiece
5
5
  Author-email: J Meskanen <juham.api@gmail.com>
6
6
  Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
@@ -0,0 +1,47 @@
1
+ LICENSE.rst
2
+ MANIFEST.in
3
+ README.rst
4
+ pyproject.toml
5
+ examples/myapp.py
6
+ juham_automation/__init__.py
7
+ juham_automation/japp.py
8
+ juham_automation/py.typed
9
+ juham_automation.egg-info/PKG-INFO
10
+ juham_automation.egg-info/SOURCES.txt
11
+ juham_automation.egg-info/dependency_links.txt
12
+ juham_automation.egg-info/entry_points.txt
13
+ juham_automation.egg-info/requires.txt
14
+ juham_automation.egg-info/top_level.txt
15
+ juham_automation/automation/__init__.py
16
+ juham_automation/automation/energybalancer.py
17
+ juham_automation/automation/energycostcalculator.py
18
+ juham_automation/automation/heatingoptimizer.py
19
+ juham_automation/automation/leakdetector.py
20
+ juham_automation/automation/watercirculator.py
21
+ juham_automation/ts/__init__.py
22
+ juham_automation/ts/electricityprice_ts.py
23
+ juham_automation/ts/energybalancer_ts.py
24
+ juham_automation/ts/energycostcalculator_ts.py
25
+ juham_automation/ts/forecast_ts.py
26
+ juham_automation/ts/log_ts.py
27
+ juham_automation/ts/power_ts.py
28
+ juham_automation/ts/powermeter_ts.py
29
+ juham_automation/ts/powerplan_ts.py
30
+ tests/__init__.py
31
+ tests/test_japp.py
32
+ tests/automation/__init__.py
33
+ tests/automation/test_energybalancer.py
34
+ tests/automation/test_energycostcalculator.py
35
+ tests/automation/test_heatingoptimizer.py
36
+ tests/automation/test_juham.py
37
+ tests/automation/test_leakdetector.py
38
+ tests/automation/test_watercirculator.py
39
+ tests/ts/__init__.py
40
+ tests/ts/test_electricityprice_ts.py
41
+ tests/ts/test_energybalancer_ts.py
42
+ tests/ts/test_energycostcalculator_ts.py
43
+ tests/ts/test_forecast_ts.py
44
+ tests/ts/test_log_ts.py
45
+ tests/ts/test_power_ts.py
46
+ tests/ts/test_powermeter_ts.py
47
+ tests/ts/test_powerplan_ts.py
@@ -7,7 +7,7 @@ include-package-data = true
7
7
 
8
8
  [project]
9
9
  name = "juham-automation"
10
- version = "0.2.20"
10
+ version = "0.2.23"
11
11
  description = "Juha's Ultimate Home Automation Masterpiece"
12
12
  readme = {file = "README.rst", content-type = "text/markdown"}
13
13
  requires-python = ">=3.8"
@@ -156,8 +156,7 @@ class TestHeatingOptimizer(unittest.TestCase):
156
156
  self.patcher_warning.stop()
157
157
 
158
158
  def test_initialization(self) -> None:
159
- self.assertEqual(self.optimizer.heating_slots_per_day, 3*3600 // self.optimizer.energy_balancing_interval)
160
- self.assertEqual(self.optimizer.schedule_start_slot, 5 * 3600 // self.optimizer.energy_balancing_interval)
159
+ self.assertEqual(self.optimizer.schedule_start_slot, 0)
161
160
  self.assertEqual(self.optimizer.spot_limit, 0.25)
162
161
  self.assertEqual(self.optimizer.current_temperature, 100)
163
162
  self.assertFalse(self.optimizer.relay)
@@ -1,204 +0,0 @@
1
- Changelog
2
- =========
3
-
4
-
5
- [0.2.10] - December 3 2025
6
- --------------------------
7
-
8
- - Error logging improved for timeseries database writes.
9
- - Dependencies to the recent masterpiece releases updated
10
-
11
-
12
- [0.2.9] - December 1 2025
13
- -------------------------
14
- - 'spothintafi.py' removed and implemented as separate 'juham-spothintafi' plugin
15
-
16
-
17
- [0.2.8] - December 1 2025
18
- -------------------------
19
- - LeakDetector migrated from juham-watermeter
20
- - Obsolete debug logging removed from the LeakDetector
21
-
22
-
23
- [0.2.6] - November 30 2025
24
- --------------------------
25
-
26
- - More agressive spot sensitivity.
27
-
28
-
29
-
30
- [0.2.5] - 2025-11-21
31
- --------------------
32
-
33
- - Project development status elevated to **Beta**.
34
- - Added an electricity-forecast–aware heating algorithm:
35
- If today's electricity price is high and tomorrow's is lower, the system
36
- automatically reduces heating today to optimize cost.
37
- - Introduced **SupervisorThread**, responsible for:
38
- - Detecting and listing crashed threads
39
- - Logging failures
40
- - Automatically restarting affected threads
41
- - Added a significant number of new unit tests to improve stability and
42
- coverage.
43
- - Extracted **powermeter_simulator.py** into a separate simulation plugin
44
- for cleaner architecture and modularity.
45
-
46
-
47
-
48
- [0.1.13] - Nov 15, 2025
49
- -----------------------
50
-
51
- - Installation instructions added into README.rst
52
- - Failure in **ts/log_ts.py** logging method logged the failure, leading to Infinite logging loop. Fixed.
53
-
54
-
55
- [0.1.11] - Nov 11, 2025
56
- -----------------------
57
-
58
- - New heating plan attributes published to timeseries
59
- - Heating plan now includes flags indicating whether temperature and solar power forecasts were used.
60
- - Min and max temperature limits published with the powerplan.
61
- - Minor issues in docstrings fixed.
62
- - Unit tests updated to reflect new heating plan attributes.
63
-
64
-
65
- [0.1.5] - Nov 07, 2025
66
- ----------------------
67
-
68
- - Heating plan optimization logic improved to better account for temperature and solar power forecasts.
69
- - Unit tests added for significantly higher coverage.
70
- - Documentation updated to reflect changes in temperature and solar power forecast handling.
71
- - SolarForecast and TemperatureForecast fields added to PowerPlan time series.
72
-
73
-
74
-
75
- [0.1.3] - Nov 01, 2025
76
- ----------------------
77
-
78
- - Added support for arbitrary energy balancing intervals in the automation module.
79
- - Default energy balancing interval changed from 1 hour to 15 minutes to comply with the new EU energy market directive.
80
- - Updated energy cost calculator and heating optimizer components to work with configurable intervals.
81
- - Improved unit tests to validate behavior across various interval lengths.
82
-
83
-
84
-
85
- [0.1.1] - Oct 28, 2025
86
- ----------------------
87
-
88
- - Project status elevated from Pre-Alpha to Alpha.
89
- - The default energy balancing interval for **HeatingOptimizer** is now 15 minutes.
90
- - Added "converage" package to [project.optional-dependencies] in pyproject.toml
91
-
92
-
93
-
94
- [0.0.73] - Aug 30, 2025
95
- -----------------------
96
-
97
- - Default boiler temperature limits adjusted.
98
-
99
-
100
- [0.0.34] - May 02, 2025
101
- -----------------------
102
-
103
- - Weight attribute added to heatingoptimizer. Determines how large a share of the time slot
104
- a consumer receives compared to others.
105
-
106
-
107
-
108
- [0.0.33] - May 01, 2025
109
- -----------------------
110
-
111
- - Workaround to Sphinx issue with multiply defined instance variables.
112
-
113
-
114
- [0.0.32] - April 27, 2025
115
- -------------------------
116
-
117
- * **HeatingOptimizer** single minimum and maximum temperature attributes replaced by a montly limits.
118
-
119
- .. code-block:: python
120
-
121
- pip install masterpiece_plugin
122
- boiler.temperature_limits = {
123
- 1: (50, 68), # January: colder, need hotter heating water
124
- 2: (50, 68), # February
125
- 3: (50, 68), # March
126
- 4: (40, 68), # April
127
- 5: (30, 68), # May
128
- 6: (30, 68), # June: warmer, need less heating
129
- 7: (30, 68), # July
130
- 8: (30, 68), # August
131
- 9: (40, 68), # September
132
- 10: (50, 68), # October
133
- 11: (50, 68), # November
134
- 12: (50, 68), # December
135
- }
136
-
137
- * **HeatingOptimizer** class attributes documented.
138
-
139
-
140
-
141
- [0.0.31] - April 21, 2025
142
- -------------------------
143
-
144
- * EnergyBalancer and EnergyBalancerTs classes improved. There is now two MQTT sub-topics: status,
145
- for controlling consumers, and diagnostics for monitoring the operation of the energy balancer.
146
-
147
-
148
- [0.0.29] - April 20, 2025
149
- -------------------------
150
-
151
- * Bug fixes to EnergyBalancer.
152
- * PriceForecast class updated (not there yet)
153
-
154
- [0.0.28] - April 20, 2025
155
- -------------------------
156
-
157
- * EnergyBalancer logic improved. Instead of activating all consumers at the same time, it now activates them one at a time
158
- in a serialized manner to minimize the maximum power (and fuse capacity, which affects the energy bill) required
159
- during balancing cycles.
160
-
161
-
162
- [0.0.27] - April 16, 2025
163
- -------------------------
164
-
165
- * CI pipeline unification.
166
- * EnergyBalacing features isolated from the HeatingOptimizer and implemented as a separate energybalancer module.
167
-
168
-
169
-
170
- [0.0.23] - April 04, 2025
171
- -------------------------
172
- * The HotWaterOptimizer class has been renamed to HeatingOptimizer to better reflect its general-purpose nature.
173
- * Added test_energybalancer.py
174
- * Added publish_diagnostics() method to track energy balance driven heating.
175
- * Added heatingoptimizer_ts module to support time series recording.
176
- * Fixed bug in net-energy balancing system.
177
- * Removed redundand dependencies in ``pyproject.toml``.
178
- * Enabled net energy balance feature.
179
-
180
-
181
- [0.1.12] - March 03, 2025
182
- -------------------------
183
-
184
- * Updated for the new modularized ci-templates and docs
185
- * New unit tests written, for better coverage. Not nearly there yet.
186
-
187
-
188
- [0.1.8-10] - February 23, 2025
189
- ------------------------------
190
-
191
- * Support for grid (network) prices and tax added.
192
-
193
- * Bug fix in the computation of the utilization optimization index: solar power was previously
194
- given in kW, while radiator power was in W, which underestimated the effect of available solar power.
195
-
196
- * New attribute added to time series: GridCost (cost and tax per kWh)
197
-
198
-
199
-
200
- [0.1.7] - February 08, 2025
201
- ---------------------------
202
-
203
- Initial release for GitLab. Pre-alpha!
204
-
@@ -1,44 +0,0 @@
1
- Contributing to Juham™ - Juha's Ultimate Home Automation Masterpiece
2
- ====================================================================
3
-
4
- Thank You!
5
- ----------
6
-
7
- Thank you in advance for your forthcoming contributions, whether they are bug fixes,
8
- documentation improvements, entirely new features, or simply feedback. Your efforts
9
- will be highly appreciated and will help turn this project from its current mission
10
- state into an actual masterpiece.
11
-
12
-
13
- Design Patterns
14
- ---------------
15
-
16
- Please read the developer documentation and understand the few design patterns behind Juham™ before contributing.
17
- This will help ensure that your contributions align with the project's design and goals.
18
- .. todo:: (okay, the documentation is currently lacking many essential chapters, add.)
19
-
20
-
21
- Code Formatting
22
- ---------------
23
-
24
- To help maintain consistent code formatting across different developers, we use 'black' python formatter, by Microsoft.
25
-
26
- Strange, the formatter doesn't seem to format that much, it doesn't organize imports,
27
- doesn't adjust docstring lenghts
28
- .. todo:: most likely I don't know how to use it properly, read the docs.
29
-
30
-
31
- Using Emacs and Makefile
32
- ------------------------
33
-
34
- Despite my attempts to fall in love with Eclipse, VSCode and other IDEs, I still find Emacs and Makefile the best
35
- tools for many workflows.
36
- So there is a Makefile in the root folder. For those old dogs who are like me
37
- ::
38
-
39
- make help
40
-
41
- More Stuff
42
- ----------
43
- .. todo:: TBA
44
-
@@ -1,25 +0,0 @@
1
- LICENSE
2
- =======
3
-
4
- Copyright (c) 2024, Juha Meskanen
5
-
6
- Permission is hereby granted, free of charge, to any person obtaining
7
- a copy of this software and associated documentation files (the
8
- "Software"), to deal in the Software without restriction, including
9
- without limitation the rights to use, copy, modify, merge, publish,
10
- distribute, sublicense, and/or sell copies of the Software, and to
11
- permit persons to whom the Software is furnished to do so, subject to
12
- the following conditions:
13
-
14
- **The above copyright notice and this permission notice shall be included in all
15
- copies or substantial portions of the Software.**
16
-
17
-
18
- ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21
- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22
- CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23
- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24
- SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. **
25
-
@@ -1,172 +0,0 @@
1
- Welcome to Juham™ - Juha's Ultimate Home Automation Masterpiece
2
- ===============================================================
3
-
4
- Project Description
5
- -------------------
6
-
7
- Beyond its super-cool name, this package provides essential home automation building blocks that address most common needs.
8
-
9
- It consists of two main sub-modules:
10
-
11
- ``automation``:
12
-
13
- This folder contains automation classes that listen to Juham™ MQTT topics and control various home automation tasks.
14
-
15
- - **watercirculator**: Automates a water circulator pump based on hot water temperature and motion detection.
16
- - **heatingoptimizer**: Controls hot water radiators based on temperature sensors and electricity price data.
17
- - **energycostcalculator**: Monitors power consumption and electricity prices, and computes the energy balance in euros.
18
- - **energybalancer**: Handles real-time energy balancing and net billing.
19
-
20
- ``ts``:
21
-
22
- This folder contains time series recorders that listen for Juham™ topics and store the data in a time series database for later inspection.
23
-
24
- - **electricityprice_ts** : publishes electricity prices to timeseries database.
25
- - **energybalancer_ts**: for monitoring the operation of energy balancer.
26
- - **energycostcalculator_ts**: publishes actualized energy prices per hour and per day.
27
- - **forecast_ts**: publishes the forecast datat to timeseries database.
28
- - **log_ts**: Writes log events to timeseries datbase.
29
- - **powerplan_ts**: publishes power plan data to timeseries database, when relays are planned to be switched on/off.
30
- - **powermeter_ts**: publishes powermeter data to timeseries database.
31
-
32
-
33
- Project Status
34
- --------------
35
-
36
- **Current State**: **Beta (Status 4)**
37
-
38
- All classes have been tested to some extent, and no known bugs have been reported.
39
-
40
-
41
- Project Links
42
- -------------
43
-
44
- - **Source code:** https://gitlab.com/juham/juham/juham-automation
45
- - **Issue tracker:** https://gitlab.com/juham/juham/juham-automation/-/issues
46
- - **Documentation:** https://juham-automation-c6383e.gitlab.io
47
- - **PyPI page:** https://pypi.org/project/juham-automation
48
-
49
-
50
-
51
- Features
52
- --------
53
-
54
- **HeatingAutomater** listens to the power meter to compute the net energy balance.
55
-
56
- .. image:: _static/images/juham_powermeter.png
57
- :alt: Powermeter
58
- :width: 400px
59
-
60
- Powermeter is needed to measure the real-time energy consumption
61
-
62
-
63
- **Energy Revenue** is computed based on the electricity price and transmission costs. This is the total cost one has to pay for consuming energy.
64
-
65
- .. image:: _static/images/juham_energyrevenue.png
66
- :alt: Energy Revenue
67
- :width: 400px
68
-
69
- Energy revenue per hour and per day
70
-
71
-
72
- **Real-time temperature** trends monitored by the **Shelly Plus Add-on** and **DS18B20** sensors
73
-
74
- .. image:: _static/images/juham_boilertemperatures.png
75
- :alt: Energy Revenue
76
- :width: 400px
77
-
78
- Temperature time series.
79
-
80
-
81
- **Real-time humidity** trends monitored by the **Shelly Plus Add-on** and **DHT22** sensors
82
-
83
- .. image:: _static/images/juham_humiditysensors.png
84
- :alt: Energy Revenue
85
- :width: 400px
86
-
87
- Relative humidity time series.
88
-
89
-
90
-
91
- **Utilization Optimization Index**: The Utilization Optimization Index predicts the optimal hours for energy consumption by factoring in electricity prices, temperature, and forecasts for wind and solar energy. It identifies the best times to activate heating systems. The cheapest hours within the current period may be skipped if the solar forecast predicts free electricity in the next period.period.
92
-
93
- .. image:: _static/images/juham_uoi.png
94
- :alt: Power Plan
95
- :width: 400px
96
-
97
- UOI cast for heating the primary and sun pre-heating boilers for two types of solar panels and boilers: electric-based panels and solar thermal panels, which use water circulation. The primary one is electrically heated, while the secondary ‘pre-heating’ boiler is heated by the hot water from the solar thermal panels, or by electricity when there's a positive energy balance.
98
-
99
-
100
- **Power Plan** is computed for the next 12 hours based on the electricity price and solar energy forecast. If no solar energy is available, the power plan determines power consumption, e.g., when the hot water radiators are enabled.
101
-
102
- .. image:: _static/images/juham_powerplan.png
103
- :alt: Power Plan
104
- :width: 400px
105
-
106
- Powerplan optimizing consumers to use the cheapest hours
107
-
108
-
109
- **Energy Balancer**: When the energy balance is positive (e.g., when solar panels produce more energy than is currently being consumed), the energy balancer is activated. It monitors the energy balance in 15-minute (or one-hour) intervals and computes when a consumer with a specific power demand should be activated to consume all the energy produced so far.
110
-
111
- .. image:: _static/images/juham_automation_energybalancer.png
112
- :alt: Energy Balancer
113
- :width: 400px
114
-
115
- Energy balancer activating consumers based on the actual real-time net energy
116
-
117
-
118
- **Power Diagnosis**: All controlled relays are monitored to ensure their correct operation. This ensures that relays are enabled according to the power plan and energy balancer commands.
119
-
120
- .. image:: _static/images/juham_automation_relays.png
121
- :alt: Relays
122
- :width: 400px
123
-
124
- The operation of the relays for diagnosis.
125
-
126
-
127
- Installing
128
- ----------
129
-
130
- Juham™ ships with a minimal yet fully functional home automation application that can be found in the **examples** folder.
131
- It creates a **PowerMeterSimulator** and **ShellyMotionSimulator** objets to generate simulated motion sensor and power meter readings.
132
- Later, you can replace it with your actual power meter, as well as plug in other input sensors to read and relays to control.
133
-
134
- 1. Set up a Mosquitto MQTT broker service. For more information read the manuals.
135
-
136
- .. code-block:: bash
137
-
138
- sudo apt install mosquitto mosquitto-clients
139
-
140
- 2. Configure Juham to talk to Mosquitto.
141
-
142
- In ``PahoMqtt.json``:
143
-
144
- .. code-block:: json
145
-
146
- {"paho_version" : 2}
147
-
148
- In ``Juham.json``:
149
-
150
- .. code-block:: json
151
-
152
- {"mqtt_class_id": "PahoMqtt", "mqtt_root_topic": "myapp", "mqtt_host": "localhost", "mqtt_port": 1883}
153
-
154
- In ``Timeseries.json``:
155
-
156
- .. code-block:: json
157
-
158
- {
159
- "token": "your-influx-token",
160
- "org": "your-organization",
161
- "host": "https://us-east-1-1.aws.cloud2.influxdata.com",
162
- "database": "your-database"
163
- }
164
-
165
- 3. In the ``juham/examples`` folder, run:
166
-
167
- .. code-block:: bash
168
-
169
- python3 myapp.py
170
-
171
- The application will start and time series data will show up in your InfluxDB database,
172
- which you can then visualize with tools such as Grafana.
@@ -1,86 +0,0 @@
1
- LICENSE.rst
2
- MANIFEST.in
3
- README.rst
4
- pyproject.toml
5
- docs/source/CHANGELOG.rst
6
- docs/source/CONTRIBUTING.rst
7
- docs/source/LICENSE.rst
8
- docs/source/README.rst
9
- examples/myapp.py
10
- juham_automation/__init__.py
11
- juham_automation/japp.py
12
- juham_automation/py.typed
13
- juham_automation.egg-info/PKG-INFO
14
- juham_automation.egg-info/SOURCES.txt
15
- juham_automation.egg-info/dependency_links.txt
16
- juham_automation.egg-info/entry_points.txt
17
- juham_automation.egg-info/requires.txt
18
- juham_automation.egg-info/top_level.txt
19
- juham_automation/automation/__init__.py
20
- juham_automation/automation/energybalancer.py
21
- juham_automation/automation/energycostcalculator.py
22
- juham_automation/automation/heatingoptimizer.py
23
- juham_automation/automation/leakdetector.py
24
- juham_automation/automation/watercirculator.py
25
- juham_automation/ts/__init__.py
26
- juham_automation/ts/electricityprice_ts.py
27
- juham_automation/ts/energybalancer_ts.py
28
- juham_automation/ts/energycostcalculator_ts.py
29
- juham_automation/ts/forecast_ts.py
30
- juham_automation/ts/log_ts.py
31
- juham_automation/ts/power_ts.py
32
- juham_automation/ts/powermeter_ts.py
33
- juham_automation/ts/powerplan_ts.py
34
- tests/__init__.py
35
- tests/test_japp.py
36
- tests/__pycache__/__init__.cpython-312.pyc
37
- tests/__pycache__/test_japp.cpython-312-pytest-9.0.1.pyc
38
- tests/__pycache__/test_japp.cpython-312.pyc
39
- tests/automation/__init__.py
40
- tests/automation/test_energybalancer.py
41
- tests/automation/test_energycostcalculator.py
42
- tests/automation/test_heatingoptimizer.py
43
- tests/automation/test_juham.py
44
- tests/automation/test_leakdetector.py
45
- tests/automation/test_watercirculator.py
46
- tests/automation/__pycache__/__init__.cpython-312.pyc
47
- tests/automation/__pycache__/test_energybalancer.cpython-312-pytest-9.0.1.pyc
48
- tests/automation/__pycache__/test_energybalancer.cpython-312.pyc
49
- tests/automation/__pycache__/test_energycostcalculator.cpython-312-pytest-9.0.1.pyc
50
- tests/automation/__pycache__/test_energycostcalculator.cpython-312.pyc
51
- tests/automation/__pycache__/test_heatingoptimizer.cpython-312-pytest-9.0.1.pyc
52
- tests/automation/__pycache__/test_heatingoptimizer.cpython-312.pyc
53
- tests/automation/__pycache__/test_juham.cpython-312-pytest-9.0.1.pyc
54
- tests/automation/__pycache__/test_juham.cpython-312.pyc
55
- tests/automation/__pycache__/test_leakdetector.cpython-312-pytest-9.0.1.pyc
56
- tests/automation/__pycache__/test_leakdetector.cpython-312.pyc
57
- tests/automation/__pycache__/test_spothintafi.cpython-312-pytest-9.0.1.pyc
58
- tests/automation/__pycache__/test_spothintafi.cpython-312.pyc
59
- tests/automation/__pycache__/test_watercirculator.cpython-312-pytest-9.0.1.pyc
60
- tests/automation/__pycache__/test_watercirculator.cpython-312.pyc
61
- tests/ts/__init__.py
62
- tests/ts/test_electricityprice_ts.py
63
- tests/ts/test_energybalancer_ts.py
64
- tests/ts/test_energycostcalculator_ts.py
65
- tests/ts/test_forecast_ts.py
66
- tests/ts/test_log_ts.py
67
- tests/ts/test_power_ts.py
68
- tests/ts/test_powermeter_ts.py
69
- tests/ts/test_powerplan_ts.py
70
- tests/ts/__pycache__/__init__.cpython-312.pyc
71
- tests/ts/__pycache__/test_electricityprice_ts.cpython-312-pytest-9.0.1.pyc
72
- tests/ts/__pycache__/test_electricityprice_ts.cpython-312.pyc
73
- tests/ts/__pycache__/test_energybalancer_ts.cpython-312-pytest-9.0.1.pyc
74
- tests/ts/__pycache__/test_energybalancer_ts.cpython-312.pyc
75
- tests/ts/__pycache__/test_energycostcalculator_ts.cpython-312-pytest-9.0.1.pyc
76
- tests/ts/__pycache__/test_energycostcalculator_ts.cpython-312.pyc
77
- tests/ts/__pycache__/test_forecast_ts.cpython-312-pytest-9.0.1.pyc
78
- tests/ts/__pycache__/test_forecast_ts.cpython-312.pyc
79
- tests/ts/__pycache__/test_log_ts.cpython-312-pytest-9.0.1.pyc
80
- tests/ts/__pycache__/test_log_ts.cpython-312.pyc
81
- tests/ts/__pycache__/test_power_ts.cpython-312-pytest-9.0.1.pyc
82
- tests/ts/__pycache__/test_power_ts.cpython-312.pyc
83
- tests/ts/__pycache__/test_powermeter_ts.cpython-312-pytest-9.0.1.pyc
84
- tests/ts/__pycache__/test_powermeter_ts.cpython-312.pyc
85
- tests/ts/__pycache__/test_powerplan_ts.cpython-312-pytest-9.0.1.pyc
86
- tests/ts/__pycache__/test_powerplan_ts.cpython-312.pyc