Skip to content

Commit eee0aaf

Browse files
sivar2311sivar2311
committed
Initial Commmit
0 parents  commit eee0aaf

File tree

1,172 files changed

+91316
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,172 files changed

+91316
-0
lines changed

‎Doxyfile‎

Lines changed: 2664 additions & 0 deletions
Large diffs are not rendered by default.

‎doc-examples/callbacks.cpp‎

Lines changed: 438 additions & 0 deletions
Large diffs are not rendered by default.

‎doc-examples/documentation.dox‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/**
2+
* @defgroup SinricPro SinricPro
3+
* @brief Main instance of SinricProClass
4+
*
5+
* @defgroup Devices Devices
6+
* @brief Available devices
7+
*
8+
* @defgroup Capabilities Capabilities
9+
* @brief Capabilities
10+
*
11+
**/

‎docs/_air_quality_sensor_8h_source.html‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.9.1"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>SinricPro Library: C:/Users/Boris/.platformio/lib/esp8266-esp32-sdk/src/Capabilities/AirQualitySensor.h Source File</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr style="height: 56px;">
27+
<td id="projectalign" style="padding-left: 0.5em;">
28+
<div id="projectname">SinricPro Library
29+
</div>
30+
</td>
31+
</tr>
32+
</tbody>
33+
</table>
34+
</div>
35+
<!-- end header part -->
36+
<!-- Generated by Doxygen 1.9.1 -->
37+
<script type="text/javascript">
38+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
39+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
40+
/* @license-end */
41+
</script>
42+
<script type="text/javascript" src="menudata.js"></script>
43+
<script type="text/javascript" src="menu.js"></script>
44+
<script type="text/javascript">
45+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
46+
$(function() {
47+
initMenu('',true,false,'search.php','Search');
48+
$(document).ready(function() { init_search(); });
49+
});
50+
/* @license-end */</script>
51+
<div id="main-nav"></div>
52+
</div><!-- top -->
53+
<div id="side-nav" class="ui-resizable side-nav-resizable">
54+
<div id="nav-tree">
55+
<div id="nav-tree-contents">
56+
<div id="nav-sync" class="sync"></div>
57+
</div>
58+
</div>
59+
<div id="splitbar" style="-moz-user-select:none;"
60+
class="ui-resizable-handle">
61+
</div>
62+
</div>
63+
<script type="text/javascript">
64+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
65+
$(document).ready(function(){initNavTree('_air_quality_sensor_8h_source.html',''); initResizable(); });
66+
/* @license-end */
67+
</script>
68+
<div id="doc-content">
69+
<!-- window showing the filter options -->
70+
<div id="MSearchSelectWindow"
71+
onmouseover="return searchBox.OnSearchSelectShow()"
72+
onmouseout="return searchBox.OnSearchSelectHide()"
73+
onkeydown="return searchBox.OnSearchSelectKey(event)">
74+
</div>
75+
76+
<!-- iframe showing the search results (closed by default) -->
77+
<div id="MSearchResultsWindow">
78+
<iframe src="javascript:void(0)" frameborder="0"
79+
name="MSearchResults" id="MSearchResults">
80+
</iframe>
81+
</div>
82+
83+
<div class="header">
84+
<div class="headertitle">
85+
<div class="title">AirQualitySensor.h</div> </div>
86+
</div><!--header-->
87+
<div class="contents">
88+
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
89+
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
90+
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &quot;../EventLimiter.h&quot;</span></div>
91+
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;../SinricProStrings.h&quot;</span></div>
92+
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
93+
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;../SinricProNamespace.h&quot;</span></div>
94+
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="keyword">namespace </span>SINRICPRO_NAMESPACE {</div>
95+
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
96+
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;FSTR(AIRQUALITY, airQuality); <span class="comment">// &quot;airQuality&quot;</span></div>
97+
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;FSTR(AIRQUALITY, pm1); <span class="comment">// &quot;pm1&quot;</span></div>
98+
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;FSTR(AIRQUALITY, pm2_5); <span class="comment">// &quot;pm2_5&quot;</span></div>
99+
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;FSTR(AIRQUALITY, pm10); <span class="comment">// &quot;pm10&quot;</span></div>
100+
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
101+
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
102+
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="class_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor.html"> 19</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor.html">AirQualitySensor</a> {</div>
103+
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">public</span>:</div>
104+
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <a class="code" href="class_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor.html">AirQualitySensor</a>();</div>
105+
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="class_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor.html#a733195bdc5b15c858e4e890847b3a0d5"> 22</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor.html#a733195bdc5b15c858e4e890847b3a0d5">sendAirQualityEvent</a>(<span class="keywordtype">int</span> pm1 = 0, <span class="keywordtype">int</span> pm2_5 = 0, <span class="keywordtype">int</span> pm10 = 0, String cause = FSTR_SINRICPRO_PERIODIC_POLL);</div>
106+
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">private</span>:</div>
107+
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; EventLimiter event_limiter;</div>
108+
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;};</div>
109+
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
110+
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
111+
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<a class="code" href="class_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor.html">AirQualitySensor&lt;T&gt;::AirQualitySensor</a>()</div>
112+
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;: event_limiter (EVENT_LIMIT_SENSOR_VALUE) {}</div>
113+
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
114+
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
115+
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor.html#a733195bdc5b15c858e4e890847b3a0d5"> 43</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="class_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor.html">AirQualitySensor&lt;T&gt;::sendAirQualityEvent</a>(<span class="keywordtype">int</span> pm1, <span class="keywordtype">int</span> pm2_5, <span class="keywordtype">int</span> pm10, String cause) {</div>
116+
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">if</span> (event_limiter) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
117+
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; T* device = <span class="keyword">static_cast&lt;</span>T*<span class="keyword">&gt;</span>(<span class="keyword">this</span>);</div>
118+
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
119+
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; DynamicJsonDocument eventMessage = device-&gt;prepareEvent(FSTR_AIRQUALITY_airQuality, cause.c_str());</div>
120+
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; JsonObject event_value = eventMessage[FSTR_SINRICPRO_payload][FSTR_SINRICPRO_value];</div>
121+
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
122+
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; event_value[FSTR_AIRQUALITY_pm1] = pm1;</div>
123+
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; event_value[FSTR_AIRQUALITY_pm2_5] = pm2_5;</div>
124+
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; event_value[FSTR_AIRQUALITY_pm10] = pm10;</div>
125+
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
126+
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> device-&gt;sendEvent(eventMessage);</div>
127+
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}</div>
128+
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
129+
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;} <span class="comment">// SINRICPRO_NAMESPACE</span></div>
130+
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
131+
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
132+
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="keyword">using</span> AirQualitySensor = SINRICPRO_NAMESPACE::AirQualitySensor&lt;T&gt;;</div>
133+
<div class="ttc" id="aclass_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor_html"><div class="ttname"><a href="class_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor.html">SINRICPRO_2_9_17::AirQualitySensor</a></div><div class="ttdoc">AirQuality.</div><div class="ttdef"><b>Definition:</b> AirQualitySensor.h:19</div></div>
134+
<div class="ttc" id="aclass_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor_html_a733195bdc5b15c858e4e890847b3a0d5"><div class="ttname"><a href="class_s_i_n_r_i_c_p_r_o__2__9__17_1_1_air_quality_sensor.html#a733195bdc5b15c858e4e890847b3a0d5">SINRICPRO_2_9_17::AirQualitySensor::sendAirQualityEvent</a></div><div class="ttdeci">bool sendAirQualityEvent(int pm1=0, int pm2_5=0, int pm10=0, String cause=FSTR_SINRICPRO_PERIODIC_POLL)</div><div class="ttdoc">Sending air quality to SinricPro server.</div><div class="ttdef"><b>Definition:</b> AirQualitySensor.h:43</div></div>
135+
</div><!-- fragment --></div><!-- contents -->
136+
</div><!-- doc-content -->
137+
<!-- start footer part -->
138+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
139+
<ul>
140+
<li class="navelem"><a class="el" href="dir_92f480b6bb910a384a17c290a6146620.html">esp8266-esp32-sdk</a></li><li class="navelem"><a class="el" href="dir_7df6307e8ce44a8864ff8c0ace2ba173.html">src</a></li><li class="navelem"><a class="el" href="dir_aa16df8496461ec3bcf35908592889b5.html">Capabilities</a></li><li class="navelem"><b>AirQualitySensor.h</b></li>
141+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
142+
</ul>
143+
</div>
144+
</body>
145+
</html>

0 commit comments

Comments
 (0)