classhueplusplus_1_1_base_device.html
46.3 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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hueplusplus: hueplusplus::BaseDevice Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">hueplusplus
 <span id="projectnumber">1.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacehueplusplus.html">hueplusplus</a></li><li class="navelem"><a class="el" href="classhueplusplus_1_1_base_device.html">BaseDevice</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classhueplusplus_1_1_base_device-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::BaseDevice Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for physical devices connected to the bridge (sensor or light).
<a href="classhueplusplus_1_1_base_device.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_base_device_8h_source.html">hueplusplus/BaseDevice.h</a>></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for hueplusplus::BaseDevice:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classhueplusplus_1_1_base_device__inherit__graph.png" border="0" usemap="#hueplusplus_1_1_base_device_inherit__map" alt="Inheritance graph"/></div>
<map name="hueplusplus_1_1_base_device_inherit__map" id="hueplusplus_1_1_base_device_inherit__map">
<area shape="rect" id="node2" href="classhueplusplus_1_1_light.html" title="Class for Hue Light fixtures. " alt="" coords="248,133,388,159"/>
<area shape="rect" id="node3" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. " alt="" coords="242,183,394,210"/>
<area shape="rect" id="node4" href="classhueplusplus_1_1sensors_1_1_base_c_l_i_p.html" title="Common methods for CLIP sensors. " alt="" coords="239,235,397,276"/>
<area shape="rect" id="node13" href="classhueplusplus_1_1sensors_1_1_daylight_sensor.html" title="Daylight sensor to detect sunrise and sunset. " alt="" coords="239,300,397,341"/>
<area shape="rect" id="node14" href="classhueplusplus_1_1sensors_1_1_z_g_p_switch.html" title="ZigBee Green Power sensor for button presses. " alt="" coords="239,365,397,407"/>
<area shape="rect" id="node15" href="classhueplusplus_1_1sensors_1_1_z_l_l_light_level.html" title="ZigBee sensor detecting ambient light level. " alt="" coords="239,431,397,472"/>
<area shape="rect" id="node16" href="classhueplusplus_1_1sensors_1_1_z_l_l_presence.html" title="Sensor detecting presence in the vicinity. " alt="" coords="239,496,397,537"/>
<area shape="rect" id="node17" href="classhueplusplus_1_1sensors_1_1_z_l_l_switch.html" title="ZigBee sensor reporting button presses. " alt="" coords="239,561,397,603"/>
<area shape="rect" id="node18" href="classhueplusplus_1_1sensors_1_1_z_l_l_temperature.html" title="ZigBee temperature sensor. " alt="" coords="239,627,397,668"/>
<area shape="rect" id="node5" href="classhueplusplus_1_1sensors_1_1_c_l_i_p_generic_flag.html" title="CLIP sensor for a generic 3rd party sensor. " alt="" coords="445,5,604,47"/>
<area shape="rect" id="node6" href="classhueplusplus_1_1sensors_1_1_c_l_i_p_generic_status.html" title="CLIP sensor for a generic 3rd party status. " alt="" coords="445,71,604,112"/>
<area shape="rect" id="node7" href="classhueplusplus_1_1sensors_1_1_c_l_i_p_humidity.html" title="CLIP sensor for humidity. " alt="" coords="445,136,604,177"/>
<area shape="rect" id="node8" href="classhueplusplus_1_1sensors_1_1_c_l_i_p_light_level.html" title="CLIP sensor for light level. " alt="" coords="445,201,604,243"/>
<area shape="rect" id="node9" href="classhueplusplus_1_1sensors_1_1_c_l_i_p_open_close.html" title="CLIP sensor detecting whether a contact is open or closed. " alt="" coords="445,267,604,308"/>
<area shape="rect" id="node10" href="classhueplusplus_1_1sensors_1_1_c_l_i_p_presence.html" title="CLIP sensor to detect presence. " alt="" coords="445,332,604,373"/>
<area shape="rect" id="node11" href="classhueplusplus_1_1sensors_1_1_c_l_i_p_switch.html" title="CLIP sensor for button presses. " alt="" coords="445,397,604,439"/>
<area shape="rect" id="node12" href="classhueplusplus_1_1sensors_1_1_c_l_i_p_temperature.html" title="CLIP sensor for temperature. " alt="" coords="445,463,604,504"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for hueplusplus::BaseDevice:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classhueplusplus_1_1_base_device__coll__graph.png" border="0" usemap="#hueplusplus_1_1_base_device_coll__map" alt="Collaboration graph"/></div>
<map name="hueplusplus_1_1_base_device_coll__map" id="hueplusplus_1_1_base_device_coll__map">
<area shape="rect" id="node2" href="classhueplusplus_1_1_a_p_i_cache.html" title="Caches API GET requests and refreshes regularly. " alt="" coords="13,5,183,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab08c354ca3eef24240f98267df4ae01a"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#ab08c354ca3eef24240f98267df4ae01a">~BaseDevice</a> ()=default</td></tr>
<tr class="memdesc:ab08c354ca3eef24240f98267df4ae01a"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#ab08c354ca3eef24240f98267df4ae01a">More...</a><br /></td></tr>
<tr class="separator:ab08c354ca3eef24240f98267df4ae01a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21122992819e6155867c02578773d0cd"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#a21122992819e6155867c02578773d0cd">getId</a> () const</td></tr>
<tr class="memdesc:a21122992819e6155867c02578773d0cd"><td class="mdescLeft"> </td><td class="mdescRight">Const function that returns the id of this device. <a href="#a21122992819e6155867c02578773d0cd">More...</a><br /></td></tr>
<tr class="separator:a21122992819e6155867c02578773d0cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6741ba9ec72108ca0101d41c0b02c568"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#a6741ba9ec72108ca0101d41c0b02c568">getType</a> () const</td></tr>
<tr class="memdesc:a6741ba9ec72108ca0101d41c0b02c568"><td class="mdescLeft"> </td><td class="mdescRight">Const function that returns the device type. <a href="#a6741ba9ec72108ca0101d41c0b02c568">More...</a><br /></td></tr>
<tr class="separator:a6741ba9ec72108ca0101d41c0b02c568"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5331ce38f4e6c9def7bafc23112ccd34"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#a5331ce38f4e6c9def7bafc23112ccd34">getName</a> ()</td></tr>
<tr class="memdesc:a5331ce38f4e6c9def7bafc23112ccd34"><td class="mdescLeft"> </td><td class="mdescRight">Function that returns the name of the device. <a href="#a5331ce38f4e6c9def7bafc23112ccd34">More...</a><br /></td></tr>
<tr class="separator:a5331ce38f4e6c9def7bafc23112ccd34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a095f4467a072fee3091402e7ed31a6fe"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#a095f4467a072fee3091402e7ed31a6fe">getName</a> () const</td></tr>
<tr class="memdesc:a095f4467a072fee3091402e7ed31a6fe"><td class="mdescLeft"> </td><td class="mdescRight">Const function that returns the name of the device. <a href="#a095f4467a072fee3091402e7ed31a6fe">More...</a><br /></td></tr>
<tr class="separator:a095f4467a072fee3091402e7ed31a6fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7572be90ab966033ad8b9c7e83598ce"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#aa7572be90ab966033ad8b9c7e83598ce">getModelId</a> () const</td></tr>
<tr class="memdesc:aa7572be90ab966033ad8b9c7e83598ce"><td class="mdescLeft"> </td><td class="mdescRight">Const function that returns the modelid of the device. <a href="#aa7572be90ab966033ad8b9c7e83598ce">More...</a><br /></td></tr>
<tr class="separator:aa7572be90ab966033ad8b9c7e83598ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a821dc52df6472b2604f56579dac4ac04"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#a821dc52df6472b2604f56579dac4ac04">getUId</a> () const</td></tr>
<tr class="memdesc:a821dc52df6472b2604f56579dac4ac04"><td class="mdescLeft"> </td><td class="mdescRight">Const function that returns the uniqueid of the device. <a href="#a821dc52df6472b2604f56579dac4ac04">More...</a><br /></td></tr>
<tr class="separator:a821dc52df6472b2604f56579dac4ac04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6e1af663e4f14afc6293aacdd5130c0"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#ad6e1af663e4f14afc6293aacdd5130c0">getManufacturername</a> () const</td></tr>
<tr class="memdesc:ad6e1af663e4f14afc6293aacdd5130c0"><td class="mdescLeft"> </td><td class="mdescRight">Const function that returns the manufacturername of the device. <a href="#ad6e1af663e4f14afc6293aacdd5130c0">More...</a><br /></td></tr>
<tr class="separator:ad6e1af663e4f14afc6293aacdd5130c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53f675db31058c574fbf55baea8bd556"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#a53f675db31058c574fbf55baea8bd556">getProductname</a> () const</td></tr>
<tr class="memdesc:a53f675db31058c574fbf55baea8bd556"><td class="mdescLeft"> </td><td class="mdescRight">Const function that returns the productname of the device. <a href="#a53f675db31058c574fbf55baea8bd556">More...</a><br /></td></tr>
<tr class="separator:a53f675db31058c574fbf55baea8bd556"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebc5484b45b833491385a5381e3234bb"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#aebc5484b45b833491385a5381e3234bb">getSwVersion</a> ()</td></tr>
<tr class="memdesc:aebc5484b45b833491385a5381e3234bb"><td class="mdescLeft"> </td><td class="mdescRight">Function that returns the software version of the device. <a href="#aebc5484b45b833491385a5381e3234bb">More...</a><br /></td></tr>
<tr class="separator:aebc5484b45b833491385a5381e3234bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a136cdba60a6781c15c6869ddcc7f2e1a"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#a136cdba60a6781c15c6869ddcc7f2e1a">getSwVersion</a> () const</td></tr>
<tr class="memdesc:a136cdba60a6781c15c6869ddcc7f2e1a"><td class="mdescLeft"> </td><td class="mdescRight">Const function that returns the software version of the device. <a href="#a136cdba60a6781c15c6869ddcc7f2e1a">More...</a><br /></td></tr>
<tr class="separator:a136cdba60a6781c15c6869ddcc7f2e1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7554114eee573ab784c44d53f439028"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#ab7554114eee573ab784c44d53f439028">setName</a> (const std::string &name)</td></tr>
<tr class="memdesc:ab7554114eee573ab784c44d53f439028"><td class="mdescLeft"> </td><td class="mdescRight">Function that sets the name of the device. <a href="#ab7554114eee573ab784c44d53f439028">More...</a><br /></td></tr>
<tr class="separator:ab7554114eee573ab784c44d53f439028"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6ac28ae3879a41ace1cd6806ca9a2f1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#aa6ac28ae3879a41ace1cd6806ca9a2f1">refresh</a> (bool force=false)</td></tr>
<tr class="memdesc:aa6ac28ae3879a41ace1cd6806ca9a2f1"><td class="mdescLeft"> </td><td class="mdescRight">Refreshes internal cached state. <a href="#aa6ac28ae3879a41ace1cd6806ca9a2f1">More...</a><br /></td></tr>
<tr class="separator:aa6ac28ae3879a41ace1cd6806ca9a2f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5dd630da2c99842700d555788c0b75b1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#a5dd630da2c99842700d555788c0b75b1">setRefreshDuration</a> (std::chrono::steady_clock::duration refreshDuration)</td></tr>
<tr class="memdesc:a5dd630da2c99842700d555788c0b75b1"><td class="mdescLeft"> </td><td class="mdescRight">Sets custom refresh interval for this device. <a href="#a5dd630da2c99842700d555788c0b75b1">More...</a><br /></td></tr>
<tr class="separator:a5dd630da2c99842700d555788c0b75b1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a48bf88e758fd7191c599a46751755c97"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#a48bf88e758fd7191c599a46751755c97">BaseDevice</a> (int <a class="el" href="classhueplusplus_1_1_base_device.html#aa65a31223cfa2a054c28148c35c8b3cf">id</a>, const std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > &baseCache)</td></tr>
<tr class="memdesc:a48bf88e758fd7191c599a46751755c97"><td class="mdescLeft"> </td><td class="mdescRight">Protected ctor that is used by subclasses, construct with shared cache. <a href="#a48bf88e758fd7191c599a46751755c97">More...</a><br /></td></tr>
<tr class="separator:a48bf88e758fd7191c599a46751755c97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa90386c0cea99464dee6bedb2c68254"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#aaa90386c0cea99464dee6bedb2c68254">BaseDevice</a> (int <a class="el" href="classhueplusplus_1_1_base_device.html#aa65a31223cfa2a054c28148c35c8b3cf">id</a>, const <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> &commands, const std::string &path, std::chrono::steady_clock::duration refreshDuration, const nlohmann::json &currentState)</td></tr>
<tr class="memdesc:aaa90386c0cea99464dee6bedb2c68254"><td class="mdescLeft"> </td><td class="mdescRight">Protected ctor that is used by subclasses. <a href="#aaa90386c0cea99464dee6bedb2c68254">More...</a><br /></td></tr>
<tr class="separator:aaa90386c0cea99464dee6bedb2c68254"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8089e8f00d426427ed2fc7f6b817082"><td class="memItemLeft" align="right" valign="top">virtual nlohmann::json </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#ac8089e8f00d426427ed2fc7f6b817082">sendPutRequest</a> (const std::string &subPath, const nlohmann::json &request, <a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> fileInfo)</td></tr>
<tr class="memdesc:ac8089e8f00d426427ed2fc7f6b817082"><td class="mdescLeft"> </td><td class="mdescRight">Utility function to send a put request to the device. <a href="#ac8089e8f00d426427ed2fc7f6b817082">More...</a><br /></td></tr>
<tr class="separator:ac8089e8f00d426427ed2fc7f6b817082"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:aa65a31223cfa2a054c28148c35c8b3cf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#aa65a31223cfa2a054c28148c35c8b3cf">id</a></td></tr>
<tr class="memdesc:aa65a31223cfa2a054c28148c35c8b3cf"><td class="mdescLeft"> </td><td class="mdescRight">holds the id of the device <a href="#aa65a31223cfa2a054c28148c35c8b3cf">More...</a><br /></td></tr>
<tr class="separator:aa65a31223cfa2a054c28148c35c8b3cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a526b63fa6eb1c9dc9a7b1926ad0be27a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_base_device.html#a526b63fa6eb1c9dc9a7b1926ad0be27a">state</a></td></tr>
<tr class="memdesc:a526b63fa6eb1c9dc9a7b1926ad0be27a"><td class="mdescLeft"> </td><td class="mdescRight">holds the current state of the device <a href="#a526b63fa6eb1c9dc9a7b1926ad0be27a">More...</a><br /></td></tr>
<tr class="separator:a526b63fa6eb1c9dc9a7b1926ad0be27a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for physical devices connected to the bridge (sensor or light). </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab08c354ca3eef24240f98267df4ae01a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab08c354ca3eef24240f98267df4ae01a">◆ </a></span>~BaseDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual hueplusplus::BaseDevice::~BaseDevice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor. </p>
</div>
</div>
<a id="a48bf88e758fd7191c599a46751755c97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48bf88e758fd7191c599a46751755c97">◆ </a></span>BaseDevice() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">hueplusplus::BaseDevice::BaseDevice </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::shared_ptr< <a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> > & </td>
<td class="paramname"><em>baseCache</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Protected ctor that is used by subclasses, construct with shared cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>Integer that specifies the id of this device </td></tr>
<tr><td class="paramname">baseCache</td><td>Cache of the <a class="el" href="classhueplusplus_1_1_resource_list.html" title="Handles a list of a certain API resource. ">ResourceList</a> containing this device (must not be null). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aaa90386c0cea99464dee6bedb2c68254"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa90386c0cea99464dee6bedb2c68254">◆ </a></span>BaseDevice() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">hueplusplus::BaseDevice::BaseDevice </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> & </td>
<td class="paramname"><em>commands</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::chrono::steady_clock::duration </td>
<td class="paramname"><em>refreshDuration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const nlohmann::json & </td>
<td class="paramname"><em>currentState</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Protected ctor that is used by subclasses. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>Integer that specifies the id of this device </td></tr>
<tr><td class="paramname">commands</td><td><a class="el" href="classhueplusplus_1_1_hue_command_a_p_i.html">HueCommandAPI</a> for communication with the bridge </td></tr>
<tr><td class="paramname">path</td><td>Base path for the resource type, ending with a '/'. Example: <code>"/lights/"</code> </td></tr>
<tr><td class="paramname">refreshDuration</td><td>Time between refreshing the cached state. </td></tr>
<tr><td class="paramname">currentState</td><td>Current state of the device, may be null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a21122992819e6155867c02578773d0cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21122992819e6155867c02578773d0cd">◆ </a></span>getId()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int hueplusplus::BaseDevice::getId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const function that returns the id of this device. </p>
<dl class="section return"><dt>Returns</dt><dd>integer representing the device id </dd></dl>
</div>
</div>
<a id="ad6e1af663e4f14afc6293aacdd5130c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6e1af663e4f14afc6293aacdd5130c0">◆ </a></span>getManufacturername()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::BaseDevice::getManufacturername </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const function that returns the manufacturername of the device. </p>
<dl class="section note"><dt>Note</dt><dd>Only working on bridges with versions starting at 1.7 </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>String containing the manufacturername or an empty string when the function is not supported </dd></dl>
</div>
</div>
<a id="aa7572be90ab966033ad8b9c7e83598ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7572be90ab966033ad8b9c7e83598ce">◆ </a></span>getModelId()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::BaseDevice::getModelId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const function that returns the modelid of the device. </p>
<dl class="section return"><dt>Returns</dt><dd>String containing the modelid </dd></dl>
</div>
</div>
<a id="a5331ce38f4e6c9def7bafc23112ccd34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5331ce38f4e6c9def7bafc23112ccd34">◆ </a></span>getName() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::BaseDevice::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Function that returns the name of the device. </p>
<dl class="section return"><dt>Returns</dt><dd>String containig the name of the device </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a095f4467a072fee3091402e7ed31a6fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a095f4467a072fee3091402e7ed31a6fe">◆ </a></span>getName() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::BaseDevice::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const function that returns the name of the device. </p>
<dl class="section note"><dt>Note</dt><dd>This will not refresh the device state </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>String containig the name of the thing </dd></dl>
</div>
</div>
<a id="a53f675db31058c574fbf55baea8bd556"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53f675db31058c574fbf55baea8bd556">◆ </a></span>getProductname()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::BaseDevice::getProductname </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const function that returns the productname of the device. </p>
<dl class="section note"><dt>Note</dt><dd>Only working on bridges with versions starting at 1.24 </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>String containing the productname or an empty string when the function is not supported </dd></dl>
</div>
</div>
<a id="aebc5484b45b833491385a5381e3234bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebc5484b45b833491385a5381e3234bb">◆ </a></span>getSwVersion() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::BaseDevice::getSwVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Function that returns the software version of the device. </p>
<dl class="section return"><dt>Returns</dt><dd>String containing the software version </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a136cdba60a6781c15c6869ddcc7f2e1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a136cdba60a6781c15c6869ddcc7f2e1a">◆ </a></span>getSwVersion() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::BaseDevice::getSwVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const function that returns the software version of the device. </p>
<dl class="section note"><dt>Note</dt><dd>This will not refresh the device state </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>String containing the software version </dd></dl>
</div>
</div>
<a id="a6741ba9ec72108ca0101d41c0b02c568"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6741ba9ec72108ca0101d41c0b02c568">◆ </a></span>getType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::BaseDevice::getType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const function that returns the device type. </p>
<dl class="section return"><dt>Returns</dt><dd>String containing the type </dd></dl>
</div>
</div>
<a id="a821dc52df6472b2604f56579dac4ac04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a821dc52df6472b2604f56579dac4ac04">◆ </a></span>getUId()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::BaseDevice::getUId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Const function that returns the uniqueid of the device. </p>
<dl class="section note"><dt>Note</dt><dd>Only working on bridges with versions starting at 1.4 </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>String containing the uniqueid or an empty string when the function is not supported </dd></dl>
</div>
</div>
<a id="aa6ac28ae3879a41ace1cd6806ca9a2f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6ac28ae3879a41ace1cd6806ca9a2f1">◆ </a></span>refresh()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::BaseDevice::refresh </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>force</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Refreshes internal cached state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">force</td><td><code>true</code> forces a refresh, regardless of how long the last refresh was ago. <code>false</code> to only refresh when enough time has passed (needed e.g. when calling only const methods). </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac8089e8f00d426427ed2fc7f6b817082"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8089e8f00d426427ed2fc7f6b817082">◆ </a></span>sendPutRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">nlohmann::json hueplusplus::BaseDevice::sendPutRequest </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>subPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const nlohmann::json & </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structhueplusplus_1_1_file_info.html">FileInfo</a> </td>
<td class="paramname"><em>fileInfo</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Utility function to send a put request to the device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">subPath</td><td>A path that is appended to the uri, note it should always start with a slash ("/") </td></tr>
<tr><td class="paramname">request</td><td>A nlohmann::json aka the request to send </td></tr>
<tr><td class="paramname">fileInfo</td><td><a class="el" href="structhueplusplus_1_1_file_info.html" title="Contains information about error location, use CURRENT_FILE_INFO to create. ">FileInfo</a> from calling function for exception details. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The parsed reply </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab7554114eee573ab784c44d53f439028"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7554114eee573ab784c44d53f439028">◆ </a></span>setName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool hueplusplus::BaseDevice::setName </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Function that sets the name of the device. </p>
<dl class="section return"><dt>Returns</dt><dd>Bool that is true on success </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>when system or socket operations fail </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when response contained no body </td></tr>
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_a_p_i_response_exception.html" title="Exception caused by a Hue API "error" response with additional information. ">HueAPIResponseException</a></td><td>when response contains an error </td></tr>
<tr><td class="paramname">nlohmann::json::parse_error</td><td>when response could not be parsed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5dd630da2c99842700d555788c0b75b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dd630da2c99842700d555788c0b75b1">◆ </a></span>setRefreshDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::BaseDevice::setRefreshDuration </td>
<td>(</td>
<td class="paramtype">std::chrono::steady_clock::duration </td>
<td class="paramname"><em>refreshDuration</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets custom refresh interval for this device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">refreshDuration</td><td>The new minimum duration between refreshes. May be 0 or <a class="el" href="namespacehueplusplus.html#add9e010e3277f7763db4006cc9f46b86">c_refreshNever</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa65a31223cfa2a054c28148c35c8b3cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa65a31223cfa2a054c28148c35c8b3cf">◆ </a></span>id</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int hueplusplus::BaseDevice::id</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>holds the id of the device </p>
</div>
</div>
<a id="a526b63fa6eb1c9dc9a7b1926ad0be27a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a526b63fa6eb1c9dc9a7b1926ad0be27a">◆ </a></span>state</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_a_p_i_cache.html">APICache</a> hueplusplus::BaseDevice::state</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>holds the current state of the device </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_base_device_8h_source.html">BaseDevice.h</a></li>
<li>src/<a class="el" href="_base_device_8cpp.html">BaseDevice.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>