doxigen docs

This commit is contained in:
2022-01-06 02:01:16 +03:00
parent 6fe28695f2
commit 07046680e0
628 changed files with 37077 additions and 10502 deletions

View File

@@ -9,6 +9,10 @@
<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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
@@ -23,7 +27,9 @@
<td id="projectlogo"><img alt="Logo" src="lh.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">LightHub
&#160;<span id="projectnumber">v4.0.0</span>
</div>
<div id="projectbrief">Smarthome controller firmware</div>
</td>
</tr>
</tbody>
@@ -46,6 +52,23 @@ $(function() {
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('statusled_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -60,11 +83,6 @@ $(function() {
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_82d7c1f210290ade9e0671f857ad27e3.html">lighthub</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">statusled.h</div> </div>
@@ -102,34 +120,44 @@ $(function() {
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="statusled_8h.html#aa68d61961165bd42444cba4dcefb4726"> 30</a></span>&#160;<span class="preprocessor">#define ledFlash 32</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="statusled_8h.html#a3e8259c89abd4a7013c4bc87274e09c7"> 31</a></span>&#160;<span class="preprocessor">#define ledHidden 64</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="statusled_8h.html#afd1828ca857e3e7e8216fb55eb761ca0"> 33</a></span>&#160;<span class="preprocessor">#define pinRED 50</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="statusled_8h.html#a813708e0211b3df165cce073367b4935"> 34</a></span>&#160;<span class="preprocessor">#define pinGREEN 51</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="statusled_8h.html#a2ad8c4dedfb08572b319c83ba9f42e90"> 35</a></span>&#160;<span class="preprocessor">#define pinBLUE 52</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="statusled_8h.html#aaf229718aeb968c22e9aa6f593817c99"> 37</a></span>&#160;<span class="preprocessor">#define ledDelayms 1000UL</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="statusled_8h.html#aff5146ea744dbe707098bdb5cdca32a6"> 38</a></span>&#160;<span class="preprocessor">#define ledFastDelayms 300UL</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classstatus_l_e_d.html"> 40</a></span>&#160;<span class="keyword">class </span><a class="code" href="classstatus_l_e_d.html">statusLED</a> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="classstatus_l_e_d.html#ae9a8652af566b29edf336fff51e239e1">statusLED</a>(uint8_t pattern = 0);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classstatus_l_e_d.html#a3e1eff776b7ffdac123d76b7419c89e6">set</a> (uint8_t pattern);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classstatus_l_e_d.html#a611fa4b90edb00fa5b42923ea091cd9c">show</a> (uint8_t pattern);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classstatus_l_e_d.html#a9692bced087cfc8a27f5a19601ebfc6e">poll</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classstatus_l_e_d.html#a84044dc9116245b50a8c45792772dd7f">flash</a>(uint8_t pattern);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; uint8_t curStat;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; uint32_t timestamp;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;};</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#if defined(ARDUINO_ARCH_AVR)</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define pinRED 47</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#define pinGREEN 48</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#define pinBLUE 49</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="statusled_8h.html#afd1828ca857e3e7e8216fb55eb761ca0"> 38</a></span>&#160;<span class="preprocessor">#define pinRED 50</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="statusled_8h.html#a813708e0211b3df165cce073367b4935"> 39</a></span>&#160;<span class="preprocessor">#define pinGREEN 51</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="statusled_8h.html#a2ad8c4dedfb08572b319c83ba9f42e90"> 40</a></span>&#160;<span class="preprocessor">#define pinBLUE 52</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="statusled_8h.html#aaf229718aeb968c22e9aa6f593817c99"> 43</a></span>&#160;<span class="preprocessor">#define ledDelayms 1000UL</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="statusled_8h.html#aff5146ea744dbe707098bdb5cdca32a6"> 44</a></span>&#160;<span class="preprocessor">#define ledFastDelayms 300UL</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="class_status_l_e_d.html"> 46</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_status_l_e_d.html">StatusLED</a> {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="class_status_l_e_d.html#a36991d2474108cf36a05a3c715c3c19c">StatusLED</a>(uint8_t pattern = 0);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_status_l_e_d.html#a115462c3b2fc7e18e267c28e89f25990">set</a> (uint8_t pattern);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_status_l_e_d.html#a41b59458f9f6650ed5cc3a5de3c5b3ef">show</a> (uint8_t pattern);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_status_l_e_d.html#a2ade58307b4dc5c8695e284ee681855d">poll</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_status_l_e_d.html#a2e5a30f3dbe4959c00d592e321e13cf5">flash</a>(uint8_t pattern);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; uint8_t curStat;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; uint32_t timestamp;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;};</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassstatus_l_e_d_html_a9692bced087cfc8a27f5a19601ebfc6e"><div class="ttname"><a href="classstatus_l_e_d.html#a9692bced087cfc8a27f5a19601ebfc6e">statusLED::poll</a></div><div class="ttdeci">void poll()</div><div class="ttdef"><b>Definition:</b> statusled.cpp:66</div></div>
<div class="ttc" id="aclassstatus_l_e_d_html_ae9a8652af566b29edf336fff51e239e1"><div class="ttname"><a href="classstatus_l_e_d.html#ae9a8652af566b29edf336fff51e239e1">statusLED::statusLED</a></div><div class="ttdeci">statusLED(uint8_t pattern=0)</div><div class="ttdef"><b>Definition:</b> statusled.cpp:24</div></div>
<div class="ttc" id="aclassstatus_l_e_d_html_a84044dc9116245b50a8c45792772dd7f"><div class="ttname"><a href="classstatus_l_e_d.html#a84044dc9116245b50a8c45792772dd7f">statusLED::flash</a></div><div class="ttdeci">void flash(uint8_t pattern)</div><div class="ttdef"><b>Definition:</b> statusled.cpp:58</div></div>
<div class="ttc" id="aclassstatus_l_e_d_html_a3e1eff776b7ffdac123d76b7419c89e6"><div class="ttname"><a href="classstatus_l_e_d.html#a3e1eff776b7ffdac123d76b7419c89e6">statusLED::set</a></div><div class="ttdeci">void set(uint8_t pattern)</div><div class="ttdef"><b>Definition:</b> statusled.cpp:44</div></div>
<div class="ttc" id="aclassstatus_l_e_d_html"><div class="ttname"><a href="classstatus_l_e_d.html">statusLED</a></div><div class="ttdef"><b>Definition:</b> statusled.h:40</div></div>
<div class="ttc" id="aclassstatus_l_e_d_html_a611fa4b90edb00fa5b42923ea091cd9c"><div class="ttname"><a href="classstatus_l_e_d.html#a611fa4b90edb00fa5b42923ea091cd9c">statusLED::show</a></div><div class="ttdeci">void show(uint8_t pattern)</div><div class="ttdef"><b>Definition:</b> statusled.cpp:35</div></div>
</div><!-- doc-content -->
<div class="ttc" id="aclass_status_l_e_d_html_a2e5a30f3dbe4959c00d592e321e13cf5"><div class="ttname"><a href="class_status_l_e_d.html#a2e5a30f3dbe4959c00d592e321e13cf5">StatusLED::flash</a></div><div class="ttdeci">void flash(uint8_t pattern)</div><div class="ttdef"><b>Definition:</b> statusled.cpp:59</div></div>
<div class="ttc" id="aclass_status_l_e_d_html_a36991d2474108cf36a05a3c715c3c19c"><div class="ttname"><a href="class_status_l_e_d.html#a36991d2474108cf36a05a3c715c3c19c">StatusLED::StatusLED</a></div><div class="ttdeci">StatusLED(uint8_t pattern=0)</div><div class="ttdef"><b>Definition:</b> statusled.cpp:25</div></div>
<div class="ttc" id="aclass_status_l_e_d_html_a115462c3b2fc7e18e267c28e89f25990"><div class="ttname"><a href="class_status_l_e_d.html#a115462c3b2fc7e18e267c28e89f25990">StatusLED::set</a></div><div class="ttdeci">void set(uint8_t pattern)</div><div class="ttdef"><b>Definition:</b> statusled.cpp:45</div></div>
<div class="ttc" id="aclass_status_l_e_d_html_a2ade58307b4dc5c8695e284ee681855d"><div class="ttname"><a href="class_status_l_e_d.html#a2ade58307b4dc5c8695e284ee681855d">StatusLED::poll</a></div><div class="ttdeci">void poll()</div><div class="ttdef"><b>Definition:</b> statusled.cpp:67</div></div>
<div class="ttc" id="aclass_status_l_e_d_html_a41b59458f9f6650ed5cc3a5de3c5b3ef"><div class="ttname"><a href="class_status_l_e_d.html#a41b59458f9f6650ed5cc3a5de3c5b3ef">StatusLED::show</a></div><div class="ttdeci">void show(uint8_t pattern)</div><div class="ttdef"><b>Definition:</b> statusled.cpp:36</div></div>
<div class="ttc" id="aclass_status_l_e_d_html"><div class="ttname"><a href="class_status_l_e_d.html">StatusLED</a></div><div class="ttdef"><b>Definition:</b> statusled.h:46</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="statusled_8h.html">statusled.h</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>