forked from tonesto7/nest-manager
/
README.html
512 lines (456 loc) · 21.7 KB
/
README.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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
<!DOCTYPE html>
<html>
<head>
<title>README</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<style type="text/css">
/* GitHub stylesheet for MarkdownPad (http://markdownpad.com) */
/* Author: Nicolas Hery - http://nicolashery.com */
/* Version: b13fe65ca28d2e568c6ed5d7f06581183df8f2ff */
/* Source: https://github.com/nicolahery/markdownpad-github */
/* RESET
=============================================================================*/
html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
margin: 0;
padding: 0;
border: 0;
}
/* BODY
=============================================================================*/
body {
font-family: Helvetica, arial, freesans, clean, sans-serif;
font-size: 14px;
line-height: 1.6;
color: #333;
background-color: #fff;
padding: 20px;
max-width: 960px;
margin: 0 auto;
}
body>*:first-child {
margin-top: 0 !important;
}
body>*:last-child {
margin-bottom: 0 !important;
}
/* BLOCKS
=============================================================================*/
p, blockquote, ul, ol, dl, table, pre {
margin: 15px 0;
}
/* HEADERS
=============================================================================*/
h1, h2, h3, h4, h5, h6 {
margin: 20px 0 10px;
padding: 0;
font-weight: bold;
-webkit-font-smoothing: antialiased;
}
h1 tt, h1 code, h2 tt, h2 code, h3 tt, h3 code, h4 tt, h4 code, h5 tt, h5 code, h6 tt, h6 code {
font-size: inherit;
}
h1 {
font-size: 28px;
color: #000;
}
h2 {
font-size: 24px;
border-bottom: 1px solid #ccc;
color: #000;
}
h3 {
font-size: 18px;
}
h4 {
font-size: 16px;
}
h5 {
font-size: 14px;
}
h6 {
color: #777;
font-size: 14px;
}
body>h2:first-child, body>h1:first-child, body>h1:first-child+h2, body>h3:first-child, body>h4:first-child, body>h5:first-child, body>h6:first-child {
margin-top: 0;
padding-top: 0;
}
a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
margin-top: 0;
padding-top: 0;
}
h1+p, h2+p, h3+p, h4+p, h5+p, h6+p {
margin-top: 10px;
}
/* LINKS
=============================================================================*/
a {
color: #4183C4;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
/* LISTS
=============================================================================*/
ul, ol {
padding-left: 30px;
}
ul li > :first-child,
ol li > :first-child,
ul li ul:first-of-type,
ol li ol:first-of-type,
ul li ol:first-of-type,
ol li ul:first-of-type {
margin-top: 0px;
}
ul ul, ul ol, ol ol, ol ul {
margin-bottom: 0;
}
dl {
padding: 0;
}
dl dt {
font-size: 14px;
font-weight: bold;
font-style: italic;
padding: 0;
margin: 15px 0 5px;
}
dl dt:first-child {
padding: 0;
}
dl dt>:first-child {
margin-top: 0px;
}
dl dt>:last-child {
margin-bottom: 0px;
}
dl dd {
margin: 0 0 15px;
padding: 0 15px;
}
dl dd>:first-child {
margin-top: 0px;
}
dl dd>:last-child {
margin-bottom: 0px;
}
/* CODE
=============================================================================*/
pre, code, tt {
font-size: 12px;
font-family: Consolas, "Liberation Mono", Courier, monospace;
}
code, tt {
margin: 0 0px;
padding: 0px 0px;
white-space: nowrap;
border: 1px solid #eaeaea;
background-color: #f8f8f8;
border-radius: 3px;
}
pre>code {
margin: 0;
padding: 0;
white-space: pre;
border: none;
background: transparent;
}
pre {
background-color: #f8f8f8;
border: 1px solid #ccc;
font-size: 13px;
line-height: 19px;
overflow: auto;
padding: 6px 10px;
border-radius: 3px;
}
pre code, pre tt {
background-color: transparent;
border: none;
}
kbd {
-moz-border-bottom-colors: none;
-moz-border-left-colors: none;
-moz-border-right-colors: none;
-moz-border-top-colors: none;
background-color: #DDDDDD;
background-image: linear-gradient(#F1F1F1, #DDDDDD);
background-repeat: repeat-x;
border-color: #DDDDDD #CCCCCC #CCCCCC #DDDDDD;
border-image: none;
border-radius: 2px 2px 2px 2px;
border-style: solid;
border-width: 1px;
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
line-height: 10px;
padding: 1px 4px;
}
/* QUOTES
=============================================================================*/
blockquote {
border-left: 4px solid #DDD;
padding: 0 15px;
color: #777;
}
blockquote>:first-child {
margin-top: 0px;
}
blockquote>:last-child {
margin-bottom: 0px;
}
/* HORIZONTAL RULES
=============================================================================*/
hr {
clear: both;
margin: 15px 0;
height: 0px;
overflow: hidden;
border: none;
background: transparent;
border-bottom: 4px solid #ddd;
padding: 0;
}
/* TABLES
=============================================================================*/
table th {
font-weight: bold;
}
table th, table td {
border: 1px solid #ccc;
padding: 6px 13px;
}
table tr {
border-top: 1px solid #ccc;
background-color: #fff;
}
table tr:nth-child(2n) {
background-color: #f8f8f8;
}
/* IMAGES
=============================================================================*/
img {
max-width: 100%
}
</style>
</head>
<body>
<h1>Nest Manager (Unofficial)</h1>
<h5>IMPORTANT: <strong>There were a ton of changes to the core code so we can't guarantee that you will not have any issues when updating the code directly from v1.1. Once you update to code it is very important that you open the Nest Manager smart-app and press 'Done' to clean up old variables and switch to using the new Cron scheduler. If you have any issues after that I suggest you remove the old devices from any Apps, Routines, or Rules they are being used with, and then remove the Nest Manager smart-app and start over fresh.</strong></h5>
<h3>Nest Manager App</h3>
<p>This is the "<strong><em>unofficial</em></strong>" SmartThings user created SmartApp and Device handlers.
The SmartApp and Device Handlers work together to provide integration to the SmartThings ecosystem using Nest's Official API. </p>
<p><img src="https://raw.githubusercontent.com/tonesto7/nest-manager/master/Images/Screenshots/App/main_page_newInst.png" width="281" height="500"><img src="https://raw.githubusercontent.com/tonesto7/nest-manager/master/Images/Screenshots/App/main_page_1.png" width="281" height="500"></p>
<h3>Nest Automations App</h3>
<p>This is an addon Child-SmartApp that allows you to creat different types of automations for your HVAC systems.</p>
<p><img src="https://raw.githubusercontent.com/tonesto7/nest-manager/master/Images/Screenshots/App/AutomationApp/automation_start.png" width="281" height="500"></p>
<h3>The Devices Types</h3>
<p><img src="https://raw.githubusercontent.com/tonesto7/nest-manager/master/Images/Screenshots/ss_thermostat.PNG" width="281" height="500"><img src="https://raw.githubusercontent.com/tonesto7/nest-manager/master/Images/Screenshots/ss_thermostat2.PNG" width="281" height="500"><img src="https://raw.githubusercontent.com/tonesto7/nest-manager/master/Images/Screenshots/ss_protect.PNG" width="281" height="500"><img src="https://raw.githubusercontent.com/tonesto7/nest-manager/master/Images/Screenshots/ss_weather.png" width="281" height="500"><img src="https://raw.githubusercontent.com/tonesto7/nest-manager/master/Images/Screenshots/ss_weather2.png" width="281" height="500"><img src="https://raw.githubusercontent.com/tonesto7/nest-manager/master/Images/Screenshots/ss_nest_pres_dev.png" width="281" height="500"></p>
<h2>Author</h2>
<ul>
<li>@tonesto7</li>
</ul>
<h2>Contributors</h2>
<ul>
<li>@desertblade</li>
<li>@E_sch</li>
</ul>
<h2>Version Info</h2>
<p><strong>Latest App Version:</strong> </p>
<ul>
<li>Nest Manager - <strong><em>v2.0.8</em></strong></li>
<li>Nest Automations - <strong><em>v1.2.2</em></strong></li>
</ul>
<p><strong>Latest Device Versions:</strong></p>
<ul>
<li>Nest Presence Device - <strong><em>v2.0.2</em></strong></li>
<li>Nest Protect Device - <strong><em>v2.0.2</em></strong></li>
<li>Nest Thermostat Device - <strong><em>v2.0.3</em></strong></li>
<li>Nest Weather Device - <strong><em>v1.1.1</em></strong></li>
</ul>
<h2>What's New</h2>
<ul>
<li><strong>NEW</strong>: In-app HTML help pages</li>
<li><strong>NEW</strong>: All new polling logic (Also switched to Cron scheduling)</li>
<li><strong>NEW</strong>: Support for sending commands from multiple devices by using Queuing of commands to help prevent being rate-limited by Nest. (Thanks @E_sch)</li>
<li><strong>NEW</strong>: Custom device naming during new device installs. </li>
<li><strong>UPDATED</strong>:Fresh device tile designs :smile: (These may cause some controversy and be asked to be reverted back) (On first load of the device it may take a few seconds to render the tiles)</li>
<li><strong>NEW</strong>: Weather Device that will be updated with the rest of the devices so using a polling app to update the weather is no longer necessary. (Thanks @desertblade)</li>
<li><strong>NEW</strong>: Nest Automation Child (BETA) app as a place to turn thermostats off based on contacts open/closed, outside weather temps, and remote sensor support. </li>
<li>
<p><strong>UPDATED</strong>: Much more transparent error handling during the install process. The App will alert you in the app with a push notification and very clearly in the live logs in the IDE.<br />
It performs tests on the following:</p>
<ul>
<li>Verify's that OAuth is enabled for the SmartApp</li>
<li>The Device Handlers are installed and published</li>
<li>That your SmartThings account contains a proper Zip-Code.</li>
<li>When uninstalling it will notify you that it can't remove the devices because they are being used by other apps/routines.
</li>
</ul>
</li>
<li>
<p>There are also way to many subtle changes to list.</p>
</li>
</ul>
<h2>Links</h2>
<h4><a href="https://github.com/tonesto7/nest-manager/issues">GitHub Project Issues Link</a></h4>
<h4><a href="https://community.smartthings.com/t/release-nest-manager/">SmartThings Community Forum Link</a></h4>
<h4><a href="https://cdn.rawgit.com/tonesto7/nest-manager/master/Documents/help-page.html">Projects Help Page</a></h4>
<h4><a href="http://docs.smartthings.com/en/latest/tools-and-ide/github-integration.html">SmartThings IDE GitHub Integration Instructions</a></h4>
<h2>Things to Know</h2>
<ul>
<li><strong>This is still technically in still in post-BETA so you may experience issues!!!</strong></li>
<li>This app <strong><em>DOES NOT</em></strong> support Nest Cams <strong>currently</strong> mainly because I don't have any to test</li>
<li>Each install of this SmartApp will only support <strong>One</strong> location/structure and the Thermostats and Protects within</li>
<li>This version uses a new token which when we are ready to support it will allow access to Nest cams without needing to completely re-install everything. </li>
<li><em>The token used with this application is using my 'Works for Nest' distribution <em>appId</em> and <em>secret</em>. It's an older one which allows 1000 individual user logins before I will need to certify with Nest.</em>
<strong>I do not have the ability to see any of your data or who is even using the token</strong></li>
<li>
<p>Devices that use html tile will not refresh with going out of the device and back in again.</p>
</li>
<li>
<p><strong><em>There were a ton of changes to the core code so we can't guarantee there won't issue updating the code directly. Once you update it is important that you open the smart app and press done to clean up old variables and switch to the new Cron scheduler. If you have any issues after that I suggest you remove the old devices from any apps or routines they are under. Then remove the nest manager smartapp and start over.</em></strong></p>
</li>
</ul>
<h2>Advantages</h2>
<ul>
<li>Able to add/remove multiples devices from a single SmartApp</li>
<li>No need to many enter device serial number and login info in preferences</li>
<li>Nest Login info is not stored by the application</li>
<li>No need to use 3rd Party Polling apps for device updates</li>
<li>One single API call for all Nest devices</li>
<li>Since there is only a single poll for all devices, updates are more often</li>
<li>The devices look great :smile:</li>
</ul>
<h2>3rd-Party SmartApp Compatibility (Confirmed)</h2>
<ul>
<li><a href="https://community.smartthings.com/t/release-keenect-v1-2-0-optional-separate-vo-settings-for-cooling-vent-obstruction-auto-clear/39119">Keenect</a> @Mike_Maxwell </li>
<li><a href="http://smarttiles.click/">SmartTiles</a> @625alex </li>
<li><a href="https://community.smartthings.com/t/rule-machine-version-1-9-released/43204">Rule Machine (Rules and Custom Commands)</a> @bravenel </li>
<li>Keep Me Cozy (I & II) (link) </li>
<li>Routines</li>
</ul>
<h2>Installation</h2>
<h3>Method 1: (Recommended)</h3>
<p><em>Enabling the GitHub Integration in your IDE is by far the easiest way to install and get the latest updates for Nest Connect App, Presence, Protect and Thermostat devices.</em></p>
<p>If you don't already have Git Integration setup please visit <strong><em><a href="http://docs.smartthings.com/en/latest/tools-and-ide/github-integration.html">GitHub Integration Instructions</a></em></strong></p>
<h4>The Nest Manager and Nest Automations Apps</h4>
<ul>
<li>Go to "<strong>My SmartApps</strong>" in the IDE</li>
<li>Click on "<strong>Settings</strong>"</li>
<li>Click on "<strong>Add New Repository</strong>"</li>
<li>
<p>Owner: <strong>tonesto7</strong>, Name: <strong>nest-manager</strong>, Branch: <strong>master</strong></p>
<h5>Nest Manager</h5>
</li>
<li>
<p>Under "<strong>My SmartApps</strong>" Click on "<strong>Update from Repo</strong>" and select <strong><em>nest-manager (master)</em></strong> </p>
</li>
<li>Check the box next to <strong><em>nest-manager</em></strong> and then check "<strong>publish<strong>" then click "</strong>Execute Update</strong>"</li>
<li>
<p>Click on the <strong><em>Nest Manager</em></strong> app link and select "<strong>Publish<strong>" and "</strong>For me</strong>" </p>
<h5>Nest Automations</h5>
</li>
<li>
<p>Under "<strong>My SmartApps</strong>" Click on "<strong>Update from Repo</strong>" and select <strong><em>nest-manager (master)</em></strong> </p>
</li>
<li>Check the box next to <strong><em>nest-automations</em></strong> and then check "<strong>publish<strong>" then click "</strong>Execute Update</strong>"</li>
<li>
<p>Click on the <strong><em>Nest Automations</em></strong> app link and select "<strong>Publish<strong>" and "</strong>For me</strong>"</p>
<h3><em>You will also need to Enable OAuth under the Nest Manager app preferences in the IDE</em></h3>
</li>
</ul>
<h4>The Presence, Protect, Thermostat and Weather Device Handlers</h4>
<ul>
<li>Go to "<strong>My Device Handlers</strong>" in the IDE (Not necessary if you added repository for the app)</li>
<li>Click on "<strong>Settings</strong>"</li>
<li>Click on <strong>Add new repository</strong></li>
<li>Owner: <strong>tonesto7</strong>, Name: <strong>nest-manager</strong>, Branch: <strong>master</strong></li>
<li>Under My Device Types Click on <strong><em>Update from Repo</em></strong> and select the <strong><em>nest-manager</em></strong></li>
<li>Check the box next to <strong><em>nest-presence</em></strong>, <strong><em>nest-protect</em></strong>, <strong><em>nest-thermostat</em></strong>, and <strong><em>nest-weather</em></strong> then click <strong>Execute Update</strong></li>
<li>Click on each device link and select "<strong>Publish</strong> and <strong>For Me</strong></li>
</ul>
<p>That's it your Done in the IDE... Just install "<strong>Nest Manager</strong>" from the <strong><em>Marketplace > MyApps</em></strong> under the mobile app.</p>
<p>When updates are available to the source code you will see the color change from black in the IDE.</p>
<hr />
<h3>Method 2: The Manual Way</h3>
<h4>The Nest Manager App</h4>
<ul>
<li>Log into your SmartThings account at <a href="https://graph.api.smartthings.com/">https://graph.api.smartthings.com/</a></li>
<li>Go to "<strong>My SmartApps</strong>"</li>
<li>Click on "<strong>+ New SmartApp</strong>"</li>
<li>Choose "<strong>From Code</strong>"</li>
<li>Copy source code from <strong><em>nest-manager.src</em></strong></li>
<li>Click "<strong>Create</strong>"</li>
<li>Click on "<strong>Publish</strong>" and "<strong>For me</strong>" </li>
<li>Go into SmartApp <strong>Nest Manager</strong> Settings</li>
<li>Click on "<strong>App Settings</strong>" and <strong><em>enable OAuth</em></strong> and click "<strong>Update</strong>"</li>
</ul>
<h4>The Nest Automations App</h4>
<ul>
<li>Go to "<strong>My SmartApps</strong>"</li>
<li>Click on "<strong>+ New SmartApp</strong>"</li>
<li>Choose "<strong>From Code</strong>"</li>
<li>Copy source code from <strong><em>nest-automations.src</em></strong></li>
<li>Click "<strong>Create</strong>"</li>
<li>Click on "<strong>Publish</strong>" and "<strong>For me</strong>"</li>
</ul>
<h4>The Presence, Protect, and Thermostat Device Handlers</h4>
<ul>
<li>Go to "<strong>My Device Handlers</strong>"</li>
<li>Create "<strong>New Device Handler</strong>"</li>
<li>Choose "<strong>From Code</strong>"</li>
<li>Copy Source code from <em>nest-protect.src</em></li>
<li>Repeat for <strong><em>nest-presence.src</em></strong></li>
<li>Repeat for <strong><em>nest-thermostat.src</em></strong></li>
<li>Remember to open each device and click "<strong>Publish</strong>" and "<strong>For me</strong>"</li>
</ul>
<h4>Setting up Nest Manager App</h4>
<ul>
<li>In the SmartThings Mobile App</li>
<li>Go to "<strong>Marketplace</strong>" and select "<strong>SmartApps</strong>"</li>
<li>At the bottom of the list, select "<strong>My Apps</strong>"</li>
<li>Select "<strong>Nest Manager</strong>" from the list.</li>
<li>Enter you Nest Login credentials when prompted.</li>
<li>Choose <strong>Structure</strong></li>
<li>Choose <strong>Thermostats</strong></li>
<li>Choose <strong>Protects</strong></li>
<li>Choose <em>Add Presence Device</em> (Optional)</li>
<li>Choose <em>Add Weather Device</em> (Optional)</li>
<li>Modify any preferences you would like (Optional)</li>
<li>Tap on "<strong>Done</strong>"</li>
</ul>
<h2>Issues and Troubleshooting</h2>
<h3>Issues</h3>
<p><em>If you are experiencing any issues, please let us know by heading over to projects issues page on GitHub. If you don't see the issue reported please help open an new one and provide as much detail as you can.</em></p>
<p><strong><a href="https://github.com/tonesto7/st-nest-unofficial/issues">Project Issues Link</a></strong> </p>
<p>In an effort to make it easier for some of you troubleshoot without having to use the IDE constantly. I have added in a diagnostic option under the preference section of the SmartApp.<br />
Once this is enabled it will begin to store non-user identifiable error logs from the app and store in a local state variable of the app.<br />
This feature will help you to view and export the logs (<em>also see the tip below</em>) directly from the Smart App. This also allows you to copy & paste them into the issues form on GitHub.</p>
<p><strong>Tip:</strong> If you enable diagnostic logs in the app you can share the logs from with in the app you can store the direct link to log JSON file on you computer and browse directly to the log everytime you need to review the errors.</p>
<hr />
<h3>Troubleshooting</h3>
<p><strong>Tip:</strong> <em>The most common issue is forgetting to enable oAuth for the app under SmartThings</em></p>
<p>Please check the Help Page before posting questions in the community forum.
<strong><a href="https://cdn.rawgit.com/tonesto7/nest-manager/master/Documents/help-page.html">Nest Manager Help Page</a></strong></p>
<hr />
<h3>Feature Requests</h3>
<ul>
<li>We love new ideas so please head on over to github and open an issue for the feature you would like to see. This will help prioritize what is important and what is not.</li>
<li>There is a Google Form that will allow you to vote for the newest features. <strong><em><a href="https://docs.google.com/forms/d/1bkGy14QyjLedpM31CQ4t6m7UIbxbNH8PCUAdB_-EB08/viewform">Voting Form</a></em></strong></li>
</ul>
<hr />
<h3>Donations</h3>
<ul>
<li>While donations are very much appreciated they are not expected or required. If you feel the need to do so :smile: here is the <strong><em><a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=2CJEVN439EAWS">donation link</a></em></strong></li>
</ul>
<hr />
<h3>Nest API Documentation</h3>
<p><a href="https://developer.nest.com/documentation/cloud/get-started">Nest Developer Documents</a></p>
<p>To view the json returned from the API just get your authToken from the SmartApp state data and add it to this Url</p>
<p><em>https://developer-api.nest.com/devices?auth=<strong>yourAuthTokenHere</strong></em></p>
</body>
</html>
<!-- This document was created with MarkdownPad, the Markdown editor for Windows (http://markdownpad.com) -->