annotate py/fridge.py @ 208:ea800fcc1ad4

improve README
author Matt Johnston <matt@ucc.asn.au>
date Thu, 26 Jun 2014 21:35:23 +0800
parents 3f187baa3439
children 16a83e2c97a0
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 -*-
163
bf2a17873ba1 less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 162
diff changeset
2 from utils import L,W,E,EX,D
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
3 import config
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
4 import gevent
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
5
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
6 class Fridge(gevent.Greenlet):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
7
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
8 OVERSHOOT_MAX_DIV = 1800.0 # 30 mins
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
9
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
10 def __init__(self, server):
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
11 gevent.Greenlet.__init__(self)
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
12 self.server = server
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
13 self.setup_gpio()
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
14 self.wort_valid_clock = 0
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
15 self.fridge_on_clock = 0
149
d686b111dab4 working better. logging works properly, cleanup fridge.off() happens.
Matt Johnston <matt@ucc.asn.au>
parents: 148
diff changeset
16 self.fridge_off_clock = server.now()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
17
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
18 def setup_gpio(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
19 dir_fn = '%s/direction' % config.FRIDGE_GPIO
145
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
20 with open(dir_fn, 'w') as f:
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
21 f.write('low')
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
22 val_fn = '%s/value' % config.FRIDGE_GPIO
148
b32e5a11a4cb few updates, seems to run
Matt Johnston <matt@ucc.asn.au>
parents: 145
diff changeset
23 self.value_file = open(val_fn, 'r+')
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):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
26 self.value_file.seek(0)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
27 if value:
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
28 self.value_file.write('1')
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
29 else:
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
30 self.value_file.write('0')
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
31 self.value_file.flush()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
32
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
33 def on(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
34 self.turn(True)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
35
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
36 def off(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
37 self.turn(False)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
38
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
39 def is_on(self):
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
40 self.value_file.seek(0)
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
41 buf = self.value_file.read().strip()
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
42 if buf == '0':
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
43 return False
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
44 if buf != '1':
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
45 E("Bad value read from gpio '%s': '%s'"
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
46 % (self.value_file.name, buf))
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
47 return True
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
48
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
49 # greenlet subclassed
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
50 def _run(self):
162
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
51 if self.server.params.disabled:
d73077e8cd67 Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 158
diff changeset
52 L("Fridge is disabled")
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
53 while True:
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
54 self.do()
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
55 gevent.sleep(config.FRIDGE_SLEEP)
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
56
145
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
57 def do(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
58 """ 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
59 wort, fridge = self.server.current_temps()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
60
145
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
61 params = self.server.params
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
62
170
78255c49bf9a make fridge air range a parameter
Matt Johnston <matt@ucc.asn.au>
parents: 168
diff changeset
63 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
64 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
65
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
66 wort_min = params.fridge_setpoint
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
67 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
68
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
69 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
70
177
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
71 if wort is not None:
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
72 self.wort_valid_clock = self.server.now()
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
73
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
74 if 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
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
95 if self.is_on():
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
96 turn_off = False
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
97 on_time = self.server.now() - self.fridge_on_clock
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
98
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
99 overshoot = 0
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
100 if on_time > params.overshoot_delay:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
101 overshoot = params.overshoot_factor \
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
102 * min(self.OVERSHOOT_MAX_DIV, on_time) \
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
103 / self.OVERSHOOT_MAX_DIV
163
bf2a17873ba1 less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 162
diff changeset
104 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
105
178
77c2a9caca3d a few fixes
Matt Johnston <matt@ucc.asn.au>
parents: 177
diff changeset
106 if not params.nowort and wort is not None:
77c2a9caca3d a few fixes
Matt Johnston <matt@ucc.asn.au>
parents: 177
diff changeset
107 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
108 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
109 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
110 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
111 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
112 if wort is None:
a0ea542256ba workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 170
diff changeset
113 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
114 turn_off = True
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
115
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
116 if turn_off:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
117 L("Turning fridge off")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
118 self.off()
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
119 self.fridge_off_clock = self.server.now()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
120
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
121 else:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
122 # fridge is off
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
123 turn_on = False
168
bfc3213edee4 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 166
diff changeset
124 if not params.nowort \
bfc3213edee4 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 166
diff changeset
125 and wort is not None \
bfc3213edee4 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 166
diff changeset
126 and wort >= wort_max:
163
bf2a17873ba1 less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 162
diff changeset
127 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
128 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
129 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
130 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
131 turn_on = True
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
132
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
133 if turn_on:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
134 L("Turning fridge on")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
135 self.on()
158
a6612745b4a3 fix fridge_on_time
Matt Johnston <matt@ucc.asn.au>
parents: 149
diff changeset
136 self.fridge_on_clock = self.server.now()