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('item_8cpp.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="summary">
<a href="#define-members">Macros</a> &#124;
@@ -92,60 +110,21 @@ $(function() {
<code>#include &quot;<a class="el" href="out__modbus_8h_source.html">modules/out_modbus.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="out__dmx_8h_source.html">modules/out_dmx.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="out__pwm_8h_source.html">modules/out_pwm.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for item.cpp:</div>
<div class="dyncontent">
<div class="center"><img src="item_8cpp__incl.png" border="0" usemap="#aitem_8cpp" alt=""/></div>
<map name="item_8cpp" id="aitem_8cpp">
<area shape="rect" title=" " alt="" coords="1930,5,2002,32"/>
<area shape="rect" href="options_8h.html" title=" " alt="" coords="2121,304,2195,331"/>
<area shape="rect" href="item_8h.html" title=" " alt="" coords="2246,229,2305,256"/>
<area shape="rect" href="item_cmd_8h.html" title=" " alt="" coords="1939,379,2025,405"/>
<area shape="rect" title=" " alt="" coords="1220,304,1296,331"/>
<area shape="rect" href="utils_8h.html" title=" " alt="" coords="280,155,337,181"/>
<area shape="rect" href="textconst_8h.html" title=" " alt="" coords="413,155,500,181"/>
<area shape="rect" href="main_8h.html" title=" " alt="" coords="1162,80,1223,107"/>
<area shape="rect" title=" " alt="" coords="524,155,643,181"/>
<area shape="rect" href="dmx_8h.html" title=" " alt="" coords="1735,229,1794,256"/>
<area shape="rect" title=" " alt="" coords="1739,155,1852,181"/>
<area shape="rect" href="bright_8h.html" title=" " alt="" coords="5,379,71,405"/>
<area shape="rect" title=" " alt="" coords="2079,80,2218,107"/>
<area shape="rect" href="out__spiled_8h.html" title=" " alt="" coords="2457,80,2603,107"/>
<area shape="rect" href="out__ac_8h.html" title=" " alt="" coords="3041,80,3166,107"/>
<area shape="rect" href="out__motor_8h.html" title=" " alt="" coords="2261,155,2404,181"/>
<area shape="rect" href="out__modbus_8h.html" title=" " alt="" coords="2029,155,2186,181"/>
<area shape="rect" href="out__dmx_8h.html" title=" " alt="" coords="2837,80,2973,107"/>
<area shape="rect" href="out__pwm_8h.html" title=" " alt="" coords="2674,80,2813,107"/>
<area shape="rect" href="abstractout_8h.html" title=" " alt="" coords="2293,304,2391,331"/>
<area shape="rect" title=" " alt="" coords="557,453,634,480"/>
<area shape="rect" href="abstractch_8h.html" title=" " alt="" coords="633,379,728,405"/>
<area shape="rect" title=" " alt="" coords="147,229,239,256"/>
<area shape="rect" title=" " alt="" coords="263,229,355,256"/>
<area shape="rect" href="streamlog_8h.html" title=" " alt="" coords="890,155,981,181"/>
<area shape="rect" title=" " alt="" coords="1459,229,1601,256"/>
<area shape="rect" href="ow_term_8h.html" title=" " alt="" coords="1005,155,1084,181"/>
<area shape="rect" title=" " alt="" coords="1530,155,1613,181"/>
<area shape="rect" title=" " alt="" coords="719,155,773,181"/>
<area shape="rect" title=" " alt="" coords="1160,155,1225,181"/>
<area shape="rect" title=" " alt="" coords="1250,155,1311,181"/>
<area shape="rect" title=" " alt="" coords="1335,155,1405,181"/>
<area shape="rect" href="inputs_8h.html" title=" " alt="" coords="797,155,865,181"/>
<area shape="rect" title=" " alt="" coords="1109,229,1169,256"/>
<area shape="rect" title=" " alt="" coords="859,229,982,256"/>
<area shape="rect" title=" " alt="" coords="1007,229,1085,256"/>
<area shape="rect" title=" " alt="" coords="1020,304,1080,331"/>
<area shape="rect" title=" " alt="" coords="1295,229,1434,256"/>
<area shape="rect" href="in__ccs811__hdc1080_8h.html" title=" " alt="" coords="431,229,632,256"/>
<area shape="rect" href="abstractin_8h.html" title=" " alt="" coords="593,304,683,331"/>
<area shape="rect" title=" " alt="" coords="707,304,878,331"/>
<area shape="rect" title=" " alt="" coords="430,304,569,331"/>
<area shape="rect" href="colorchannel_8h.html" title=" " alt="" coords="2842,155,2949,181"/>
<area shape="rect" title=" " alt="" coords="2530,155,2615,181"/>
</map>
</div>
<code>#include &quot;<a class="el" href="out__pid_8h_source.html">modules/out_pid.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="out__multivent_8h_source.html">modules/out_multivent.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="out__uartbridge_8h_source.html">modules/out_uartbridge.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="out__relay_8h_source.html">modules/out_relay.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a1b4d2d6a1cd821c4d0786a9bb187bcb5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#a1b4d2d6a1cd821c4d0786a9bb187bcb5">M_SUCCESS</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a1b4d2d6a1cd821c4d0786a9bb187bcb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a369b7dc8b8caa3663ab974e2cb516d1e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#a369b7dc8b8caa3663ab974e2cb516d1e">M_FAILED</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a369b7dc8b8caa3663ab974e2cb516d1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1c06288becc5f1b6ea8b5f8f1b71796"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#ae1c06288becc5f1b6ea8b5f8f1b71796">M_BUSY</a>&#160;&#160;&#160;-1</td></tr>
<tr class="separator:ae1c06288becc5f1b6ea8b5f8f1b71796"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0b3354a51086c3c57117e3a9d3ba93b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#ae0b3354a51086c3c57117e3a9d3ba93b">M_CLEAN</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:ae0b3354a51086c3c57117e3a9d3ba93b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d3c3518d793541417a4845125da1ae1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#a8d3c3518d793541417a4845125da1ae1">a</a>&#160;&#160;&#160;0.1842f</td></tr>
<tr class="separator:a8d3c3518d793541417a4845125da1ae1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2d05693952610f937e5acb3c4a8fa1b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#ab2d05693952610f937e5acb3c4a8fa1b">b</a>&#160;&#160;&#160;-36.68f</td></tr>
@@ -159,11 +138,17 @@ Functions</h2></td></tr>
<tr class="separator:a44da304670c8b0446f674b318ebc9294"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac002f1e83a05b79e27bda8f93184bcee"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#ac002f1e83a05b79e27bda8f93184bcee">txt2subItem</a> (char *payload)</td></tr>
<tr class="separator:ac002f1e83a05b79e27bda8f93184bcee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a963219cc65f7345f98d334090edf7353"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#a963219cc65f7345f98d334090edf7353">digGroup</a> (aJsonObject *itemArr, <a class="el" href="classitem_cmd.html">itemCmd</a> *cmd, char *subItem)</td></tr>
<tr class="separator:a963219cc65f7345f98d334090edf7353"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9d9949a0fdfd7de95999113e1523de2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#af9d9949a0fdfd7de95999113e1523de2">printActiveStatus</a> (bool active)</td></tr>
<tr class="separator:af9d9949a0fdfd7de95999113e1523de2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a02d3e5fb154e56cf7fc169649e232078"><td class="memItemLeft" align="right" valign="top">short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#a02d3e5fb154e56cf7fc169649e232078">modbusBusy</a> = 0</td></tr>
<tr class="separator:a02d3e5fb154e56cf7fc169649e232078"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3fdcf970f64cfc745ff5efdc3063f89"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#ad3fdcf970f64cfc745ff5efdc3063f89">isPendedModbusWrites</a> = false</td></tr>
<tr class="separator:ad3fdcf970f64cfc745ff5efdc3063f89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8f2c895949680c2aadc4843bb350347"><td class="memItemLeft" align="right" valign="top">aJsonObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#aa8f2c895949680c2aadc4843bb350347">pollingItem</a></td></tr>
<tr class="separator:aa8f2c895949680c2aadc4843bb350347"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86d63f481644da70f063c2593fcafe19"><td class="memItemLeft" align="right" valign="top">PubSubClient&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#a86d63f481644da70f063c2593fcafe19">mqttClient</a></td></tr>
@@ -174,8 +159,6 @@ Variables</h2></td></tr>
<tr class="separator:a58655351bd1d5333e5eb92d4c29f4263"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bbda7cf303a1bc3222e7a270f9040bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="main_8h.html#a98b39d850b041da059cf5de62463a473">lan_status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#a7bbda7cf303a1bc3222e7a270f9040bd">lanStatus</a></td></tr>
<tr class="separator:a7bbda7cf303a1bc3222e7a270f9040bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcb640867546187e7cbe6229cc3ec872"><td class="memItemLeft" align="right" valign="top">const short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#abcb640867546187e7cbe6229cc3ec872">defval</a> [4] = {0, 0, 0, 0}</td></tr>
<tr class="separator:abcb640867546187e7cbe6229cc3ec872"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed3ca48125de3e138d26fa4884c35c93"><td class="memItemLeft" align="right" valign="top">ModbusMaster&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="item_8cpp.html#aed3ca48125de3e138d26fa4884c35c93">node</a></td></tr>
<tr class="separator:aed3ca48125de3e138d26fa4884c35c93"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
@@ -206,9 +189,117 @@ Variables</h2></td></tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae1c06288becc5f1b6ea8b5f8f1b71796"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1c06288becc5f1b6ea8b5f8f1b71796">&#9670;&nbsp;</a></span>M_BUSY</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define M_BUSY&#160;&#160;&#160;-1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae0b3354a51086c3c57117e3a9d3ba93b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0b3354a51086c3c57117e3a9d3ba93b">&#9670;&nbsp;</a></span>M_CLEAN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define M_CLEAN&#160;&#160;&#160;2</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a369b7dc8b8caa3663ab974e2cb516d1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a369b7dc8b8caa3663ab974e2cb516d1e">&#9670;&nbsp;</a></span>M_FAILED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define M_FAILED&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1b4d2d6a1cd821c4d0786a9bb187bcb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b4d2d6a1cd821c4d0786a9bb187bcb5">&#9670;&nbsp;</a></span>M_SUCCESS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define M_SUCCESS&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a963219cc65f7345f98d334090edf7353"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a963219cc65f7345f98d334090edf7353">&#9670;&nbsp;</a></span>digGroup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool digGroup </td>
<td>(</td>
<td class="paramtype">aJsonObject *&#160;</td>
<td class="paramname"><em>itemArr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classitem_cmd.html">itemCmd</a> *&#160;</td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>subItem</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af9d9949a0fdfd7de95999113e1523de2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9d9949a0fdfd7de95999113e1523de2">&#9670;&nbsp;</a></span>printActiveStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void printActiveStatus </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>active</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4aef78280fd80bcca6d297030691f57b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4aef78280fd80bcca6d297030691f57b">&#9670;&nbsp;</a></span>retrieveCode()</h2>
@@ -284,20 +375,6 @@ Variables</h2></td></tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abcb640867546187e7cbe6229cc3ec872"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abcb640867546187e7cbe6229cc3ec872">&#9670;&nbsp;</a></span>defval</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const short defval[4] = {0, 0, 0, 0}</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a525d99b2753ef2f4055ea4475dbc10d7"></a>
@@ -320,6 +397,20 @@ Variables</h2></td></tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad3fdcf970f64cfc745ff5efdc3063f89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3fdcf970f64cfc745ff5efdc3063f89">&#9670;&nbsp;</a></span>isPendedModbusWrites</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isPendedModbusWrites = false</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7bbda7cf303a1bc3222e7a270f9040bd"></a>
@@ -425,9 +516,13 @@ Variables</h2></td></tr>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- 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="item_8cpp.html">item.cpp</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>