/
101-SmartThings.html
2455 lines (2299 loc) · 116 KB
/
101-SmartThings.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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!--
Copyright 2020 Samsung Automation Studio Team
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<style>
.md_pat{
display:flex;
align-items:center;
}
.md_pat__input{
width:65%;
}
.md_header{
text-align:right;
padding:10px 15px;
display:flex;
justify-content:space-between;
align-items:center;
background:#ebebeb;
}
.md_list{
min-height:30vh;
max-height:60vh;
overflow-y:scroll;
border: 1px solid #ddd;
/*border-radius: 5px;*/
padding: 5px;
}
.md_list__item{
padding:5px 5px 5px 10px;
cursor:pointer;
margin:5px 0px;
border-radius:10px;
display:none;
}
.md_list__location{
background:#ebebeb;
font-size:1rem;
}
.md_list__room{
background:#f7f7f7;
font-size:.9rem;
}
.md_list__device{
background:#ffffff;
font-size:.9rem;
font-weight:bold;
border:1px solid #aaaaaa;
}
.md_list__device__cmp{
padding-left:10px;
max-height:100px;
overflow-y:auto;
font-weight:bold;
}
.md_List__device__cps{
padding-left:20px;
font-weight:normal;
}
.md_list__item > input[type="checkbox"]{
margin:0px;
vertical-align:middle;
}
.md_list__item--close i{
transform: rotate(-90deg);
}
.md_list__item--close > div{
display:none;
}
.md_list__device.md_list__item--selected{
border:1px solid #3695dd;
}
.md_list__item--show{
display:block;
}
span.cp_type__option{
cursor:pointer;
margin-right:10px;
vertical-align: middle;
}
.node-input-label{
display:inline-block;
width:100px;
}
.dp_cp{
display:inline-block;
width:70%;
}
.dp_cp input,select{
width:100%;
}
.dp_cp :is(input,select){
width:90%;
}
.my_device__loation--close div{
display:none;
}
.my_Device__room--close div{
display:none;
}
.cp_type--standard .dp_cp__custom{
display:none;
}
.cp_type--custom .dp_cp__standard{
display:none;
}
.cp_type input[type="radio"]{
width:30px;
margin:0px;
}
.dp_cp_spec{
white-space: pre-wrap;
word-break: break-all;
max-height:50vh;
overflow:auto;
}
.st_state{
cursor:pointer;
display:inline-block;
margin:5px;
vertical-align:middle;
width:19px;
}
.st_state i{
vertical-align:middle;
}
.st_state svg{
width:26px;
height:26px;
transform:rotate(-90deg);
vertical-align:middle;
}
.st_state:not(.st_state--loading) svg,.st_state.st_state--loading i{
display:none;
}
.st_state.st_state--loading svg,.st_state:not(.st_state--loading) i{
display:inline-block;
font-size:1.3rem;
}
.st_state i{color:red;}
.st_state--valid i{color:green;}
circle.st_state__back{
stroke-width:3;
stroke:lightgray;
fill:none;
}
circle.st_state__front{
stroke-width:4;
stroke-dasharray:56;
stroke-dashoffset:0;
stroke-linecap:round;
fill:none;
stroke:lightgray;
}
.st_state--loading circle.st_state__front{
stroke: #3695dd;
animation: st_loading 2.5s infinite;
}
.st_state--valid circle.st_state__front{
stroke:green;
animation:none;
}
@keyframes st_loading{
0%,100% {stroke-dashoffset:0;}
50% {stroke-dashoffset:-56;}
50.01% {stroke-dashoffset:56;}
}
.optgroup--hide{
display:none;
}
.auto__copyurl{
display: inline-block;
position: relative;
width: 70%;
height: 20.0114px;
}
.auto__copyurl__url{
position: absolute;
left: 0px;
right: 40px;
}
.auto__copyurl__btn{
position: absolute;
right: 0px;
top: 0px;
}
.logging-options div{
cursor:pointer;
}
.logging-options label{
vertical-align:top;
}
.logging-options input{
width:auto;
margin:auto;
margin:0px 3px 0px 0px !important;
}
.cmd_arg_row{
height:auto;
margin:15px 5px 5px auto;
width:100%;
display:flex;
align-items:center;
justify-content:flex-end;
}
.device-item-capability{
color:#000;
}
.device-item-capability[spec='false']{
color:#999;
}
</style>
<script type="text/x-red" data-template-name="device-profile">
<div class="form-row">
<label for="node-input-name">Name</label>
<input type="text" id="node-input-name" placeholder="default, '{capabilty ID}'">
</div>
<div class="form-row" style="display:flex;align-items:center">
<span for="node-input-capabilityId" class="node-input-label" style="width:100px;">Capability</span>
<span class="dp_cp">
<div class="cp_type">
<span class="cp_type__option">
<input type="radio" name="cpType" value="standard" checked>Standard
</span>
<span class="cp_type__option">
<input type="radio" name="cpType" value="custom" >Custom
</span>
</div>
<span class="dp_cp__custom">
<input type="text" list="stAccessToken_datalist" id="node-input-stAccessToken" placeholder="SmartThings AccessToken">
<span class="st_state" title="refresh">
<svg>
<circle class="st_state__back" cx="13" cy="13" r="9"></circle>
<circle class="st_state__front" cx="13" cy="13" r="9"></circle>
</svg>
<i class="fa fa-check" aria-hidden="true" id="node-input-stAccessToken-valid"></i>
</span>
<select id="node-input-capabilityId_custom" data-cptype="custom">
</select>
</span>
<span class="dp_cp__standard">
<select id="node-input-capabilityId_standard" data-cptype="standard"></select>
</span>
</span>
</div>
<datalist id="stAccessToken_datalist"></datalist>
<div id="cp_spec__result" >
<span id="capabilities_refresh_result" style="padding:10px;"></span>
</div>
<pre class="dp_cp_spec"><code id="dp_cp_spec__code">select capability</code></pre>
</script>
<script type="text/x-red" data-help-name="device-profile">
<p>This node represents an installed device. In this flow, You need to choose a device for automation.</p>
<p>Event, Status and Command nodes need to know which devices will subscribe to the SmartThings Cloud or commands.</p>
<p>This node has a capability that represents device feature. You can find more information about <a href="https://smartthings.developer.samsung.com/docs/api-ref/capabilities.html" target="_blank">the Capabilities of SmartThings</a>.</p>
<h3>Properties</h3>
<dl class="message-properties">
<dt>Name</dt>
<dd>The label of the Name assigned by the user. It's unique name in flow.</dd>
<dt>Capability<span class="property-type">required</span></dt>
<dd>
<ul>
<li><b>'Standard'</b> Capability : Standard Capabilities are created and maintained by the SmartThings development team.</li>
<li><b>'Custom'</b> Capability : Custom capabilities are defined by the developer. A custom capability consists of a namespace and a capability name to uniquely identify it. 'device-profile' node get custom capability that is defined in your device using your SmartThings Personal AccessToken</li>
<li>The List of Capabilities provided by this Device.</li>
<li>Determine if this Device supports the specified capability name.</li>
</ul>
</dd>
</dl>
</script>
<script type="text/x-red" data-template-name="installed-device">
<div class="form-tips" style="margin-bottom:10px;"><b>Note:</b> create token on the SmartThings <b><a href="https://account.smartthings.com/tokens" target="_blank">personal access token page</a></b></div>
<div class="form-row">
<label for="node-input-name">Node Name</label>
<input type="text" id="node-input-name" placeholder="default, 'token:xxxxxxxx'">
</div>
<div class="form-row md_pat">
<label for="node-input-stAccessToken">Personal<br> Access Token</label>
<input type="text" class="md_pat__input" id="node-input-stAccessToken" list="stAccessToken_datalist" placeholder="SmartThings PAT">
<span class="st_state" title="refresh">
<svg>
<circle class="st_state__back" cx="13" cy="13" r="9"></circle>
<circle class="st_state__front" cx="13" cy="13" r="9"></circle>
</svg>
<i class="fa fa-check" aria-hidden="true" id="node-input-stAccessToken-valid"></i>
</span>
</div>
<div class="form-row"style="text-align:right">
<span id="my_device__result" style="padding:10px;"></span>
</div>
<div class="md_container">
<div class="md_header">
<span class="md_header__cnt">0 devices, 0 selected</span>
<input id="md_header__search" class="md_header__search" type="search" placeholder="Device Search">
</div>
<div id="md_list" class="md_list">
<!-- <div class="my_device__loation my_device__loation--close"></div>
<div class="my_device__room my_device__room--close"></div>
<div class="my_device__device my_device__device--close"></div> -->
</div>
</div>
<!-- <div class="my_device_list" class="form-row my_device_list">
</div> -->
<div id="my-device-list-div" class="form-row sensor-container-row">
<ol id="my-device-list-container"></ol>
</div>
<datalist id="stAccessToken_datalist"></datalist>
</script>
<script type="text/x-red" data-help-name="installed-device">
<p>This node represents an your SmartThings device. You can control your SmartThings devices directly without even registering the Automation.</p>
<p>To do this, you should set your PAT on this node and select one on your device list. Then, you can get a condition or put a command to your installed devices by using 'Status', 'Command' nodes.</p>
<p>After setting your PAT, get your device list and select device that you want to control.</p>
<h3>Getting a SmartThings PAT</h3>
<ul>
<li>SmartThings Authentication : <a href="https://smartthings.developer.samsung.com/docs/api-ref/st-api.html#section/Authentication">API Reference, Authentication</a></li>
<li>PATs can be created and managed on the <a href="https://account.smartthings.com/tokens">personal access token page</a>.</li>
</ul>
<h3>Properties</h3>
<dl class="message-properties">
<dt>Device Name<span class="property-type">read-only</span></dt>
<dd>The label of the Name assigned by the user. It's unique name in flow.</dd>
<dt>Device Label<span class="property-type">read-only</span></dt>
<dd> </dd>
<dt>Personal Access Token<span class="property-type">required</span></dt>
<dd></dd>
<dt>Device List</dt>
<dd>
<ul>
<li>The List of your device that .</li>
<li>Select device that you want to control, subscribe</li>
</ul>
</dd>
</dl>
</script>
<script type="text/x-red" data-template-name="automation">
<div class="form-row">
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input id="node-input-name" type="text" placeholder="Name"/>
</div>
<div class="form-row">
<label for="node-input-url"><i class="fa fa-cog"></i> Endpoint</label>
<input id="node-input-url" type="text" placeholder="/url"/>
</div>
<div class="form-row">
<label for="node-input-copyurl"></label>
<div class="auto__copyurl">
<div class="auto__copyurl__url">
<input type="text" id="node-input-copyurl" readonly="true" style="width:100%"/>
</div>
<a id="export-clipboard" class="editor-button auto__copyurl__btn">
<i class="fa fa-copy"></i>
</a>
</div>
</div>
<div class="logging-options">
<label><i class="fa fa-align-right"></i> Log</label>
<div>
<input id="node-input-loggingEditor" type="checkbox" value="true" >
<span class="logging-options__label" label_for="node-input-loggingEditor">Log to editor debug panel</span><br>
<input id="node-input-loggingConsole" type="checkbox" value="false">
<span class="logging-options__label" label_for="node-input-loggingConsole">Log to system console</span>
</div>
</div>
</script>
<script type="text/x-red" data-help-name="automation">
<p>This node represents the WebHook Endpoint of SmartApp. the Automation node handles lifecycle of SmartApp.</p>
<p>A WebHook endpoint in this context is a web services application which can receive incoming HTTP POST requests.</p>
<p></p>
<p><a href="https://smartthings.developer.samsung.com/docs/guides/smartapps/webhook-apps.html" target="_blank">more...</a></p>
<h3>Properties</h3>
<dl class="message-properties">
<dt>Name</dt>
<dd>A Name for the WebHook endpoint.</dd>
<dt>Endpoint <span class="property-type">required</span></dt>
<dd>A Endpoint that should be invoked during execution.</dd>
</dl>
<h3>Outputs</h3>
<dl class="message-properties">
<dt>[lifecyle] Event</dt>
<dd>Next node is the Event node only.</dd>
</dl>
</script>
<script type="text/x-red" data-template-name="event-device">
<div class="form-row" style="width:600px;">
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="default, '{deviceName}'" style="width:50%">
</div>
<div class="form-row">
<label for="node-input-name"><i class="fa fa-cog"></i> Device</label>
<select type="text" id="node-input-deviceId" style="width:50%"></select>
<span class="st_state" title="refresh">
<svg>
<circle class="st_state__back" cx="13" cy="13" r="9"></circle>
<circle class="st_state__front" cx="13" cy="13" r="9"></circle>
</svg>
</span>
</div>
<hr align="middle"/>
<div class="form-row">
<label for="node-input-capabilityId"><i class="fa fa-asterisk"></i> Capability</label>
<select id="node-input-capabilityId" style="width:50%;"></select>
</div>
<div class="form-row">
<label for="node-input-attributeId"><i class="fa fa-sun-o"></i> Attribute</label>
<select style="width:50%" id="node-input-attributeId"></select>
</div>
<div class="form-row sensor-container-row">
<ol id="attr-list-container"></ol>
</div>
<div class="logging-options">
<label><i class="fa fa-align-right"></i> Log</label>
<div>
<input id="node-input-logging" type="checkbox" value="false">
<span class="logging-options__label" label_for="node-input-logging">Log device response</span><br>
<input id="node-input-loggingEditor" type="checkbox" value="true">
<span class="logging-options__label" label_for="node-input-loggingEditor">Log to editor debug panel</span><br>
<input id="node-input-loggingConsole" type="checkbox" value="false">
<span class="logging-options__label" label_for="node-input-loggingConsole">Log to system console</span>
</div>
</div>
</script>
<script type="text/x-red" data-help-name="event-device">
<p>This node represents a change of device.</p>
<p>When a user installs a SmartApp, they typically will select the devices to be used by the SmartApp.</p>
<p>This event-device node interacts with installed SmartThings device. When the device changes and an event occurs, the event node can receive the event as a subscriber.</p>
<h3>Properties</h3>
<dl class="message-properties">
<dt>Name</dt>
<dd>The label of the Device assigned by the user.</dd>
<dt>Device </dt>
<dd>The unique system identifier for this Device.</dd>
<dt>Capability <span class="property-type">required</span></dt>
<dd>
<ul>
<li>The List of Capabilities provided by this Device.</li>
<li>Determine if this Device supports the specified capability name.</li>
</ul>
</dd>
<dt>Attribute</dt>
<dd>
<ul>
<li>The list of Attribute s for this Device.</li>
<li>Determine if this Device has the specified attribute.</li>
</ul>
</dd>
</dl>
</script>
<script type="text/x-red" data-template-name="status-device">
<div class="form-row" style="width:600px;">
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="default, '{deviceName}'" style="width:50%">
</div>
<div class="form-row">
<label for="node-input-name"><i class="fa fa-cog"></i> Device</label>
<select type="text" id="node-input-deviceId" style="width:50%"></select>
<span class="st_state" title="refresh">
<svg>
<circle class="st_state__back" cx="13" cy="13" r="9"></circle>
<circle class="st_state__front" cx="13" cy="13" r="9"></circle>
</svg>
</span>
</div>
<hr align="middle" />
<div class="form-row">
<label for="node-input-capabilityId" style="font-weight:bold"> Filter</label>
</div>
<div class="form-row">
<label for="node-input-capabilityId"><i class="fa fa-asterisk"></i> Capability</label>
<select id="node-input-capabilityId" style="width:50%;"></select>
</div>
<div class="form-row">
<label for="node-input-attributeId"> <i class="fa fa-sun-o"></i> Attribute</label>
<select style="width:50%" id="node-input-attributeId"></select>
</div>
<div class="form-row sensor-container-row">
<ol id="attr-list-container"></ol>
</div>
<div class="logging-options">
<label><i class="fa fa-align-right"></i> Log</label>
<div>
<input id="node-input-logging" type="checkbox" value="false">
<span class="logging-options__label" label_for="node-input-logging">Log device response</span><br>
<input id="node-input-loggingEditor" type="checkbox" value="true">
<span class="logging-options__label" label_for="node-input-loggingEditor">Log to editor debug panel</span><br>
<input id="node-input-loggingConsole" type="checkbox" value="false">
<span class="logging-options__label" label_for="node-input-loggingConsole">Log to system console</span>
</div>
</div>
</script>
<script type="text/x-red" data-help-name="status-device">
<p>This node checks the state of the device.</p>
<p>When a user installs a SmartApp, A user will select the devices to be used by the SmartApp.</p>
<p>This status-device node interact with the installed SmartThings device. This node allows you to branch flows based on the state of the device.</p>
<h3>Properties</h3>
<dl class="message-properties">
<dt>Name</dt>
<dd>The label of the Device assigned by the user.</dd>
<dt>Device </dt>
<dd>The unique system identifier for this Device.</dd>
<dt>Capability <span class="property-type">required</span></dt>
<dd>
<ul>
<li>The List of Capabilities provided by this Device.</li>
<li>Determine if this Device supports the specified capability name.</li>
</ul>
</dd>
<dt>Attribute</dt>
<dd>
<ul>
<li>The list of Attribute s for this Device.</li>
<li>Determine if this Device has the specified attribute.</li>
</ul>
</dd>
</dl>
</script>
<script type="text/x-red" data-template-name="command-device">
<div class="form-row">
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="default, '{attributeID}:{argValue}'" style="width:50%">
</div>
<div class="form-row">
<label for="node-input-name"><i class="fa fa-cog"></i> Device</label>
<select type="text" id="node-input-deviceId" style="width:50%"></select>
<span class="st_state" title="refresh">
<svg>
<circle class="st_state__back" cx="13" cy="13" r="9"></circle>
<circle class="st_state__front" cx="13" cy="13" r="9"></circle>
</svg>
</span>
</div>
<hr align="middle" />
<div class="form-row">
<label for="node-input-capabilityId"><i class="fa fa-asterisk"></i> Capability</label>
<select id="node-input-capabilityId" style="width:50%;"></select>
</div>
<div class="form-row">
<label for="node-input-attributeId"> <i class="fa fa-sun-o"></i> Command</label>
<select style="width:50%" id="node-input-attributeId"></select>
</div>
<div class="form-row actuator-container-row">
<ol id="cmd-list-container"></ol>
</div>
<div class="logging-options">
<label><i class="fa fa-align-right"></i> Log</label>
<div>
<input id="node-input-logging" type="checkbox" value="false">
<span class="logging-options__label" label_for="node-input-logging">Log device response</span><br>
<input id="node-input-loggingEditor" type="checkbox" value="true">
<span class="logging-options__label" label_for="node-input-loggingEditor">Log to editor debug panel</span><br>
<input id="node-input-loggingConsole" type="checkbox" value="false">
<span class="logging-options__label" label_for="node-input-loggingConsole">Log to system console</span>
</div>
</div>
</script>
<script type="text/x-red" data-help-name="command-device">
<p>This node can command to the device.</p>
<p>When a user installs a SmartApp, A user will select the devices to be used by the SmartApp.</p>
<p>This command-device node interact with the installed SmartThings device. As commands you set, this node changes the state of the device.</p>
<h3>Properties</h3>
<dl class="message-properties">
<dt>Name</dt>
<dd>The label of the Device assigned by the user.</dd>
<dt>Device </dt>
<dd>The unique system identifier for this Device.</dd>
<dt>Capability <span class="property-type">required</span></dt>
<dd>
<ul>
<li>The List of Capabilities provided by this Device.</li>
<li>Determine if this Device supports the specified capability name.</li>
</ul>
</dd>
<dt>Command</dt>
<dd>
<ul>
<li>The list of Commands for this Device.</li>
<li>Determine if this Device has the specified command name.</li>
</ul>
</dd>
</dl>
</script>
<script type="text/javascript">
(function () {
// const SmartThingsProfile = new _SmartThingsProfile();
// SmartThingsProfile.loadMydeviceInfo()
// .then(SmartThingsProfile.setMyDeviceInfos)
// .catch(e=>{console.warn('load mydevice info fail : ',e.message||e)})
// .then(SmartThingsProfile.loadRuntimeCapabilities)
// .then(SmartThingsProfile.setCapabilities)
// .catch(e=>{console.warn('load capabilities fail : ',e.message||e)})
})();
</script>
<script type="text/javascript">
(function () {
const ST_NODES_CATEGORY = "Samsung AutomationStudio"
const ST_EVENT_DEVICE = "event-device";
const ST_STATUS_DEVICE = "status-device";
const ST_COMMAND_DEVICE = "command-device";
const ST_DEVICE_PROFILE = 'device-profile';
const ST_MY_DEVICE = 'installed-device';
const ST_AUTOMATION = 'automation';
const ST_DEVICE_NODES = [ST_EVENT_DEVICE, ST_STATUS_DEVICE, ST_COMMAND_DEVICE]
const ST_NODES = [ST_AUTOMATION, ST_DEVICE_PROFILE, ST_MY_DEVICE, ST_EVENT_DEVICE, ST_STATUS_DEVICE, ST_COMMAND_DEVICE];
const SmartThingsProfile = new _SmartThingsProfile();
function _SmartThingsProfile() {
var _capabilities = {}
const SmartThingsApi = {
getLocations: function (token) {
return new Promise((resolve, reject) => {
$.ajax({
url: "https://api.smartthings.com/v1/locations",
headers: {
Authorization: 'Bearer ' + token
}
}).then(resolve, reject)
});
},
getLocationsRooms: function (token, locationId) {
return new Promise((resolve, reject) => {
$.ajax({
url: "https://api.smartthings.com/v1/locations/" + locationId + "/rooms", headers: {
Authorization: 'Bearer ' + token
}
}).then(resolve, reject)
});
},
getDevices: function (token) {
return new Promise((resolve, reject) => {
$.ajax({
url: "https://api.smartthings.com/v1/devices", headers: {
Authorization: 'Bearer ' + token
}
}).then(resolve, reject)
})
},
getDeviceList: function (token, done, fail) {
return $.ajax({
url: "https://api.smartthings.com/v1/devices",
headers: {
Authorization: 'Bearer ' + token
}
}).done(function (result, textStatus, xhr) {
if (result.hasOwnProperty('items') && Array.isArray(result.items)) {
result.items.forEach(device => {
device.capabilities = []
device.components.forEach(function (component) {
component.capabilities.forEach(function (cp) {
cp['vid'] = cp.id + '_v' + cp.version;
cp['vname'] = cp.version === 1 ? cp.name : cp.name + ' v' + cp.version;
device.capabilities.push(cp)
if (SmartThingsProfile.hasCapability(cp.vid) === false) {
var pr = SmartThingsApi.getCapability(token, cp.id, cp.version)
.then(spec => {
// cp['spec']=true
/*NPM SOURCE*/
Object.assign(cp, spec)
$('#my-device-list-container span.device-item-capability').attr('spec', 'true')
}).fail(err => {
console.error(err)
$('#my-device-list-container span.device-item-capability').attr('spec', 'false')
})
}
})
})
delete device['components']
delete device['dth']
delete device['deviceNetworkType']
delete device['locationsId']
})
}
done(result.items);
}).fail(function (e) {
fail(e);
});
},
getCapability: function (token, capabilityId, capabilityVersion, done, fail) {
return new Promise((resolve, reject) => {
$.ajax({
url: 'https://api.smartthings.com/v1/capabilities/' + capabilityId + '/' + capabilityVersion,
headers: {
Authorization: 'Bearer ' + token
}
}).then(resolve, reject)
}).then((cp) => {
cp['vid'] = cp.id + '_v' + cp.version //vid : id + version
cp['vname'] = (cp.version === 1 ? cp.name : cp.name + ' v' + cp.version)// vname : name + version
cp['_spec'] = true
SmartThingsProfile.addCapability(cp)
return cp;
})
}
}
const runtimeAPI = {
getPat: function (nodeType, nodeID) {
const dashedType = nodeType.replace(/\s+/g, '-');
const credentialUrl = 'credentials/' + dashedType + "/" + nodeID;
return new Promise((resolve, reject) => {
$.getJSON(getCredentialsURL(nodeType, nodeID)).then((data) => {
const pat = (data && data.stAccessToken) ? data.stAccessToken : null;
resolve(pat);
}, reject)
})
}
}
this.getAttributeSchema = function (capabilityId, attributeId) {
if (_capabilities[capabilityId] && _capabilities[capabilityId].attributes && _capabilities[capabilityId].attributes[attributeId]) {
return _capabilities[capabilityId].attributes[attributeId].schema || {};
} else {
return {};
}
}
this.getCommandArguments = function (capabilityId, commandId) {
if (_capabilities[capabilityId] && _capabilities[capabilityId].commands && _capabilities[capabilityId].commands[commandId]) {
return _capabilities[capabilityId].commands[commandId].arguments || []
} else {
return []
}
}
this.getCapability = function (vid, version) {
if (version) {
vid = vid + '_v' + version;
}
if (vid && vid.indexOf('_v') === -1) {
vid += '_v1';
}
return _capabilities[vid] || null;
}
this.hasCapability = function (vid) {
if (vid && vid.indexOf('_v') === -1) {
vid += '_v1'
}
return !!_capabilities[vid]
}
this.getAllCapabilities = function () {
return _capabilities;
}
this.setCapabilities = function (capabilities) {
_capabilities = capabilities;
}
this.addCapabilities = function (cparr) {
cparr.forEach(cp => {
if (!cp.hasOwnProperty('vid')) {
cp.vid = `${cp.id}_v${cp.version}`;
}
this.addCapability(cp);
})
}
this.addCapability = function (cp) {
if (!cp.hasOwnProperty('id') || !cp.hasOwnProperty('version')) {
return;
}
_capabilities[cp.vid] = cp;
}
function callMyDeviceApi(path) {
return new Promise((resolve, reject) => {
let root = RED.settings.httpNodeRoot || '';
root = root.trim().replace(/^\/*/, '');
if (/[^\/]$/.test(root)) { root += '/'; }
$.ajax({ url: root + path, type: "GET", dataType: 'json' }).then(resolve, reject);
})
}
this.loadRuntimeCapabilities = () => callMyDeviceApi('_smartthings/capabilities');
this.loadMydeviceInfo = () => callMyDeviceApi('_smartthings/mydevices');
let _mydevices = {};
this.validatePat = function (pat) {
return SmartThingsApi.getCapability(pat, 'switch', 1);
}
this.addPersonalToken = function (nodeId, pat, isRefresh) {
if (!pat) {
_mydevices[nodeId] = Promise.resolve(null);
return Promise.resolve(null);
}
if (!_mydevices[nodeId] || isRefresh) {
return this.validatePat(pat).then(() => {
const PAT = {};
const getLocationsPR = SmartThingsApi.getLocations(pat)
.then(locationsResult => {
return Promise.allSettled(locationsResult.items
.sort((l1, l2) => l1.name.localeCompare(l2.name))
.map(location => {
return SmartThingsApi.getLocationsRooms(pat, location.locationId)
.then(roomsResult => {
location.rooms = roomsResult.items;
location.rooms.sort((r1, r2) => r1.name.localeCompare(r2.name))
location.rooms.push({ locationId: location.locationId, roomId: 'undefined', name: "'undefined'" });
})
}))
.then(() => locationsResult.items)
})
.then(locations => {
PAT.locations = locations;
return locations;
})
const getDevicesPR = SmartThingsApi.getDevices(pat)
.then(devicesResult => {
return devicesResult.items
.map(d => {
return {
deviceId: d.deviceId,
name: d.label || d.name,
locationId: d.locationId,
roomId: d.roomId,
components: d.components
}
})
}).then(devices => {
PAT.devices = devices;
PAT.customCps = PAT.devices.map(d => d.components).flat()
.map(cmp => cmp.capabilities).flat()
.map(cp => cp.id + '_v' + cp.version)
.filter(cpId => /\./.test(cpId))//only custom capabilities
.filter((cpId, idx, arr) => arr.indexOf(cpId) == idx)//remove duplicate items
.sort();
return devices;
});
const getUnknownCapabilities = getDevicesPR
.then(devices => {
var prs = devices.map(d => d.components).flat()
.map(cmp => cmp.capabilities).flat()
.filter(cp => !SmartThingsProfile.getCapability(cp.id + '_v' + cp.version))
.map(cp => SmartThingsApi.getCapability(pat, cp.id, cp.version))
return Promise.allSettled(prs);
});
const addPATPromise = Promise.allSettled([getLocationsPR, getDevicesPR, getUnknownCapabilities])
.then(result => {
if (PAT.devices) {
_mydevices[nodeId] = Promise.resolve(PAT);
} else {
_mydevices[nodeId] = Promise.resolve(null);
}
return _mydevices[nodeId];
});
_mydevices[nodeId] = addPATPromise;
return addPATPromise;
}).catch(e => {
console.log('validate SmartThings AccessToken fail : ' + e.statusText);
_mydevices[nodeId] = Promise.resolve(null);
return Promise.reject(null);
})
} else if (_mydevices[nodeId]) {
return _mydevices[nodeId];
}
}
this.getMyDevices = (nodeId) => {
if (_mydevices[nodeId]) {
return _mydevices[nodeId];
} else {
return Promise.resolve(null);
}
}
this.setMyDeviceInfos = (mydevices) => {
Object.keys(mydevices).forEach(mydeviceId => {
_mydevices[mydeviceId] = Promise.resolve(mydevices[mydeviceId]);
})
}
}
SmartThingsProfile.loadMydeviceInfo()
.then(SmartThingsProfile.setMyDeviceInfos)
.catch(e => { console.warn('load mydevice info fail : ', e.message || e) })
.then(SmartThingsProfile.loadRuntimeCapabilities)
.then(SmartThingsProfile.setCapabilities)
.catch(e => { console.warn('load capabilities fail : ', e.message || e) })
function STRefCheck() {
//import, broken reference fix
const workspaceId = RED.workspaces.active();
var hasBrokenRef = RED.nodes.filterNodes({ z: workspaceId })
.filter(n => ST_NODES.includes(n.type) && n._def?.defaults?.hasOwnProperty('profileId'))
.some(n => n.id != n.profileId);
if (hasBrokenRef) {
var map = {}
RED.nodes.filterNodes({ z: workspaceId })
.filter(n => ST_NODES.includes(n.type) && n._def?.defaults?.hasOwnProperty('profileId'))
.forEach(n => {
if (!n.profileId) {
n.profileId = n.id;
}
if (map.hasOwnProperty(n.profileId)) {
n.profileId = n.id;
} else {
map[n.profileId] = n;
}
})
RED.nodes.filterNodes({ z: workspaceId })
.filter(n => ST_DEVICE_NODES.includes(n.type) && map.hasOwnProperty(n.deviceNodeId))
.forEach(function (n) {
n.deviceNodeId = map[n.deviceNodeId].id;
RED.editor.validateNode(n);
})
for (var profId in map) {
map[profId].profileId = map[profId].id;
}
RED.view.redraw();
}
RED.nodes.filterNodes({ z: RED.workspaces.active(), type: ST_MY_DEVICE })
.filter(n => n.device && !n.devices)
.forEach(n => n.devices = [n.device.deviceId]);
RED.nodes.filterNodes({ z: workspaceId })
.filter(n => ST_DEVICE_NODES.includes(n.type))
.filter(n => n.deviceNodeId && !n.deviceId && RED.nodes.node(n.deviceNodeId))
.forEach(n => {
const deviceNode = RED.nodes.node(n.deviceNodeId);
if (deviceNode.type === ST_DEVICE_PROFILE) {
n.deviceId = n.deviceNodeId;
} else if (deviceNode.type === ST_MY_DEVICE) {
n.deviceId = deviceNode.device?.deviceId || (deviceNode.devices?.lenght == 1 ? deviceNode.devices[0] : '');
}
});
}
function patChangeEventDP(mydevice, initValue) {
const cpCustomEl = document.querySelector('#node-input-capabilityId_custom');
const stStateEL = document.querySelector('.st_state');
stStateEL.classList.remove('st_state--loading');
if (mydevice) {
stStateEL.classList.add('st_state--valid');
cpCustomEl.disabled = false;
cpCustomEl.innerHTML = '';
mydevice.customCps
.map(cpId => cpId.slice(0, cpId.indexOf('.')))
.filter((namespace, idx, arr) => arr.indexOf(namespace) === idx)
.sort()
.forEach(namespace => {
const optgroup = document.createElement('optgroup');
optgroup.label = namespace;
cpCustomEl.append(optgroup);
})
mydevice.customCps
.forEach(cpId => {
const option = document.createElement('option');
option.value = cpId;
const tempId = cpId.split('_v')[0];
const tempVersion = cpId.split('_v')[1];
option.innerText = (tempVersion == 1) ? tempId : cpId;
const namespace = cpId.slice(0, cpId.indexOf('.'));
const optgroup = cpCustomEl.querySelector(`optgroup[label="${namespace}"]`);
optgroup.append(option);
})
if (initValue) {
cpCustomEl.value = initValue;
cpCustomEl.dispatchEvent(new Event('change'));
}
} else {
stStateEL.classList.remove('st_state--valid');
cpCustomEl.disabled = true;
cpCustomEl.innerHTML = '';
}
}
RED.nodes.registerType('device-profile', {
category: ST_NODES_CATEGORY,
paletteLabel: "Device Profile",
color: "rgb(168,168,168)",
defaults: {
name: { value: "" },
alias: { value: "" },//'name' is null, set automatically with properties;
capabilityId: { value: "", required: true },
profileId: { value: "" },