classhueplusplus_1_1_bridge.html
56.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
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
<!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::Bridge 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_bridge.html">Bridge</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classhueplusplus_1_1_bridge-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::Bridge Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classhueplusplus_1_1_bridge.html" title="Bridge class for a bridge. ">Bridge</a> class for a bridge.
<a href="classhueplusplus_1_1_bridge.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_bridge_8h_source.html">hueplusplus/Bridge.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a290adc7b7b4eec346d8ddf4035d9a97b"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a290adc7b7b4eec346d8ddf4035d9a97b">LightList</a> = <a class="el" href="classhueplusplus_1_1_searchable_resource_list.html">SearchableResourceList</a>< <a class="el" href="classhueplusplus_1_1_light.html">Light</a> ></td></tr>
<tr class="separator:a290adc7b7b4eec346d8ddf4035d9a97b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a623c4d205571df7fcefcba1367e53128"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a623c4d205571df7fcefcba1367e53128">GroupList</a> = <a class="el" href="classhueplusplus_1_1_group_resource_list.html">GroupResourceList</a>< <a class="el" href="classhueplusplus_1_1_group.html">Group</a>, <a class="el" href="classhueplusplus_1_1_create_group.html">CreateGroup</a> ></td></tr>
<tr class="separator:a623c4d205571df7fcefcba1367e53128"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14eafa2b131997ff70aedec2d160a14a"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a14eafa2b131997ff70aedec2d160a14a">ScheduleList</a> = <a class="el" href="classhueplusplus_1_1_createable_resource_list.html">CreateableResourceList</a>< <a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a>< <a class="el" href="classhueplusplus_1_1_schedule.html">Schedule</a>, int >, <a class="el" href="classhueplusplus_1_1_create_schedule.html">CreateSchedule</a> ></td></tr>
<tr class="separator:a14eafa2b131997ff70aedec2d160a14a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58df1b54c19725c1a094c7e1fa6623b7"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a58df1b54c19725c1a094c7e1fa6623b7">SceneList</a> = <a class="el" href="classhueplusplus_1_1_createable_resource_list.html">CreateableResourceList</a>< <a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a>< <a class="el" href="classhueplusplus_1_1_scene.html">Scene</a>, std::string >, <a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> ></td></tr>
<tr class="separator:a58df1b54c19725c1a094c7e1fa6623b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f15819509a9e012a03b2a629eebf74b"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a5f15819509a9e012a03b2a629eebf74b">RuleList</a> = <a class="el" href="classhueplusplus_1_1_createable_resource_list.html">CreateableResourceList</a>< <a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a>< <a class="el" href="classhueplusplus_1_1_rule.html">Rule</a>, int >, <a class="el" href="classhueplusplus_1_1_create_rule.html">CreateRule</a> ></td></tr>
<tr class="separator:a5f15819509a9e012a03b2a629eebf74b"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a5fa0378ab3552a82d611fba6701bcad6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a5fa0378ab3552a82d611fba6701bcad6">Bridge</a> (const std::string &ip, const int port, const std::string &username, std::shared_ptr< const <a class="el" href="classhueplusplus_1_1_i_http_handler.html">IHttpHandler</a> > handler, const std::string &clientkey="", std::chrono::steady_clock::duration refreshDuration=std::chrono::seconds(10), bool sharedState=false)</td></tr>
<tr class="memdesc:a5fa0378ab3552a82d611fba6701bcad6"><td class="mdescLeft"> </td><td class="mdescRight">Constructor of <a class="el" href="classhueplusplus_1_1_bridge.html" title="Bridge class for a bridge. ">Bridge</a> class. <a href="#a5fa0378ab3552a82d611fba6701bcad6">More...</a><br /></td></tr>
<tr class="separator:a5fa0378ab3552a82d611fba6701bcad6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5e6405f4a371b5af6a85a3cd5f0c647"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#ab5e6405f4a371b5af6a85a3cd5f0c647">refresh</a> ()</td></tr>
<tr class="memdesc:ab5e6405f4a371b5af6a85a3cd5f0c647"><td class="mdescLeft"> </td><td class="mdescRight">Refreshes the bridge state. <a href="#ab5e6405f4a371b5af6a85a3cd5f0c647">More...</a><br /></td></tr>
<tr class="separator:ab5e6405f4a371b5af6a85a3cd5f0c647"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc8372a1ca66b86098ae5a841106d89b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#adc8372a1ca66b86098ae5a841106d89b">setRefreshDuration</a> (std::chrono::steady_clock::duration refreshDuration)</td></tr>
<tr class="memdesc:adc8372a1ca66b86098ae5a841106d89b"><td class="mdescLeft"> </td><td class="mdescRight">Sets refresh interval for the whole bridge state. <a href="#adc8372a1ca66b86098ae5a841106d89b">More...</a><br /></td></tr>
<tr class="separator:adc8372a1ca66b86098ae5a841106d89b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2565e0a09e18554859e14d13edd2570a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a2565e0a09e18554859e14d13edd2570a">getBridgeIP</a> () const</td></tr>
<tr class="memdesc:a2565e0a09e18554859e14d13edd2570a"><td class="mdescLeft"> </td><td class="mdescRight">Function to get the ip address of the hue bridge. <a href="#a2565e0a09e18554859e14d13edd2570a">More...</a><br /></td></tr>
<tr class="separator:a2565e0a09e18554859e14d13edd2570a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa272ef31a6dc4f3cb54b284db6d134bb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#aa272ef31a6dc4f3cb54b284db6d134bb">startStreaming</a> (std::string group_identifier)</td></tr>
<tr class="memdesc:aa272ef31a6dc4f3cb54b284db6d134bb"><td class="mdescLeft"> </td><td class="mdescRight">Function to set stream mode to active for entertainment mode. <a href="#aa272ef31a6dc4f3cb54b284db6d134bb">More...</a><br /></td></tr>
<tr class="separator:aa272ef31a6dc4f3cb54b284db6d134bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6382a095f2c96ee8b321d75aed285fb2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a6382a095f2c96ee8b321d75aed285fb2">stopStreaming</a> (std::string group_identifier)</td></tr>
<tr class="memdesc:a6382a095f2c96ee8b321d75aed285fb2"><td class="mdescLeft"> </td><td class="mdescRight">Function to set stream mode to active for entertainment mode. <a href="#a6382a095f2c96ee8b321d75aed285fb2">More...</a><br /></td></tr>
<tr class="separator:a6382a095f2c96ee8b321d75aed285fb2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abbb06fcb89f58935d5f59fced64b3d53"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#abbb06fcb89f58935d5f59fced64b3d53">getBridgePort</a> () const</td></tr>
<tr class="memdesc:abbb06fcb89f58935d5f59fced64b3d53"><td class="mdescLeft"> </td><td class="mdescRight">Function to get the port of the hue bridge. <a href="#abbb06fcb89f58935d5f59fced64b3d53">More...</a><br /></td></tr>
<tr class="separator:abbb06fcb89f58935d5f59fced64b3d53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2cc2ae33208a20572e6f556233b97692"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a2cc2ae33208a20572e6f556233b97692">requestUsername</a> ()</td></tr>
<tr class="memdesc:a2cc2ae33208a20572e6f556233b97692"><td class="mdescLeft"> </td><td class="mdescRight">Send a username request to the Hue bridge. <a href="#a2cc2ae33208a20572e6f556233b97692">More...</a><br /></td></tr>
<tr class="separator:a2cc2ae33208a20572e6f556233b97692"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a810987627e7351afd0d9bfbaab2a8cb8"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a810987627e7351afd0d9bfbaab2a8cb8">getUsername</a> () const</td></tr>
<tr class="memdesc:a810987627e7351afd0d9bfbaab2a8cb8"><td class="mdescLeft"> </td><td class="mdescRight">Function that returns the username. <a href="#a810987627e7351afd0d9bfbaab2a8cb8">More...</a><br /></td></tr>
<tr class="separator:a810987627e7351afd0d9bfbaab2a8cb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82efe66d4376ffa406d45ac10fbfaf6a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a82efe66d4376ffa406d45ac10fbfaf6a">getClientKey</a> () const</td></tr>
<tr class="memdesc:a82efe66d4376ffa406d45ac10fbfaf6a"><td class="mdescLeft"> </td><td class="mdescRight">Function that returns the client key. <a href="#a82efe66d4376ffa406d45ac10fbfaf6a">More...</a><br /></td></tr>
<tr class="separator:a82efe66d4376ffa406d45ac10fbfaf6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af94ffa94ef0994756b56fb1fa54cc9c5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#af94ffa94ef0994756b56fb1fa54cc9c5">setIP</a> (const std::string &ip)</td></tr>
<tr class="memdesc:af94ffa94ef0994756b56fb1fa54cc9c5"><td class="mdescLeft"> </td><td class="mdescRight">Function to set the ip address of this class representing a bridge. <a href="#af94ffa94ef0994756b56fb1fa54cc9c5">More...</a><br /></td></tr>
<tr class="separator:af94ffa94ef0994756b56fb1fa54cc9c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af01f8a5bdc06b28d0cb150ab3d8e30df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#af01f8a5bdc06b28d0cb150ab3d8e30df">setPort</a> (const int port)</td></tr>
<tr class="memdesc:af01f8a5bdc06b28d0cb150ab3d8e30df"><td class="mdescLeft"> </td><td class="mdescRight">Function to set the port of this class representing a bridge. <a href="#af01f8a5bdc06b28d0cb150ab3d8e30df">More...</a><br /></td></tr>
<tr class="separator:af01f8a5bdc06b28d0cb150ab3d8e30df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a227a51a24d21bda234a40b8b84058eb3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a227a51a24d21bda234a40b8b84058eb3">config</a> ()</td></tr>
<tr class="memdesc:a227a51a24d21bda234a40b8b84058eb3"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the configuration of the bridge. <a href="#a227a51a24d21bda234a40b8b84058eb3">More...</a><br /></td></tr>
<tr class="separator:a227a51a24d21bda234a40b8b84058eb3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7823c82064faf3eb019288cbb9f7f7d3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a7823c82064faf3eb019288cbb9f7f7d3">config</a> () const</td></tr>
<tr class="memdesc:a7823c82064faf3eb019288cbb9f7f7d3"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the configuration of the bridge. <a href="#a7823c82064faf3eb019288cbb9f7f7d3">More...</a><br /></td></tr>
<tr class="separator:a7823c82064faf3eb019288cbb9f7f7d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bd607246130312915a3b07116c72301"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_bridge.html#a290adc7b7b4eec346d8ddf4035d9a97b">LightList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a7bd607246130312915a3b07116c72301">lights</a> ()</td></tr>
<tr class="memdesc:a7bd607246130312915a3b07116c72301"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_light.html" title="Class for Hue Light fixtures. ">Light</a>s on the bridge. <a href="#a7bd607246130312915a3b07116c72301">More...</a><br /></td></tr>
<tr class="separator:a7bd607246130312915a3b07116c72301"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaba8efa389cf91d1199a9edd93b0004e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classhueplusplus_1_1_bridge.html#a290adc7b7b4eec346d8ddf4035d9a97b">LightList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#aaba8efa389cf91d1199a9edd93b0004e">lights</a> () const</td></tr>
<tr class="memdesc:aaba8efa389cf91d1199a9edd93b0004e"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_light.html" title="Class for Hue Light fixtures. ">Light</a>s on the bridge. <a href="#aaba8efa389cf91d1199a9edd93b0004e">More...</a><br /></td></tr>
<tr class="separator:aaba8efa389cf91d1199a9edd93b0004e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86fa3bec3ae4729df0cf6305ce49388c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_bridge.html#a623c4d205571df7fcefcba1367e53128">GroupList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a86fa3bec3ae4729df0cf6305ce49388c">groups</a> ()</td></tr>
<tr class="memdesc:a86fa3bec3ae4729df0cf6305ce49388c"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_group.html" title="Class for Groups of lights. ">Group</a>s on the bridge. <a href="#a86fa3bec3ae4729df0cf6305ce49388c">More...</a><br /></td></tr>
<tr class="separator:a86fa3bec3ae4729df0cf6305ce49388c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ebf445f09bf3e1c325939ec19605483"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classhueplusplus_1_1_bridge.html#a623c4d205571df7fcefcba1367e53128">GroupList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a1ebf445f09bf3e1c325939ec19605483">groups</a> () const</td></tr>
<tr class="memdesc:a1ebf445f09bf3e1c325939ec19605483"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_group.html" title="Class for Groups of lights. ">Group</a>s on the bridge. <a href="#a1ebf445f09bf3e1c325939ec19605483">More...</a><br /></td></tr>
<tr class="separator:a1ebf445f09bf3e1c325939ec19605483"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe68f4cac354705974cf1608f2a08420"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_bridge.html#a14eafa2b131997ff70aedec2d160a14a">ScheduleList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#afe68f4cac354705974cf1608f2a08420">schedules</a> ()</td></tr>
<tr class="memdesc:afe68f4cac354705974cf1608f2a08420"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_schedule.html" title="Schedule stored in the bridge. ">Schedule</a>s on the bridge. <a href="#afe68f4cac354705974cf1608f2a08420">More...</a><br /></td></tr>
<tr class="separator:afe68f4cac354705974cf1608f2a08420"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a915ed267f130d35ec3ef215f8c9b69fa"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classhueplusplus_1_1_bridge.html#a14eafa2b131997ff70aedec2d160a14a">ScheduleList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a915ed267f130d35ec3ef215f8c9b69fa">schedules</a> () const</td></tr>
<tr class="memdesc:a915ed267f130d35ec3ef215f8c9b69fa"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_schedule.html" title="Schedule stored in the bridge. ">Schedule</a>s on the bridge. <a href="#a915ed267f130d35ec3ef215f8c9b69fa">More...</a><br /></td></tr>
<tr class="separator:a915ed267f130d35ec3ef215f8c9b69fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a175d390126a454a6f9a04f74e5654bdc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_bridge.html#a58df1b54c19725c1a094c7e1fa6623b7">SceneList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a175d390126a454a6f9a04f74e5654bdc">scenes</a> ()</td></tr>
<tr class="memdesc:a175d390126a454a6f9a04f74e5654bdc"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_scene.html" title="Scene stored in the bridge. ">Scene</a>s on the bridge. <a href="#a175d390126a454a6f9a04f74e5654bdc">More...</a><br /></td></tr>
<tr class="separator:a175d390126a454a6f9a04f74e5654bdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6d36575bf9cfa372bbd4ceac526eb95"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classhueplusplus_1_1_bridge.html#a58df1b54c19725c1a094c7e1fa6623b7">SceneList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#af6d36575bf9cfa372bbd4ceac526eb95">scenes</a> () const</td></tr>
<tr class="memdesc:af6d36575bf9cfa372bbd4ceac526eb95"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_scene.html" title="Scene stored in the bridge. ">Scene</a>s on the bridge. <a href="#af6d36575bf9cfa372bbd4ceac526eb95">More...</a><br /></td></tr>
<tr class="separator:af6d36575bf9cfa372bbd4ceac526eb95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd15a988fecd561103a06e5a4ec8780b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_sensor_list.html">SensorList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#acd15a988fecd561103a06e5a4ec8780b">sensors</a> ()</td></tr>
<tr class="memdesc:acd15a988fecd561103a06e5a4ec8780b"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. ">Sensor</a>s on the bridge. <a href="#acd15a988fecd561103a06e5a4ec8780b">More...</a><br /></td></tr>
<tr class="separator:acd15a988fecd561103a06e5a4ec8780b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6944b189b9d8ac0a3fea3391a467e46a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classhueplusplus_1_1_sensor_list.html">SensorList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a6944b189b9d8ac0a3fea3391a467e46a">sensors</a> () const</td></tr>
<tr class="memdesc:a6944b189b9d8ac0a3fea3391a467e46a"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. ">Sensor</a>s on the bridge. <a href="#a6944b189b9d8ac0a3fea3391a467e46a">More...</a><br /></td></tr>
<tr class="separator:a6944b189b9d8ac0a3fea3391a467e46a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa2d393fd8498cf6c39a83e8258b062e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_bridge.html#a5f15819509a9e012a03b2a629eebf74b">RuleList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#aaa2d393fd8498cf6c39a83e8258b062e">rules</a> ()</td></tr>
<tr class="memdesc:aaa2d393fd8498cf6c39a83e8258b062e"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_rule.html" title="Rule stored in the bridge. ">Rule</a>s on the bridge. <a href="#aaa2d393fd8498cf6c39a83e8258b062e">More...</a><br /></td></tr>
<tr class="separator:aaa2d393fd8498cf6c39a83e8258b062e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b92a77274cb53e7085e6f9135be25ba"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classhueplusplus_1_1_bridge.html#a5f15819509a9e012a03b2a629eebf74b">RuleList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a7b92a77274cb53e7085e6f9135be25ba">rules</a> () const</td></tr>
<tr class="memdesc:a7b92a77274cb53e7085e6f9135be25ba"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the <a class="el" href="classhueplusplus_1_1_rule.html" title="Rule stored in the bridge. ">Rule</a>s on the bridge. <a href="#a7b92a77274cb53e7085e6f9135be25ba">More...</a><br /></td></tr>
<tr class="separator:a7b92a77274cb53e7085e6f9135be25ba"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a1ffb423a79da8deb2ef13bb2c89b6d78"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_bridge.html#a1ffb423a79da8deb2ef13bb2c89b6d78">BridgeFinder</a></td></tr>
<tr class="separator:a1ffb423a79da8deb2ef13bb2c89b6d78"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classhueplusplus_1_1_bridge.html" title="Bridge class for a bridge. ">Bridge</a> class for a bridge. </p>
<p>This is the main class used to interact with the Hue bridge. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a623c4d205571df7fcefcba1367e53128"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a623c4d205571df7fcefcba1367e53128">◆ </a></span>GroupList</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classhueplusplus_1_1_bridge.html#a623c4d205571df7fcefcba1367e53128">hueplusplus::Bridge::GroupList</a> = <a class="el" href="classhueplusplus_1_1_group_resource_list.html">GroupResourceList</a><<a class="el" href="classhueplusplus_1_1_group.html">Group</a>, <a class="el" href="classhueplusplus_1_1_create_group.html">CreateGroup</a>></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a290adc7b7b4eec346d8ddf4035d9a97b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a290adc7b7b4eec346d8ddf4035d9a97b">◆ </a></span>LightList</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classhueplusplus_1_1_bridge.html#a290adc7b7b4eec346d8ddf4035d9a97b">hueplusplus::Bridge::LightList</a> = <a class="el" href="classhueplusplus_1_1_searchable_resource_list.html">SearchableResourceList</a><<a class="el" href="classhueplusplus_1_1_light.html">Light</a>></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5f15819509a9e012a03b2a629eebf74b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f15819509a9e012a03b2a629eebf74b">◆ </a></span>RuleList</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classhueplusplus_1_1_bridge.html#a5f15819509a9e012a03b2a629eebf74b">hueplusplus::Bridge::RuleList</a> = <a class="el" href="classhueplusplus_1_1_createable_resource_list.html">CreateableResourceList</a><<a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a><<a class="el" href="classhueplusplus_1_1_rule.html">Rule</a>, int>, <a class="el" href="classhueplusplus_1_1_create_rule.html">CreateRule</a>></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a58df1b54c19725c1a094c7e1fa6623b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58df1b54c19725c1a094c7e1fa6623b7">◆ </a></span>SceneList</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classhueplusplus_1_1_bridge.html#a58df1b54c19725c1a094c7e1fa6623b7">hueplusplus::Bridge::SceneList</a> = <a class="el" href="classhueplusplus_1_1_createable_resource_list.html">CreateableResourceList</a><<a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a><<a class="el" href="classhueplusplus_1_1_scene.html">Scene</a>, std::string>, <a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a>></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a14eafa2b131997ff70aedec2d160a14a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14eafa2b131997ff70aedec2d160a14a">◆ </a></span>ScheduleList</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classhueplusplus_1_1_bridge.html#a14eafa2b131997ff70aedec2d160a14a">hueplusplus::Bridge::ScheduleList</a> = <a class="el" href="classhueplusplus_1_1_createable_resource_list.html">CreateableResourceList</a><<a class="el" href="classhueplusplus_1_1_resource_list.html">ResourceList</a><<a class="el" href="classhueplusplus_1_1_schedule.html">Schedule</a>, int>, <a class="el" href="classhueplusplus_1_1_create_schedule.html">CreateSchedule</a>></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a5fa0378ab3552a82d611fba6701bcad6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fa0378ab3552a82d611fba6701bcad6">◆ </a></span>Bridge()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hueplusplus::Bridge::Bridge </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>ip</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>username</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr< const <a class="el" href="classhueplusplus_1_1_i_http_handler.html">IHttpHandler</a> > </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>clientkey</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::chrono::steady_clock::duration </td>
<td class="paramname"><em>refreshDuration</em> = <code>std::chrono::seconds(10)</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>sharedState</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor of <a class="el" href="classhueplusplus_1_1_bridge.html" title="Bridge class for a bridge. ">Bridge</a> class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ip</td><td>IP address in dotted decimal notation like "192.168.2.1" </td></tr>
<tr><td class="paramname">port</td><td>Port of the hue bridge </td></tr>
<tr><td class="paramname">username</td><td>String that specifies the username that is used to control the bridge. Can be left empty and acquired in <a class="el" href="classhueplusplus_1_1_bridge.html#a2cc2ae33208a20572e6f556233b97692">requestUsername</a>. </td></tr>
<tr><td class="paramname">handler</td><td>HttpHandler for communication with the bridge </td></tr>
<tr><td class="paramname">clientkey</td><td>Optional client key for streaming </td></tr>
<tr><td class="paramname">refreshDuration</td><td>Time between refreshing the cached state. </td></tr>
<tr><td class="paramname">sharedState</td><td>Uses a single, shared cache for all objects on the bridge. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a227a51a24d21bda234a40b8b84058eb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a227a51a24d21bda234a40b8b84058eb3">◆ </a></span>config() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a> & hueplusplus::Bridge::config </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the configuration of the bridge. </p>
</div>
</div>
<a id="a7823c82064faf3eb019288cbb9f7f7d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7823c82064faf3eb019288cbb9f7f7d3">◆ </a></span>config() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classhueplusplus_1_1_bridge_config.html">BridgeConfig</a> & hueplusplus::Bridge::config </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the configuration of the bridge. </p>
<dl class="section note"><dt>Note</dt><dd>Does not refresh state. </dd></dl>
</div>
</div>
<a id="a2565e0a09e18554859e14d13edd2570a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2565e0a09e18554859e14d13edd2570a">◆ </a></span>getBridgeIP()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Bridge::getBridgeIP </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to get the ip address of the hue bridge. </p>
<dl class="section return"><dt>Returns</dt><dd>string containing ip </dd></dl>
</div>
</div>
<a id="abbb06fcb89f58935d5f59fced64b3d53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbb06fcb89f58935d5f59fced64b3d53">◆ </a></span>getBridgePort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int hueplusplus::Bridge::getBridgePort </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to get the port of the hue bridge. </p>
<dl class="section return"><dt>Returns</dt><dd>integer containing port </dd></dl>
</div>
</div>
<a id="a82efe66d4376ffa406d45ac10fbfaf6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82efe66d4376ffa406d45ac10fbfaf6a">◆ </a></span>getClientKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Bridge::getClientKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function that returns the client key. </p>
<dl class="section return"><dt>Returns</dt><dd>The client key used for Entertainment Mode API access </dd></dl>
</div>
</div>
<a id="a810987627e7351afd0d9bfbaab2a8cb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a810987627e7351afd0d9bfbaab2a8cb8">◆ </a></span>getUsername()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Bridge::getUsername </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function that returns the username. </p>
<dl class="section return"><dt>Returns</dt><dd>The username used for API access </dd></dl>
</div>
</div>
<a id="a86fa3bec3ae4729df0cf6305ce49388c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86fa3bec3ae4729df0cf6305ce49388c">◆ </a></span>groups() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_bridge.html#a623c4d205571df7fcefcba1367e53128">Bridge::GroupList</a> & hueplusplus::Bridge::groups </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_group.html" title="Class for Groups of lights. ">Group</a>s on the bridge. </p>
</div>
</div>
<a id="a1ebf445f09bf3e1c325939ec19605483"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ebf445f09bf3e1c325939ec19605483">◆ </a></span>groups() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classhueplusplus_1_1_bridge.html#a623c4d205571df7fcefcba1367e53128">Bridge::GroupList</a> & hueplusplus::Bridge::groups </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_group.html" title="Class for Groups of lights. ">Group</a>s on the bridge. </p>
<dl class="section note"><dt>Note</dt><dd>Does not refresh state. </dd></dl>
</div>
</div>
<a id="a7bd607246130312915a3b07116c72301"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bd607246130312915a3b07116c72301">◆ </a></span>lights() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_bridge.html#a290adc7b7b4eec346d8ddf4035d9a97b">Bridge::LightList</a> & hueplusplus::Bridge::lights </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_light.html" title="Class for Hue Light fixtures. ">Light</a>s on the bridge. </p>
</div>
</div>
<a id="aaba8efa389cf91d1199a9edd93b0004e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaba8efa389cf91d1199a9edd93b0004e">◆ </a></span>lights() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classhueplusplus_1_1_bridge.html#a290adc7b7b4eec346d8ddf4035d9a97b">Bridge::LightList</a> & hueplusplus::Bridge::lights </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_light.html" title="Class for Hue Light fixtures. ">Light</a>s on the bridge. </p>
<dl class="section note"><dt>Note</dt><dd>Does not refresh state. </dd></dl>
</div>
</div>
<a id="ab5e6405f4a371b5af6a85a3cd5f0c647"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5e6405f4a371b5af6a85a3cd5f0c647">◆ </a></span>refresh()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Bridge::refresh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Refreshes the bridge state. </p>
<p>Should only be called rarely, as a full refresh is costly and usually not necessary. Instead refresh only the parts you are interested in or rely on periodic refreshes that happen automatically when calling non-const methods. </p><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="a2cc2ae33208a20572e6f556233b97692"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cc2ae33208a20572e6f556233b97692">◆ </a></span>requestUsername()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string hueplusplus::Bridge::requestUsername </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a username request to the Hue bridge. </p>
<p>Blocks for about 30 seconds and 5 seconds to prepare. It automatically sets the username variable according to the username received and returns the username received. This function should only be called once to acquire a username to control the bridge and the username should be saved for future use. </p><dl class="section return"><dt>Returns</dt><dd>username for API usage </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 except link button not pressed. </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="aaa2d393fd8498cf6c39a83e8258b062e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa2d393fd8498cf6c39a83e8258b062e">◆ </a></span>rules() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_bridge.html#a5f15819509a9e012a03b2a629eebf74b">Bridge::RuleList</a> & hueplusplus::Bridge::rules </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_rule.html" title="Rule stored in the bridge. ">Rule</a>s on the bridge. </p>
</div>
</div>
<a id="a7b92a77274cb53e7085e6f9135be25ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b92a77274cb53e7085e6f9135be25ba">◆ </a></span>rules() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classhueplusplus_1_1_bridge.html#a5f15819509a9e012a03b2a629eebf74b">Bridge::RuleList</a> & hueplusplus::Bridge::rules </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_rule.html" title="Rule stored in the bridge. ">Rule</a>s on the bridge. </p>
<dl class="section note"><dt>Note</dt><dd>Does not refresh state. </dd></dl>
</div>
</div>
<a id="a175d390126a454a6f9a04f74e5654bdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a175d390126a454a6f9a04f74e5654bdc">◆ </a></span>scenes() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_bridge.html#a58df1b54c19725c1a094c7e1fa6623b7">Bridge::SceneList</a> & hueplusplus::Bridge::scenes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_scene.html" title="Scene stored in the bridge. ">Scene</a>s on the bridge. </p>
</div>
</div>
<a id="af6d36575bf9cfa372bbd4ceac526eb95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6d36575bf9cfa372bbd4ceac526eb95">◆ </a></span>scenes() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classhueplusplus_1_1_bridge.html#a58df1b54c19725c1a094c7e1fa6623b7">Bridge::SceneList</a> & hueplusplus::Bridge::scenes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_scene.html" title="Scene stored in the bridge. ">Scene</a>s on the bridge. </p>
<dl class="section note"><dt>Note</dt><dd>Does not refresh state. </dd></dl>
</div>
</div>
<a id="afe68f4cac354705974cf1608f2a08420"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe68f4cac354705974cf1608f2a08420">◆ </a></span>schedules() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_bridge.html#a14eafa2b131997ff70aedec2d160a14a">Bridge::ScheduleList</a> & hueplusplus::Bridge::schedules </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_schedule.html" title="Schedule stored in the bridge. ">Schedule</a>s on the bridge. </p>
</div>
</div>
<a id="a915ed267f130d35ec3ef215f8c9b69fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a915ed267f130d35ec3ef215f8c9b69fa">◆ </a></span>schedules() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classhueplusplus_1_1_bridge.html#a14eafa2b131997ff70aedec2d160a14a">Bridge::ScheduleList</a> & hueplusplus::Bridge::schedules </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_schedule.html" title="Schedule stored in the bridge. ">Schedule</a>s on the bridge. </p>
<dl class="section note"><dt>Note</dt><dd>Does not refresh state. </dd></dl>
</div>
</div>
<a id="acd15a988fecd561103a06e5a4ec8780b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd15a988fecd561103a06e5a4ec8780b">◆ </a></span>sensors() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_sensor_list.html">hueplusplus::SensorList</a> & hueplusplus::Bridge::sensors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. ">Sensor</a>s on the bridge. </p>
</div>
</div>
<a id="a6944b189b9d8ac0a3fea3391a467e46a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6944b189b9d8ac0a3fea3391a467e46a">◆ </a></span>sensors() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classhueplusplus_1_1_sensor_list.html">hueplusplus::SensorList</a> & hueplusplus::Bridge::sensors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the <a class="el" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. ">Sensor</a>s on the bridge. </p>
<dl class="section note"><dt>Note</dt><dd>Does not refresh state. </dd></dl>
</div>
</div>
<a id="af94ffa94ef0994756b56fb1fa54cc9c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af94ffa94ef0994756b56fb1fa54cc9c5">◆ </a></span>setIP()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Bridge::setIP </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>ip</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to set the ip address of this class representing a bridge. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ip</td><td>String that specifies the ip in dotted decimal notation like "192.168.2.1" </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af01f8a5bdc06b28d0cb150ab3d8e30df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af01f8a5bdc06b28d0cb150ab3d8e30df">◆ </a></span>setPort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Bridge::setPort </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"><em>port</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to set the port of this class representing a bridge. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">port</td><td>Integer that specifies the port of an address like "192.168.2.1:8080" </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adc8372a1ca66b86098ae5a841106d89b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc8372a1ca66b86098ae5a841106d89b">◆ </a></span>setRefreshDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hueplusplus::Bridge::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>
</div><div class="memdoc">
<p>Sets refresh interval for the whole bridge state. </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>
<p>Also sets refresh duration on all resource lists on the bridge, but not on already existing lights. The resource lists (such as <a class="el" href="classhueplusplus_1_1_bridge.html#a7bd607246130312915a3b07116c72301" title="Provides access to the Lights on the bridge. ">lights()</a>) can have their own durations, but those must be set after calling this function. </p>
</div>
</div>
<a id="aa272ef31a6dc4f3cb54b284db6d134bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa272ef31a6dc4f3cb54b284db6d134bb">◆ </a></span>startStreaming()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hueplusplus::Bridge::startStreaming </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>group_identifier</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to set stream mode to active for entertainment mode. </p>
<dl class="section return"><dt>Returns</dt><dd>bool - whether stream request was successful </dd></dl>
</div>
</div>
<a id="a6382a095f2c96ee8b321d75aed285fb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6382a095f2c96ee8b321d75aed285fb2">◆ </a></span>stopStreaming()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hueplusplus::Bridge::stopStreaming </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>group_identifier</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to set stream mode to active for entertainment mode. </p>
<dl class="section return"><dt>Returns</dt><dd>bool - whether stream request was successful </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a1ffb423a79da8deb2ef13bb2c89b6d78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ffb423a79da8deb2ef13bb2c89b6d78">◆ </a></span>BridgeFinder</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classhueplusplus_1_1_bridge_finder.html">BridgeFinder</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_bridge_8h_source.html">Bridge.h</a></li>
<li>src/<a class="el" href="_bridge_8cpp.html">Bridge.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>