forked from thebearmay/hubitat
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhubInfoQuickRef3.html
88 lines (86 loc) · 7.89 KB
/
hubInfoQuickRef3.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
<!doctype html>
<html>
<head>
<title>Hub Information Driver Quick Reference</title>
<style>
h1, h2, h3 { color: RoyalBlue;}
</style>
</head>
<body>
<div>
<h1>Hub Information Driver Quick Reference</h1>
<div>
<h2>Commands</h2>
<ul>
<li><b>Configure - </b>Updates the preference settings and the base data</li>
<li><b>HIA Update - </b>Allows the Hub Information Aggregation app to override the <i>hmtl</i> attribute</li>
<li><b>Initialize - </b>Runs at hub start up, updates the preference settings and restarts all polling</li>
<li><b>Reboot - </b>If the preference is set to allow, this will reboot the hub (command is affected by Hub Security)</li>
<li><b>Refresh - </b>Forces a run of all polling cycles to refresh all polled attributes (including base data if not polled independently)</li>
<li><b>Remove Unused - </b>Remove attributes that are not selected for polling</li>
<li><b>Shutdown - </b>If the preference is set to allow, this will shutdown the hub (command is affected by Hub Security)</li>
<li><b>Update Check - </b>Force an unscheduled check for a Firmware Update</li>
</ul>
</div>
<div>
<h2>Preferences</h2>
<p>Most of these options require the driver to make a separate call to the hub gather the information, so it is recommended that you only
select the data that you are actively interested. Additional note, the CPU load information is a 5 minute average so it recommended that
polling be set at no less than 5 minutes. There are 4 polling queues available, the attribute selection preferences will allow designation of queues 0-4, zero is the do not report setting.</p>
<ul>
<li><b>Enable debug logging? -</b> Creates Debug Entries in the HE Log for 30 minutes</li>
<li><b>Suppress Warn Level Logging -</b> Don't create <i>Warn</i>ing log entries (most are simply informational)</li>
<li><b>CPU Temperature Polling-</b> Request current CPU temperature (attributes: temperatureF, temperatureC, temperature)</li>
<li><b>Free Memory Polling -</b> Request available free memory (attribute: freeMemory)</li>
<li><b>CPU Load Polling -</b> Request CPU load information (attributes: cpuLoad, cpuPct)</li>
<li><b>DB Size Polling -</b> Request DB size (attribute: dbSize)</li>
<li><b>Public IP Address -</b> Hit an external site to obtain the external IP address (attribute: publicIP )</li>
<li><b>Max Event/State Days Setting -</b> Request the system defaults for maximum days event and state changes are logged (attributes: maxEvtDays,maxStateDays) </li>
<li><b>Zwave Version -</b> Request the Zwave and SDK version levels (attributes: zwaveVersion, zwaveSDKVersion)</li>
<li><b>Time Sync Server Address -</b> Request the server address used for time synchronization (attribute: ntpServer)</li>
<li><b>Additional Subnets -</b> Check for secondary subnets (attribute: ipSubnetsAllowed)</li>
<li><b>Hub Mesh Data -</b> Map data for any hubs participating in HubMesh (attributes: hubMeshData, hubMeshCount)</li>
<li><b>Expanded Network Data -</b> HE v2.3.4.126 made available some addition network related data (attributes: connectType (Ethernet, WiFi, Dual), dnsServers, staticIPJson, lanIPAddr, wirelessIP, wifiNetwork)</li>
<li><b>Check for Firmware Update -</b> Check Hubitat.com for firmware updates (attributes: hubUpdateStatus, hubUpdateVersion)</li>
<li><b>Zwave Status & Hub Alerts -</b> Checks the hub UI for Zigbee/ZWave status and Hub Alert Messages (attributes: hubAlerts,zwaveStatus, zigbeeStatus2, securityInUse)</li>
<li><b>Base Data -</b> Base data is that data which seldom changes so by default it only is refreshed at driver initialization - normally at hub reboot. (attributes: firmwareVersionString, hardwareID, id, latitude, localIP, localSrvPortTCP, locationId, locationName, longitude, name, temperatureScale, timeZone, type, uptime, zigbeeChannel, zigbeeEui, zigbeeId, zigbeeStatus, zipCode)</li>
<li><b>15 Minute Averages -</b> Average readings for CPU Load, CPU % and Free Memory over the last 15 minutes; if less than 15 minutes since hub rebooted these will be set to the current cpu5Min, cpuPct and freeMemory attribute values</li>
<li><b>Check Cloud Connection -</b> Check the hub's cloud connection (attribute: cloud, values: invalid endpoint, connected, not connected)</li>
<li><b>MakerApi or Dashboard URL string -</b> A valid cloud url for one of the hub's dashboards, or the generic MakerApi string from <b>Get Device Info</b> (i.e.https://cloud.hubitat.com/api/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/apps/99/devices/[Device ID]?access_token=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
<li><b>Remove used attributes - </b>Remove all attributes not selected for polling</li>
<li><b>Enable HTML Attribute Creation? -</b> Create a custom attribute for display on a tile when the polling runs (attribute: html)</li>
<li><b>Template file for HTML attribute -</b> An editable text file in the HE File Manager that contains information to build the html attribute</li>
<li><b>HTML Attribute Output for > 1024 characters -</b> Local file to write the HTML attribute data to if it exceeds 1024 characters or when the Always use <span style='font-style: italic'>Output file for HTML Attribute</span> is enabled
<li><b>Always use Output file for HTML Attribute -</b> Enabling this option forces the output for the HTML attribute to be written to the local File Manager instead of the attribute, attribute will contain a link to the file.
<li><b>Log all attribute changes -</b> Create an <i>Info</i>rmation level log entry for every attribute update, regardless of whether the value changes</li>
<li><b>Allow Hub to be shutdown or rebooted -</b> Enable or disable the command for the driver to shutdown or reboot the hub</li>
<li><b>Hub Security Enabled -</b> If Hub Security is turned on, enable this option to enter the Username and Password</li>
<ul>
<li><b>Hub Security Username -</b> Username to allow login to the hub</li>
<li><b>Hub Security Password -</b> Password to allow login to the hub</li>
</ul>
<li><b>Date/Time Format for Sunrise/Sunset -</b> Simple Date Time Format string (attributes: sunrise, sunset)</li>
<li><b>Date/Time Format for Last Updated -</b> Simple Date Time Format string (attribute: lastUpdated)</li>
<li><b>Separator for Formatted Uptime -</b> Character/string to place between the formatted time segments (attribute: formattedUptime)</li>
<li><b>Poll Rate <i>x</i> in minutes - </b> The number minutes to set the polling interval for the associated queue</li>
<li><b>Poll Rate 4 in <span style='background-color:red;font-weight:bold;color:black'> hours </span>- </b> The number hours to set the polling interval for queue 4</li>
</ul>
</div>
<div>
<h2>Recommendations</h2>
<ul>
<li>Only poll attributes that are of value or interest to you, each selection will utilize some CPU time to process.</li>
<li>Most attributes do not change (or report change) in less than 5 minute intervals, having a polling interval that is shorter doesn't make them report faster and may impact hub performance if set too often.
<li>Poll queue 4 interval is in hours because some attributes, i.e. Firmware Update Availability, have very long intervals before they change - sometimes weeks. Using the hour interval saves in the math needed by you (although you are welcome to use one of the minutes interval queues if you desire).</li>
<li>Use intervals that minimize the possibility that multiple polls will occur simultaneously, i.e. 9m, 13m, 37min, 119m...</li>
</ul>
</div>
<div>
<h2>Notes</h2>
<ol>
<li>zigbeeStatus is a reflection of the radio status at boot up and may not be reset if the radio is turned off between reboots. zigbeeStatus2 is a more accurate reflection of the true state of the zigbee radio.</li>
</ol>
</div>
<div>
</body>
</html>