-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhelp.html
111 lines (86 loc) · 3.38 KB
/
help.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<html>
<head>
<title>Help</title>
<meta name=viewport content='width=370'>
</head>
<body bgcolor=#ffffff text=#000000 link=#ff0000 vlink=#880000 alink=#00ff00>
<div style='width:700px'>
<script type="text/javascript" src="links.js"></script>
<h1>Help</h1>
<p>
<h1>Devices</h1>
There is support for 4 devices: Dallas Systems 1-wire temperature sensors (DS),
pin io (gpio), the Omega relay-expansion board (relayexp), and a MyClock utility device (MyClock).
The names given here to the devices are used in the Input Variables section.
<h2>DS</h2>
Address - the address for the sensor:
<br>
<pre>cat /sys/devices/w1_bus_master1/w1_master_slaves</pre>
<h2>GPIO</h2>
Address - Enter the pin number being used.
<h2>RelayExp</h2>
Address - Enter the address of the relay.
<h2>MyClock</h2>
Address - leave blank or enter 0
<h1>Input Variables</h1>
<h2>DS</h2>
getTemp - return the devices temperature reading.
<h2>GPIO</h2>
getStatus - Return status of pin. Either 0 or 1.
<br>
isOn - 1 if pin in high, 0 if pin is low
<br>
isOff - 1 if pin in low, 0 if pin is high
<br>
getMinutesOn - number of minutes the pin has been on
<br>
getMinutesOff - number of minutes the pin has been off
<br>
getTimeOn - miliseconds the pin has been on, 0 if off
<br>
getTimeOff - miliseconds the pin has been off, 0 if on
<h2>RelayExp</h2>
Same as gpio.
<h2>MyClock</h2>
getTimeStamp - Needed for plotting logged data.
<h1>Evaluated Variables</h1>
Input Variables can be evaluated to be used as triggers for Actions.
<br>
Constant variables can be entered with the value in the Eval column.
<br>
Availiable comparison functions take two arguements. Eg: "gt,1,2" evaluates 1 > 2 and returns false.
<ul>
<li> gt, a, b : (a > b)</li>
<li> lt, a, b : (a < b)</li>
<li> gte, a, b : (a >= b)</li>
<li> lte, a, b : (a <= b)</li>
<li> and, a, b : (a && b)</li>
<li> or, a, b : (a || b)</li>
</ul>
<h1>Actions</h1>
Use an evaluated variable in Name. When true, the specified device function will be executed.
<br>
<h1>Example</h1>
<img src='control_setup.png'>
<h2>Devices</h2>
The devices are set up with addresses for temperature sensors and the relay address for the Omega2 relay expansion board.
A 'time' device is also made for plotting logged data.
<h2>Input Variables</h2>
The variable 'Time' is case sensitivce for making plots.<br>
Temperatures are measured from both sensor devices.<br>
The state of the relay is stored in two variables for so that the relay is not told to switch on/off if it is already in that state.<br>
The ']' in 'isOn' is used to tell the plotting script to create a separate Y-axis on the right.
(This second Y-axis is hidden for visual simplicity.)<br>
<b>offTime1</b> records the amount of time the relay has been off.
<h2>Evaluated Variables</h2>
Constants <b>warmPt</b> and <b>coolPt</b> are bounds that the freezer should stay between.<br>
<b>offCheck</b> makes sure that the freezer will not cycle too often and burn out the compressor.<br>
<b>beenOff</b> ensures that the relay is off and has been off for long enough. (This is probably not necessary, but should prevent wierd bugs.)<br>
<b>isWarm</b> - is the temperature beyond the warm setpoint?<br>
<b>isCool</b> - is the temperature beyond the cool setpoint?<br>
<b>off_and_warm</b> and <b>isCool_and_on</b> are the states used to trigger actions.
<h2>Actions</h2>
The relay defined in Devices is turned on or off when all conditions are met.
</div>
</body>
</html>