annotate py/fridge.py @ 581:b4d6f1ae0b9e

make overshoot_factor floating point add a proper error message for noparamsyet
author Matt Johnston <matt@ucc.asn.au>
date Sun, 29 Nov 2015 09:30:36 +0800
parents c5f8375b12a2
children 20c89630be6c
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
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
8
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
9 class Fridge(object):
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
10
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
11 OVERSHOOT_MAX_DIV = 1800.0 # 30 mins
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
12
443
bca470d153fd a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 442
diff changeset
13 def __init__(self, server):
bca470d153fd a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 442
diff changeset
14 self.server = server
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
15 self.gpio = gpio.Gpio(config.FRIDGE_GPIO_PIN, "fridge")
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
16 self.wort_valid_clock = 0
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
17 self.fridge_on_clock = 0
519
838e868a046e make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 518
diff changeset
18 self.off()
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
19
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
20 def turn(self, value):
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
21 self.gpio.turn(value)
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
22
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
23 def on(self):
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
24 self.turn(True)
556
c5f8375b12a2 long polling works
Matt Johnston <matt@ucc.asn.au>
parents: 554
diff changeset
25 pass
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
26
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
27 def off(self):
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
28 self.turn(False)
519
838e868a046e make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 518
diff changeset
29 self.fridge_off_clock = self.server.now()
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
30
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
31 def is_on(self):
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
32 return self.gpio.get_state()
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
33
527
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
34 @asyncio.coroutine
dd8895652485 porting to asyncio
Matt Johnston <matt@ucc.asn.au>
parents: 520
diff changeset
35 def run(self):
461
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
36 if self.server.params.disabled:
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
37 L("Fridge is disabled")
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
38 while True:
531
fd0fd9f947a1 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 527
diff changeset
39 try:
554
39540ddacdca put more things inside "try"
Matt Johnston <matt@ucc.asn.au>
parents: 532
diff changeset
40 self.do()
531
fd0fd9f947a1 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 527
diff changeset
41 yield from self.server.sleep(config.FRIDGE_SLEEP)
fd0fd9f947a1 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 527
diff changeset
42 except Exception as e:
fd0fd9f947a1 improve exception handling
Matt Johnston <matt@ucc.asn.au>
parents: 527
diff changeset
43 EX("fridge failed")
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
44
444
c5629d79b4ac few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 443
diff changeset
45 def do(self):
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
46 """ 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
47 wort, fridge = self.server.current_temps()
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
48
444
c5629d79b4ac few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 443
diff changeset
49 params = self.server.params
c5629d79b4ac few more bits
Matt Johnston <matt@ucc.asn.au>
parents: 443
diff changeset
50
469
de4abcbe8f46 make fridge air range a parameter
Matt Johnston <matt@ucc.asn.au>
parents: 467
diff changeset
51 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
52 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
53
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
54 wort_min = params.fridge_setpoint
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
55 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
56
443
bca470d153fd a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 442
diff changeset
57 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
58
476
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
59 if wort is not None:
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
60 self.wort_valid_clock = self.server.now()
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
61
519
838e868a046e make the fridge off timer more robust
Matt Johnston <matt@ucc.asn.au>
parents: 518
diff changeset
62 # 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
63 # 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
64 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
65 L("fridge skipping, too early")
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
66 return
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
67
461
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
68 if params.disabled:
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
69 if self.is_on():
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
70 L("Disabled, turning fridge off")
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
71 self.off()
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
72 return
1eb68df9f8ab Add daemon mode with locking, add "disabled" parameter
Matt Johnston <matt@ucc.asn.au>
parents: 457
diff changeset
73
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
74 # handle broken wort sensor
476
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
75 if wort is None:
443
bca470d153fd a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 442
diff changeset
76 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
77 W("Invalid wort sensor for %d secs" % invalid_time)
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
78 if invalid_time < config.FRIDGE_WORT_INVALID_TIME:
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
79 W("Has only been invalid for %d, waiting" % invalid_time)
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
80 return
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
81
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
82 if fridge is None:
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
83 W("Invalid fridge sensor")
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
84
532
9b1d71310c83 better arg parser. seems close to ready
Matt Johnston <matt@ucc.asn.au>
parents: 531
diff changeset
85 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
86
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
87 if self.is_on():
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
88 turn_off = False
443
bca470d153fd a bit more, and some tests
Matt Johnston <matt@ucc.asn.au>
parents: 442
diff changeset
89 on_time = self.server.now() - self.fridge_on_clock
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
90
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
91 overshoot = 0
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
92 if on_time > params.overshoot_delay:
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
93 overshoot = params.overshoot_factor \
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
94 * min(self.OVERSHOOT_MAX_DIV, on_time) \
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
95 / self.OVERSHOOT_MAX_DIV
462
a91adc95543d less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 461
diff changeset
96 D("on_time %(on_time)f, overshoot %(overshoot)f" % locals())
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
97
477
d05b1612e19e a few fixes
Matt Johnston <matt@ucc.asn.au>
parents: 476
diff changeset
98 if not params.nowort and wort is not None:
d05b1612e19e a few fixes
Matt Johnston <matt@ucc.asn.au>
parents: 476
diff changeset
99 if wort - overshoot < params.fridge_setpoint:
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
100 L("wort has cooled enough, %(wort)f" % locals() )
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
101 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
102 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
103 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
104 if wort is None:
06de0f2ffa26 workaround for invalid wort time
Matt Johnston <matt@ucc.asn.au>
parents: 469
diff changeset
105 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
106 turn_off = True
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
107
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
108 if turn_off:
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
109 L("Turning fridge off")
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
110 self.off()
439
31ac84425a2d python raspberry pi rewrite
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
111
442
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
112 else:
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
113 # fridge is off
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
114 turn_on = False
554
39540ddacdca put more things inside "try"
Matt Johnston <matt@ucc.asn.au>
parents: 532
diff changeset
115 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
116 if not params.nowort \
fa79666fb375 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 463
diff changeset
117 and wort is not None \
fa79666fb375 add nowort mode
Matt Johnston <matt@ucc.asn.au>
parents: 463
diff changeset
118 and wort >= wort_max:
462
a91adc95543d less verbose logging
Matt Johnston <matt@ucc.asn.au>
parents: 461
diff changeset
119 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
120 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
121 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
122 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
123 turn_on = True
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
124
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
125 if turn_on:
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
126 L("Turning fridge on")
02318c9660cd copied fridge logic from main.c
Matt Johnston <matt@ucc.asn.au>
parents: 439
diff changeset
127 self.on()
457
176fc5b68a3f fix fridge_on_time
Matt Johnston <matt@ucc.asn.au>
parents: 448
diff changeset
128 self.fridge_on_clock = self.server.now()