annotate py/fridge.py @ 228:d9e81a563923

porting to asyncio
author Matt Johnston <matt@ucc.asn.au>
date Fri, 20 Mar 2015 20:12:25 +0800
parents 720809f6c968
children a01b7bccccd3
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
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
8
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
9 class Fridge(object):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
10
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
11 OVERSHOOT_MAX_DIV = 1800.0 # 30 mins
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
12
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
13 def __init__(self, server):
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
14 self.server = server
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
15 self.gpio = gpio.Gpio(config.FRIDGE_GPIO_PIN, "fridge")
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
16 self.wort_valid_clock = 0
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
17 self.fridge_on_clock = 0
220
251524081924 make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 219
diff changeset
18 self.off()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
19
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
20 def turn(self, value):
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
21 self.gpio.turn(value)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
22
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
23 def on(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
24 self.turn(True)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
25
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
26 def off(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
27 self.turn(False)
220
251524081924 make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 219
diff changeset
28 self.fridge_off_clock = self.server.now()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
29
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
30 def is_on(self):
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
31 return self.gpio.get_state()
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
32
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
33 @asyncio.coroutine
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
34 def run(self):
162
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
35 if self.server.params.disabled:
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
36 L("Fridge is disabled")
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
37 while True:
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
38 self.do()
228
d9e81a563923 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 221
diff changeset
39 yield from self.server.sleep(config.FRIDGE_SLEEP)
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
40
145
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
41 def do(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
42 """ 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
43 wort, fridge = self.server.current_temps()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
44
145
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
45 params = self.server.params
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
46
170
78255c49bf9a make fridge air range a parameter
Matt Johnston <matt@ucc.asn.au>
parents: 168
diff changeset
47 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
48 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
49
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
50 wort_min = params.fridge_setpoint
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
51 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
52
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
53 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
54
177
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
55 if wort is not None:
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
56 self.wort_valid_clock = self.server.now()
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
57
220
251524081924 make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 219
diff changeset
58 # 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
59 # 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
60 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
61 L("fridge skipping, too early")
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
62 return
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
63
162
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
64 if params.disabled:
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
65 if self.is_on():
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
66 L("Disabled, turning fridge off")
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
67 self.off()
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
68 return
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
69
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
70 # handle broken wort sensor
177
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
71 if wort is None:
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
72 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
73 W("Invalid wort sensor for %d secs" % invalid_time)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
74 if invalid_time < config.FRIDGE_WORT_INVALID_TIME:
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
75 W("Has only been invalid for %d, waiting" % invalid_time)
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
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
78 if fridge is None:
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
79 W("Invalid fridge sensor")
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
80
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
81 if self.is_on():
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
82 turn_off = False
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
83 on_time = self.server.now() - self.fridge_on_clock
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
84
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
85 overshoot = 0
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
86 if on_time > params.overshoot_delay:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
87 overshoot = params.overshoot_factor \
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
88 * min(self.OVERSHOOT_MAX_DIV, on_time) \
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
89 / self.OVERSHOOT_MAX_DIV
163
bf2a17873ba1 less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 162
diff changeset
90 D("on_time %(on_time)f, overshoot %(overshoot)f" % locals())
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
91
178
77c2a9caca3d a few fixes
Matt Johnston <matt@ucc.asn.au>
parents: 177
diff changeset
92 if not params.nowort and wort is not None:
77c2a9caca3d a few fixes
Matt Johnston <matt@ucc.asn.au>
parents: 177
diff changeset
93 if wort - overshoot < params.fridge_setpoint:
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
94 L("wort has cooled enough, %(wort)f" % locals() )
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
95 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
96 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
97 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
98 if wort is None:
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
99 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
100 turn_off = True
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
101
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
102 if turn_off:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
103 L("Turning fridge off")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
104 self.off()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
105
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
106 else:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
107 # fridge is off
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
108 turn_on = False
168
bfc3213edee4 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 166
diff changeset
109 if not params.nowort \
bfc3213edee4 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 166
diff changeset
110 and wort is not None \
bfc3213edee4 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 166
diff changeset
111 and wort >= wort_max:
163
bf2a17873ba1 less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 162
diff changeset
112 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
113 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
114 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
115 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
116 turn_on = True
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
117
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
118 if turn_on:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
119 L("Turning fridge on")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
120 self.on()
158
a6612745b4a3 fix fridge_on_time
Matt Johnston <matt@ucc.asn.au>
parents: 149
diff changeset
121 self.fridge_on_clock = self.server.now()