annotate py/fridge.py @ 586:87c20b8c5472 default master

port to python3
author Matt Johnston <matt@ucc.asn.au>
date Mon, 09 Sep 2019 22:24:10 +0800
parents 6087c692d381
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
1 # -*- coding: utf-8 -*-
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
2 import asyncio
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
3
163
bf2a17873ba1 less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 162
diff changeset
4 from utils import L,W,E,EX,D
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
5 import config
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
6
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
7 import gpio
271
11cebd6f0bfb untested fridge.integrator
Matt Johnston <matt@ucc.asn.au>
parents: 269
diff changeset
8 import utils
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
9
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
10 class Fridge(object):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
11
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
12 OVERSHOOT_MAX_DIV = 1800.0 # 30 mins
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
13
266
20c89630be6c emergency change sensor config
Matt Johnston <matt@ucc.asn.au>
parents: 259
diff changeset
14 def __init__(self, server, nowait = False):
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
15 self.server = server
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
16 self.gpio = gpio.Gpio(config.FRIDGE_GPIO_PIN, "fridge")
271
11cebd6f0bfb untested fridge.integrator
Matt Johnston <matt@ucc.asn.au>
parents: 269
diff changeset
17 self.integrator = utils.StepIntegrator(self.server.now, self.server.params.overshoot_delay)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
18 self.wort_valid_clock = 0
305
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
19 self.fridge_valid_clock = 0
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
20 self.fridge_on_clock = 0
220
251524081924 make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 219
diff changeset
21 self.off()
266
20c89630be6c emergency change sensor config
Matt Johnston <matt@ucc.asn.au>
parents: 259
diff changeset
22 if nowait:
20c89630be6c emergency change sensor config
Matt Johnston <matt@ucc.asn.au>
parents: 259
diff changeset
23 self.fridge_off_clock = 0
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
24
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
25 def turn(self, value):
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
26 self.gpio.turn(value)
271
11cebd6f0bfb untested fridge.integrator
Matt Johnston <matt@ucc.asn.au>
parents: 269
diff changeset
27 self.integrator.turn(value)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
28
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
29 def on(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
30 self.turn(True)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
31
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
32 def off(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
33 self.turn(False)
220
251524081924 make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 219
diff changeset
34 self.fridge_off_clock = self.server.now()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
35
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
36 def is_on(self):
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
37 return self.gpio.get_state()
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
38
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
39 @asyncio.coroutine
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
40 def run(self):
162
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
41 if self.server.params.disabled:
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
42 L("Fridge is disabled")
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
43 while True:
232
a01b7bccccd3 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 228
diff changeset
44 try:
254
ffe25107d520 put more things inside "try"
Matt Johnston <matt@ucc.asn.au>
parents: 233
diff changeset
45 self.do()
232
a01b7bccccd3 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 228
diff changeset
46 yield from self.server.sleep(config.FRIDGE_SLEEP)
a01b7bccccd3 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 228
diff changeset
47 except Exception as e:
a01b7bccccd3 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 228
diff changeset
48 EX("fridge failed")
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
49
145
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
50 def do(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
51 """ this is the main fridge control logic """
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
52 wort, fridge = self.server.current_temps()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
53
145
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
54 params = self.server.params
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
55
170
78255c49bf9a make fridge air range a parameter
Matt Johnston <matt@ucc.asn.au>
parents: 168
diff changeset
56 fridge_min = params.fridge_setpoint - params.fridge_range_lower
78255c49bf9a make fridge air range a parameter
Matt Johnston <matt@ucc.asn.au>
parents: 168
diff changeset
57 fridge_max = params.fridge_setpoint + params.fridge_range_upper
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
58
166
5d5424acfed0 - use the fridge temperature for control too, keep it in a 6deg band
Matt Johnston <matt@ucc.asn.au>
parents: 163
diff changeset
59 wort_min = params.fridge_setpoint
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
60 wort_max = params.fridge_setpoint + params.fridge_difference
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
61
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
62 off_time = self.server.now() - self.fridge_off_clock
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
63
177
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
64 if wort is not None:
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
65 self.wort_valid_clock = self.server.now()
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
66
305
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
67 if fridge is not None:
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
68 self.fridge_valid_clock = self.server.now()
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
69
271
11cebd6f0bfb untested fridge.integrator
Matt Johnston <matt@ucc.asn.au>
parents: 269
diff changeset
70 self.integrator.set_limit(params.overshoot_delay)
11cebd6f0bfb untested fridge.integrator
Matt Johnston <matt@ucc.asn.au>
parents: 269
diff changeset
71
220
251524081924 make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 219
diff changeset
72 # Safety to avoid bad things happening to the fridge motor (?)
251524081924 make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 219
diff changeset
73 # When it turns off don't start up again for at least FRIDGE_DELAY
221
720809f6c968 Fridge.is_off() wasn't a method
Matt Johnston <matt@ucc.asn.au>
parents: 220
diff changeset
74 if not self.is_on() and off_time < config.FRIDGE_DELAY:
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
75 L("fridge skipping, too early")
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
76 return
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
77
162
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
78 if params.disabled:
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
79 if self.is_on():
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
80 L("Disabled, turning fridge off")
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
81 self.off()
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
82 return
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
83
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
84 # handle broken wort sensor
177
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
85 if wort is None:
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
86 invalid_time = self.server.now() - self.wort_valid_clock
197
3f187baa3439 Fix invalid wort time check
Matt Johnston <matt@ucc.asn.au>
parents: 178
diff changeset
87 W("Invalid wort sensor for %d secs" % invalid_time)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
88 if invalid_time < config.FRIDGE_WORT_INVALID_TIME:
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
89 W("Has only been invalid for %d, waiting" % invalid_time)
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
90 return
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
91
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
92 if fridge is None:
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
93 W("Invalid fridge sensor")
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
94
233
19569cb5ed46 better arg parser. seems close to ready
Matt Johnston <matt@ucc.asn.au>
parents: 232
diff changeset
95 D("fridge on %s" % self.is_on())
19569cb5ed46 better arg parser. seems close to ready
Matt Johnston <matt@ucc.asn.au>
parents: 232
diff changeset
96
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
97 if self.is_on():
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
98 turn_off = False
279
6848907f85be fix missing on_time variable
Matt Johnston <matt@ucc.asn.au>
parents: 272
diff changeset
99 on_time = self.integrator.integrate()
6848907f85be fix missing on_time variable
Matt Johnston <matt@ucc.asn.au>
parents: 272
diff changeset
100 on_percent = on_time / params.overshoot_delay
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
101
272
af924d27140f scale integrate by delay time
Matt Johnston <matt@ucc.asn.au>
parents: 271
diff changeset
102 overshoot = params.overshoot_factor * on_percent
af924d27140f scale integrate by delay time
Matt Johnston <matt@ucc.asn.au>
parents: 271
diff changeset
103 D("on_time %(on_percent)f, overshoot %(overshoot)f" % locals())
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
104
178
77c2a9caca3d a few fixes
Matt Johnston <matt@ucc.asn.au>
parents: 177
diff changeset
105 if not params.nowort and wort is not None:
77c2a9caca3d a few fixes
Matt Johnston <matt@ucc.asn.au>
parents: 177
diff changeset
106 if wort - overshoot < params.fridge_setpoint:
269
50a0e2d7d9e3 more logging of overshoot
Matt Johnston <matt@ucc.asn.au>
parents: 266
diff changeset
107 max_div = self.OVERSHOOT_MAX_DIV
50a0e2d7d9e3 more logging of overshoot
Matt Johnston <matt@ucc.asn.au>
parents: 266
diff changeset
108 overshoot_factor = params.overshoot_factor
50a0e2d7d9e3 more logging of overshoot
Matt Johnston <matt@ucc.asn.au>
parents: 266
diff changeset
109 L("wort has cooled enough, %(wort)fº (overshoot %(overshoot)fº = %(overshoot_factor)f * min(%(on_time)f) / %(max_div)f)" % locals() )
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
110 turn_off = True
166
5d5424acfed0 - use the fridge temperature for control too, keep it in a 6deg band
Matt Johnston <matt@ucc.asn.au>
parents: 163
diff changeset
111 elif fridge is not None and fridge < fridge_min:
5d5424acfed0 - use the fridge temperature for control too, keep it in a 6deg band
Matt Johnston <matt@ucc.asn.au>
parents: 163
diff changeset
112 W("fridge off fallback, fridge %(fridge)f, min %(fridge_min)f" % locals())
177
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
113 if wort is None:
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
114 W("wort has been invalid for %d" % (self.server.now() - self.wort_valid_clock))
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
115 turn_off = True
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
116
305
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
117 if wort is None and fridge is None:
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
118 invalid_time = self.server.now() - max(self.wort_valid_clock, self.fridge_valid_clock)
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
119 D("both sensors broken, invalid_time %(invalid_time)f" % locals())
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
120 if invalid_time > config.ALL_INVALID_TIME:
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
121 L("Both sensors broken for %(invalid_time)f seconds" % locals())
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
122 turn_off = True
6087c692d381 turn the fridge off if both sensors are broken
Matt Johnston <matt@ucc.asn.au>
parents: 279
diff changeset
123
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
124 if turn_off:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
125 L("Turning fridge off")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
126 self.off()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
127
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
128 else:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
129 # fridge is off
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
130 turn_on = False
254
ffe25107d520 put more things inside "try"
Matt Johnston <matt@ucc.asn.au>
parents: 233
diff changeset
131 D("fridge %(fridge)s max %(fridge_max)s wort %(wort)s wort_max %(wort_max)s" % locals())
168
bfc3213edee4 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 166
diff changeset
132 if not params.nowort \
bfc3213edee4 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 166
diff changeset
133 and wort is not None \
bfc3213edee4 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 166
diff changeset
134 and wort >= wort_max:
163
bf2a17873ba1 less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 162
diff changeset
135 L("Wort is too hot %f, max %f" % (wort, wort_max))
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
136 turn_on = True
166
5d5424acfed0 - use the fridge temperature for control too, keep it in a 6deg band
Matt Johnston <matt@ucc.asn.au>
parents: 163
diff changeset
137 elif fridge is not None and fridge >= fridge_max:
5d5424acfed0 - use the fridge temperature for control too, keep it in a 6deg band
Matt Johnston <matt@ucc.asn.au>
parents: 163
diff changeset
138 W("frdge on fallback, fridge %(fridge)f, max %(fridge_max)f" % locals())
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
139 turn_on = True
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
140
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
141 if turn_on:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
142 L("Turning fridge on")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
143 self.on()
158
a6612745b4a3 fix fridge_on_time
Matt Johnston <matt@ucc.asn.au>
parents: 149
diff changeset
144 self.fridge_on_clock = self.server.now()