annotate py/fridge.py @ 582:cebec9b40ad2

merge
author Matt Johnston <matt@ucc.asn.au>
date Mon, 30 Nov 2015 21:45:17 +0800
parents 358293768234
children 6087c692d381
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
1 # -*- coding: utf-8 -*-
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
2 import asyncio
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
3
462
a91adc95543d less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 461
diff changeset
4 from utils import L,W,E,EX,D
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
5 import config
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
6
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
7 import gpio
570
afe2eb17723e untested fridge.integrator
Matt Johnston <matt@ucc.asn.au>
parents: 568
diff changeset
8 import utils
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
9
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
10 class Fridge(object):
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
11
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
12 OVERSHOOT_MAX_DIV = 1800.0 # 30 mins
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
13
565
26f20cee71be emergency change sensor config
Matt Johnston <matt@ucc.asn.au>
parents: 556
diff changeset
14 def __init__(self, server, nowait = False):
443
bca470d153fd a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 442
diff changeset
15 self.server = server
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
16 self.gpio = gpio.Gpio(config.FRIDGE_GPIO_PIN, "fridge")
570
afe2eb17723e untested fridge.integrator
Matt Johnston <matt@ucc.asn.au>
parents: 568
diff changeset
17 self.integrator = utils.StepIntegrator(self.server.now, self.server.params.overshoot_delay)
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
18 self.wort_valid_clock = 0
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
19 self.fridge_on_clock = 0
519
838e868a046e make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 518
diff changeset
20 self.off()
565
26f20cee71be emergency change sensor config
Matt Johnston <matt@ucc.asn.au>
parents: 556
diff changeset
21 if nowait:
26f20cee71be emergency change sensor config
Matt Johnston <matt@ucc.asn.au>
parents: 556
diff changeset
22 self.fridge_off_clock = 0
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
23
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
24 def turn(self, value):
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
25 self.gpio.turn(value)
570
afe2eb17723e untested fridge.integrator
Matt Johnston <matt@ucc.asn.au>
parents: 568
diff changeset
26 self.integrator.turn(value)
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
27
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
28 def on(self):
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
29 self.turn(True)
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
30
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
31 def off(self):
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
32 self.turn(False)
519
838e868a046e make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 518
diff changeset
33 self.fridge_off_clock = self.server.now()
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
34
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
35 def is_on(self):
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
36 return self.gpio.get_state()
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
37
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
38 @asyncio.coroutine
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
39 def run(self):
461
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
40 if self.server.params.disabled:
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
41 L("Fridge is disabled")
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
42 while True:
531
fd0fd9f947a1 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 527
diff changeset
43 try:
554
39540ddacdca put more things inside "try"
Matt Johnston <matt@ucc.asn.au>
parents: 532
diff changeset
44 self.do()
531
fd0fd9f947a1 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 527
diff changeset
45 yield from self.server.sleep(config.FRIDGE_SLEEP)
fd0fd9f947a1 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 527
diff changeset
46 except Exception as e:
fd0fd9f947a1 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 527
diff changeset
47 EX("fridge failed")
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
48
444
c5629d79b4ac few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 443
diff changeset
49 def do(self):
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
50 """ this is the main fridge control logic """
443
bca470d153fd a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 442
diff changeset
51 wort, fridge = self.server.current_temps()
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
52
444
c5629d79b4ac few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 443
diff changeset
53 params = self.server.params
c5629d79b4ac few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 443
diff changeset
54
469
de4abcbe8f46 make fridge air range a parameter
Matt Johnston <matt@ucc.asn.au>
parents: 467
diff changeset
55 fridge_min = params.fridge_setpoint - params.fridge_range_lower
de4abcbe8f46 make fridge air range a parameter
Matt Johnston <matt@ucc.asn.au>
parents: 467
diff changeset
56 fridge_max = params.fridge_setpoint + params.fridge_range_upper
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
57
463
f2cca8062128 - use the fridge temperature for control too, keep it in a 6deg band
Matt Johnston <matt@ucc.asn.au>
parents: 462
diff changeset
58 wort_min = params.fridge_setpoint
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
59 wort_max = params.fridge_setpoint + params.fridge_difference
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
60
443
bca470d153fd a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 442
diff changeset
61 off_time = self.server.now() - self.fridge_off_clock
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
62
476
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
63 if wort is not None:
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
64 self.wort_valid_clock = self.server.now()
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
65
570
afe2eb17723e untested fridge.integrator
Matt Johnston <matt@ucc.asn.au>
parents: 568
diff changeset
66 self.integrator.set_limit(params.overshoot_delay)
afe2eb17723e untested fridge.integrator
Matt Johnston <matt@ucc.asn.au>
parents: 568
diff changeset
67
519
838e868a046e make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 518
diff changeset
68 # Safety to avoid bad things happening to the fridge motor (?)
838e868a046e make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 518
diff changeset
69 # When it turns off don't start up again for at least FRIDGE_DELAY
520
9b98091ca573 Fridge.is_off() wasn't a method
Matt Johnston <matt@ucc.asn.au>
parents: 519
diff changeset
70 if not self.is_on() and off_time < config.FRIDGE_DELAY:
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
71 L("fridge skipping, too early")
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
72 return
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
73
461
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
74 if params.disabled:
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
75 if self.is_on():
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
76 L("Disabled, turning fridge off")
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
77 self.off()
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
78 return
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
79
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
80 # handle broken wort sensor
476
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
81 if wort is None:
443
bca470d153fd a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 442
diff changeset
82 invalid_time = self.server.now() - self.wort_valid_clock
497
455f19b64e0f Fix invalid wort time check
Matt Johnston <matt@ucc.asn.au>
parents: 477
diff changeset
83 W("Invalid wort sensor for %d secs" % invalid_time)
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
84 if invalid_time < config.FRIDGE_WORT_INVALID_TIME:
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
85 W("Has only been invalid for %d, waiting" % invalid_time)
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
86 return
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
87
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
88 if fridge is None:
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
89 W("Invalid fridge sensor")
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
90
532
9b1d71310c83 better arg parser. seems close to ready
Matt Johnston <matt@ucc.asn.au>
parents: 531
diff changeset
91 D("fridge on %s" % self.is_on())
9b1d71310c83 better arg parser. seems close to ready
Matt Johnston <matt@ucc.asn.au>
parents: 531
diff changeset
92
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
93 if self.is_on():
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
94 turn_off = False
578
358293768234 fix missing on_time variable
Matt Johnston <matt@ucc.asn.au>
parents: 571
diff changeset
95 on_time = self.integrator.integrate()
358293768234 fix missing on_time variable
Matt Johnston <matt@ucc.asn.au>
parents: 571
diff changeset
96 on_percent = on_time / params.overshoot_delay
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
97
571
ccfaa4351fd8 scale integrate by delay time
Matt Johnston <matt@ucc.asn.au>
parents: 570
diff changeset
98 overshoot = params.overshoot_factor * on_percent
ccfaa4351fd8 scale integrate by delay time
Matt Johnston <matt@ucc.asn.au>
parents: 570
diff changeset
99 D("on_time %(on_percent)f, overshoot %(overshoot)f" % locals())
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
100
477
d05b1612e19e a few fixes
Matt Johnston <matt@ucc.asn.au>
parents: 476
diff changeset
101 if not params.nowort and wort is not None:
d05b1612e19e a few fixes
Matt Johnston <matt@ucc.asn.au>
parents: 476
diff changeset
102 if wort - overshoot < params.fridge_setpoint:
568
8eb16d97ed2b more logging of overshoot
Matt Johnston <matt@ucc.asn.au>
parents: 565
diff changeset
103 max_div = self.OVERSHOOT_MAX_DIV
8eb16d97ed2b more logging of overshoot
Matt Johnston <matt@ucc.asn.au>
parents: 565
diff changeset
104 overshoot_factor = params.overshoot_factor
8eb16d97ed2b more logging of overshoot
Matt Johnston <matt@ucc.asn.au>
parents: 565
diff changeset
105 L("wort has cooled enough, %(wort)fº (overshoot %(overshoot)fº = %(overshoot_factor)f * min(%(on_time)f) / %(max_div)f)" % locals() )
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
106 turn_off = True
463
f2cca8062128 - use the fridge temperature for control too, keep it in a 6deg band
Matt Johnston <matt@ucc.asn.au>
parents: 462
diff changeset
107 elif fridge is not None and fridge < fridge_min:
f2cca8062128 - use the fridge temperature for control too, keep it in a 6deg band
Matt Johnston <matt@ucc.asn.au>
parents: 462
diff changeset
108 W("fridge off fallback, fridge %(fridge)f, min %(fridge_min)f" % locals())
476
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
109 if wort is None:
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
110 W("wort has been invalid for %d" % (self.server.now() - self.wort_valid_clock))
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
111 turn_off = True
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
112
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
113 if turn_off:
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
114 L("Turning fridge off")
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
115 self.off()
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
116
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
117 else:
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
118 # fridge is off
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
119 turn_on = False
554
39540ddacdca put more things inside "try"
Matt Johnston <matt@ucc.asn.au>
parents: 532
diff changeset
120 D("fridge %(fridge)s max %(fridge_max)s wort %(wort)s wort_max %(wort_max)s" % locals())
467
fa79666fb375 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 463
diff changeset
121 if not params.nowort \
fa79666fb375 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 463
diff changeset
122 and wort is not None \
fa79666fb375 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 463
diff changeset
123 and wort >= wort_max:
462
a91adc95543d less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 461
diff changeset
124 L("Wort is too hot %f, max %f" % (wort, wort_max))
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
125 turn_on = True
463
f2cca8062128 - use the fridge temperature for control too, keep it in a 6deg band
Matt Johnston <matt@ucc.asn.au>
parents: 462
diff changeset
126 elif fridge is not None and fridge >= fridge_max:
f2cca8062128 - use the fridge temperature for control too, keep it in a 6deg band
Matt Johnston <matt@ucc.asn.au>
parents: 462
diff changeset
127 W("frdge on fallback, fridge %(fridge)f, max %(fridge_max)f" % locals())
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
128 turn_on = True
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
129
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
130 if turn_on:
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
131 L("Turning fridge on")
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
132 self.on()
457
176fc5b68a3f fix fridge_on_time
Matt Johnston <matt@ucc.asn.au>
parents: 448
diff changeset
133 self.fridge_on_clock = self.server.now()