classhueplusplus_1_1_create_sensor.html
15.2 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
<!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::CreateSensor 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_create_sensor.html">CreateSensor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classhueplusplus_1_1_create_sensor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::CreateSensor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Parameters for creating a new <a class="el" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. ">Sensor</a>.
<a href="classhueplusplus_1_1_create_sensor.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_sensor_8h_source.html">hueplusplus/Sensor.h</a>></code></p>
<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:a1dc269f6f7cd03faf0ae412f2155fb52"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_sensor.html#a1dc269f6f7cd03faf0ae412f2155fb52">CreateSensor</a> (const std::string &name, const std::string &modelid, const std::string &swversion, const std::string &type, const std::string &uniqueid, const std::string &manufacturername)</td></tr>
<tr class="memdesc:a1dc269f6f7cd03faf0ae412f2155fb52"><td class="mdescLeft"> </td><td class="mdescRight">Construct with necessary parameters. <a href="#a1dc269f6f7cd03faf0ae412f2155fb52">More...</a><br /></td></tr>
<tr class="separator:a1dc269f6f7cd03faf0ae412f2155fb52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee8180fd743a609d806e9d20aa8e08b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_sensor.html">CreateSensor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_sensor.html#aee8180fd743a609d806e9d20aa8e08b5">setState</a> (const nlohmann::json &state)</td></tr>
<tr class="memdesc:aee8180fd743a609d806e9d20aa8e08b5"><td class="mdescLeft"> </td><td class="mdescRight">Set state object. <a href="#aee8180fd743a609d806e9d20aa8e08b5">More...</a><br /></td></tr>
<tr class="separator:aee8180fd743a609d806e9d20aa8e08b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab656e9e73f9f4b740d8f28d53aba0e10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_sensor.html">CreateSensor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_sensor.html#ab656e9e73f9f4b740d8f28d53aba0e10">setConfig</a> (const nlohmann::json &config)</td></tr>
<tr class="memdesc:ab656e9e73f9f4b740d8f28d53aba0e10"><td class="mdescLeft"> </td><td class="mdescRight">Set config object. <a href="#ab656e9e73f9f4b740d8f28d53aba0e10">More...</a><br /></td></tr>
<tr class="separator:ab656e9e73f9f4b740d8f28d53aba0e10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49636ceb4843436821dec5de9ab26d38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_sensor.html">CreateSensor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_sensor.html#a49636ceb4843436821dec5de9ab26d38">setRecycle</a> (bool recycle)</td></tr>
<tr class="memdesc:a49636ceb4843436821dec5de9ab26d38"><td class="mdescLeft"> </td><td class="mdescRight">Enable recycling, delete automatically when not referenced. <a href="#a49636ceb4843436821dec5de9ab26d38">More...</a><br /></td></tr>
<tr class="separator:a49636ceb4843436821dec5de9ab26d38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abaf22b996f90fc71ec29c66dcf360407"><td class="memItemLeft" align="right" valign="top">nlohmann::json </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_sensor.html#abaf22b996f90fc71ec29c66dcf360407">getRequest</a> () const</td></tr>
<tr class="memdesc:abaf22b996f90fc71ec29c66dcf360407"><td class="mdescLeft"> </td><td class="mdescRight">Get request to create the sensor. <a href="#abaf22b996f90fc71ec29c66dcf360407">More...</a><br /></td></tr>
<tr class="separator:abaf22b996f90fc71ec29c66dcf360407"><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:a87769c93bab254272db88ac7ba6aff60"><td class="memItemLeft" align="right" valign="top">nlohmann::json </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_sensor.html#a87769c93bab254272db88ac7ba6aff60">request</a></td></tr>
<tr class="separator:a87769c93bab254272db88ac7ba6aff60"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parameters for creating a new <a class="el" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. ">Sensor</a>. </p>
<p>Can be used like a builder object with chained calls. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a1dc269f6f7cd03faf0ae412f2155fb52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dc269f6f7cd03faf0ae412f2155fb52">◆ </a></span>CreateSensor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">hueplusplus::CreateSensor::CreateSensor </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>modelid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>swversion</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>uniqueid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>manufacturername</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct with necessary parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Human readable name </td></tr>
<tr><td class="paramname">modelid</td><td>Model id of the sensor </td></tr>
<tr><td class="paramname">swversion</td><td>Software version, may be empty </td></tr>
<tr><td class="paramname">type</td><td><a class="el" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. ">Sensor</a> type name (see types in <a class="el" href="sensors.html">Sensors</a>) </td></tr>
<tr><td class="paramname">uniqueid</td><td>Globally unique ID (MAC address of the device, extended with a unique endpoint id) </td></tr>
<tr><td class="paramname">manufacturername</td><td>Name of the device manufacturer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abaf22b996f90fc71ec29c66dcf360407"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abaf22b996f90fc71ec29c66dcf360407">◆ </a></span>getRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">nlohmann::json hueplusplus::CreateSensor::getRequest </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get request to create the sensor. </p>
<dl class="section return"><dt>Returns</dt><dd>JSON request for a POST to create the new sensor </dd></dl>
</div>
</div>
<a id="ab656e9e73f9f4b740d8f28d53aba0e10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab656e9e73f9f4b740d8f28d53aba0e10">◆ </a></span>setConfig()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_sensor.html">CreateSensor</a> & hueplusplus::CreateSensor::setConfig </td>
<td>(</td>
<td class="paramtype">const nlohmann::json & </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set config object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td><a class="el" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. ">Sensor</a> config, configs depend on the type. See getters in <a class="el" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. ">Sensor</a> for examples. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>this object for chaining calls </dd></dl>
</div>
</div>
<a id="a49636ceb4843436821dec5de9ab26d38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49636ceb4843436821dec5de9ab26d38">◆ </a></span>setRecycle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_sensor.html">CreateSensor</a> & hueplusplus::CreateSensor::setRecycle </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>recycle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable recycling, delete automatically when not referenced. </p>
<dl class="section return"><dt>Returns</dt><dd>this object for chaining calls </dd></dl>
</div>
</div>
<a id="aee8180fd743a609d806e9d20aa8e08b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee8180fd743a609d806e9d20aa8e08b5">◆ </a></span>setState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_sensor.html">CreateSensor</a> & hueplusplus::CreateSensor::setState </td>
<td>(</td>
<td class="paramtype">const nlohmann::json & </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set state object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td><a class="el" href="classhueplusplus_1_1_sensor.html" title="Class for generic or unknown sensor types. ">Sensor</a> state, contents depend on the type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>this object for chaining calls </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a87769c93bab254272db88ac7ba6aff60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87769c93bab254272db88ac7ba6aff60">◆ </a></span>request</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::CreateSensor::request</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</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="_sensor_8h_source.html">Sensor.h</a></li>
<li>src/<a class="el" href="_sensor_8cpp.html">Sensor.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>