-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathParameter Definitions.txt
More file actions
62 lines (44 loc) · 4.29 KB
/
Parameter Definitions.txt
File metadata and controls
62 lines (44 loc) · 4.29 KB
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
Parameter Definitions:
Note: data types are best guesses. This a draft document. 2015-06-08
local_wifi_ssid VARCHAR(256)
local_ssid_pw VARCHAR(256)
User assignable wifi credentials. Enables data transfer to/from cloud.
head_commit_freq INTEGER
We're not sure what this is. To be identified.
analyst_port INTEGER
analyst_hostname VARCHAR(256)
analyst_ssid VARCHAR(256)
analyst_pass VARCHAR(256)
Analyst server credentials. This should not be user changeable. This should be changeable by Canary to accommodate custom data collection systems for building managers and analysts when connecting to a VM server or an Apache MySQL stack.
cloud_hostname VARCHAR(256)
cloud_url_base VARCHAR(256)
cloud_port INTEGER
cloud_upload_freq INTEGER
Cloud server credentials. This should not be user changeable. This should be changeable by Canary in the event that our cloud hosting requires a change.
du_pairing_limit INTEGER
I don't think this is currently implemented, though it is in the code. Confirmation needed. We do want to enable the capability of controlling multiple displays. Research needed to clarify the mechanism. Question, does the Controller (v6.0.1) act as a beacon? Will it broadcast color transitions to all displays that carry matching MAC SSIDs?
display_pair_mac HEX(12)
Not currently implemented (v6.0.1). This may be required to automate pairing of replacement displays. It would allow us to assign a display from the cloud/analyst server. The controller would then keep an eye out for any new Display broadcasting a ready-to-pair SSID. If the display MAC matches, then pairing process executes.
display_pair_mac_pw VARCHAR
Not currently implemented (v6.0.1). This might not be an externally changeable variable. This would be an algorithmically determined password based on the MAC address. Could ensure that only the intended device gets connected in a device crowded environment, or prevent any hijacking of neighboring devices.
controller_pair_mac HEX(12)
Currently this is assigned to the Display. It then broadcasts the Controller MAC as a wifi access point SSID. If a Controller detects an SSID of it's own MAC, it knows to connect with that Display.
controller_pair_mac_pw VARCHAR
Not currently implemented (v6.0.1). This might not be an externally changeable variable. This would be an algorithmically determined password based on the MAC address. Could ensure that only the intended device gets connected in a device crowded environment, or prevent any hijacking of neighboring devices.
analyst_sync_resolution INTEGER
Analyst may choose a coarser data resolution than second-by-second for faster download times and easier data management. Per day or per hour energy use is most likely.
cloud_sync_resolution INTEGER
May choose a coarser data resolution than second-by-second for economic use of servers. Per minute or per hour energy use is most likely.
time_zone TIME
Change time time zone to match user's location.
bucket_reset_time TIME
Change time when daily bucket resets to zero.
bucket_multiplier INTEGER
Currently implemented, but it should probably be renamed and applied to the instant values. We'll always want the bucket/energy to directly relate to the specified budget. But an algorithm my be desired to shift the responsiveness of the instant color changes. It currently is changed to be three times more responsive.
color_lookup_table ARRAY
Holds all the color patterns for each level transition and operating mode indicators.
L-transition_table_default ARRAY
Holds all the default seasonal level transition by monthly resolution. I would prefer to change monthly resolution to daily resolution if possible (with a maximum of 12 seasonal changes, if necessary for code simplicity). If 12 changes, the array would hold 60 values in the following pattern.
FIRST DAY OF YEAR (001); L1; L2; L3; L4; Day to begin new level set; L1; L2; L3; L4; Day to begin new level set; L1; L2; L3; L4; etc...
L-transition_table_temporary ARRAY
Holds temporary set of overriding transitions and an expiration period before either checking for a new set or reverting to defaults. This allows for dynamic transitions that open the possiblity for the social gamification of the system. For example a transition set relative to a frienemies energy use data (winning/losing?).