annotate py/fridge.py @ 147:ab1e7bf77d69

requirements added
author Matt Johnston <matt@ucc.asn.au>
date Sun, 09 Dec 2012 20:07:15 +0800
parents 6517ddee3187
children b32e5a11a4cb
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 -*-
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
2 from utils import L,W,E,EX
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 FRIDGE_AIR_MIN_RANGE = 4 # ÂșC
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
10 FRIDGE_AIR_MAX_RANGE = 4
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
11
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
12 def __init__(self, server):
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
13 gevent.Greenlet.__init__(self)
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
14 self.server = server
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
15 self.setup_gpio()
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
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
18 self.fridge_off_clock = 0
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 setup_gpio(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
21 dir_fn = '%s/direction' % config.FRIDGE_GPIO
145
6517ddee3187 few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 144
diff changeset
22 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
23 f.write('low')
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
24 val_fn = '%s/value' % config.FRIDGE_GPIO
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
25 self.value_file = f.open(val_fn, 'r+')
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
26
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
27 def turn(self, value):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
28 self.value_file.seek(0)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
29 if value:
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
30 self.value_file.write('1')
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
31 else:
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
32 self.value_file.write('0')
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
33 self.value_file.flush()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
34
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
35 def on(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
36 self.turn(True)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
37
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
38 def off(self):
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
39 self.turn(False)
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
40
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
41 def is_on(self):
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
42 self.value_file.seek(0)
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
43 buf = self.value_file.read().strip()
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
44 if buf == '0':
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
45 return False
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
46 if buf != '1':
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
47 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
48 % (self.value_file.name, buf))
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
49 return True
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
50
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
51 # greenlet subclassed
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
52 def _run(self):
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
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
63 fridge_min = params.fridge_setpoint - self.FRIDGE_AIR_MIN_RANGE
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
64 fridge_max = params.fridge_setpoint + self.FRIDGE_AIR_MAX_RANGE
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
65
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
66 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
67
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
68 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
69
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
70 if off_time < config.FRIDGE_DELAY:
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
71 L("fridge skipping, too early")
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
72 return
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
73
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
74 # handle broken wort sensor
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
75 if wort is not None:
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
76 self.wort_valid_clock = self.server.now()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
77 else:
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
78 W("Invalid wort sensor")
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
79 invalid_time = self.server.now() - self.wort_valid_clock
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
80 if invalid_time < config.FRIDGE_WORT_INVALID_TIME:
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
81 W("Has only been invalid for %d, waiting" % invalid_time)
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
82 return
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
83
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
84 if fridge is None:
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
85 W("Invalid fridge sensor")
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
86
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
87 if self.is_on():
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
88 turn_off = False
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
89 on_time = self.server.now() - self.fridge_on_clock
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
90
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
91 overshoot = 0
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
92 if on_time > params.overshoot_delay:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
93 overshoot = params.overshoot_factor \
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
94 * min(self.OVERSHOOT_MAX_DIV, on_time) \
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
95 / self.OVERSHOOT_MAX_DIV
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
96 L("on_time %(on_time)f, overshoot %(overshoot)f" % locals())
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
97
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
98 if wort is not None:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
99 if (wort - overshoot) < params.fridge_setpoint:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
100 L("wort has cooled enough")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
101 turn_off = True
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
102 else:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
103 # wort sensor is broken
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
104 if fridge is not None and fridge < fridge_min:
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
105 W("fridge off fallback")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
106 turn_off = True
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
107
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
108 if turn_off:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
109 L("Turning fridge off")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
110 self.off()
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
111 self.fridge_off_clock = self.server.now()
141
4755e6f9a5b8 python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
112
143
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
113 else:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
114 # fridge is off
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
115 turn_on = False
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
116 if wort is not None:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
117 if wort >= wort_max:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
118 L("Wort is too hot")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
119 turn_on = True
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
120 else:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
121 # wort sensor is broken
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
122 if fridge is not None and fridge >= fridge_max:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
123 W("frdge on fallback")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
124 turn_on = True
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
125
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
126 if turn_on:
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
127 L("Turning fridge on")
0895f5ad7731 copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 141
diff changeset
128 self.on()
144
482d7852b511 a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 143
diff changeset
129 fridge_on_clock = self.server.now()