forked from Dan-in-CA/SIP
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gv_reference.txt
70 lines (64 loc) · 3.6 KB
/
gv_reference.txt
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
??Vars held in the settings dict (gv.sd), default values shown
from controller values (cvalues):
en:1 enabled (system operation)
rd:0 rain delay (hours)
mm:0 manual mode (bool)
rbt:0 reboot (bool)
from options:
alr:0 active-low relay (for use with relay boards connected through shift registers)
htp:80 port to bind to for the HTTP server
htip:"::" IP address to bind to for the HTTP server
seq:1 sequential/concurrent operation (bool)
sdt:0 station delay time
mton:0 master on delay
mtoff:0 master off delay
nbrd:1 number of boards (includes base unit and expansion octets/boards)
tz:16 time zone -- no longer used by the program as of v2.0
tf:1 time format (24 hour clock == 1)
urs:0 use rain sensor (bool)
rst:1 Rain sensor type (normaly open=1 (dafault), or normaly closed=0)
wl:100 water level (percent adjustment of watering time)
mas:0 master station index
upas:0 use password (bool)
passphrase:"12d4e6fc471fbe073df5a0678fcffb9f75b12161e4e3f6d1e1bd81ffb22163bf" SHA256 hash of passphrase. default (opendoor) shown.
loc:"" location (for weather) - not used
rdst:0 rain delay stop time (unix time stamp)
rs:0 rain sensed (bool)
nopts:14 Number of options to be displayed
name:"SIP" configurable name for system
snlen:32 max size of station names
idd:0 individual run times
for scheduling:
bsy:0 program busy
nprogs:0 number of programs (can be calculated form length of prog array)
mo:[0] master operation bytes - contains bits per board for stations with master set
ir:[0] ignore rain bytes - contains bits per board for stations to ignore rain delay and rain sensor
iw:[0] ingore water level - contains bits per board for stations to ignore water level (both general scaling and plugin adjustments)
rsn:0 Reset all stations
nst:8 number of stations
tz_offset:varies local device time offset from UTC in seconds.
for logging:
lg:0 log runs if = "checked"
lr:100 limit number of log records to keep, 0 = no limit
UI related:
name: u"SIP" System name. can be used to manage multiple controllers
theme: "original" files used to style the UItyle the UI
other gv attributes:
gv.ver software rev number (int, converted to dot separated digets in UI)
gv.ver_date date of release (string)
gv.nowt current time as struct time, updated once per second at top of timing loop
gv.now current time, updated once per second at top of timing loop
gv.srvals shift register values, used to turn zones on or off (list of one byte per station, 1 = turn on, 0 = turn off)
gv.output_srvals shift register values, used to turn zones on or off (list of one byte per station, 1 = turn on, 0 = turn off)
gv.outpu_srvals_lock a mutex used whenever gv.output_srvals must be accessed atomically
gv.rovals run once values - list of duration times in seconds for a run once program (list, length = number of statons)
gv.pd program data - loaded from file at startup (list of dicts)
gv.ps program schedule used for UI display (list of 2 element lists i.e. [program number, duration])
gv.pon program on (Holds program number of currently running program)
gv.sbits station bits, used to display stations that are on in UI (list of bytes, one byte per board)
gv.rs run schedule (list [scheduled start time, scheduled stop time, duration, program number])
gv.lrun last run, used to display log line on home page (list [station index, program number, duration, end time])
gv.scount station count, used in set station to track on stations with master association
gv.plugin_menu list to hold a 2 element list for each plugin to be added to menu on home page (['menu text', 'url'])
gv.plugin_data dictionary (index by plugin root web prefix) to hold plugin data.
gv.use_pigpio set if pigpio libary is installed.