andry/lighthub
1
0
Fork 0
mirror of https://github.com/anklimov/lighthub synced 2025-12-07 04:09:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

doxigen docs

Browse Source
This commit is contained in:
Andrey Klimov
2022-01-06 02:01:16 +03:00
parent 6fe28695f2
commit 07046680e0
628 changed files with 37077 additions and 10502 deletions
Download Patch File Download Diff File Expand all files Collapse all files

149
docs/html/classout___modbus.html
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('classout___modbus.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -60,7 +83,6 @@ $(function() {
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
@@ -76,32 +98,20 @@ $(function() {
<div class="dynheader">
Inheritance diagram for out_Modbus:</div>
<div class="dyncontent">
<div class="center"><img src="classout___modbus__inherit__graph.png" border="0" usemap="#aout___modbus_inherit__map" alt="Inheritance graph"/></div>
<map name="out___modbus_inherit__map" id="aout___modbus_inherit__map">
<area shape="rect" title=" " alt="" coords="5,155,99,181"/>
<area shape="rect" href="classabstract_out.html" title=" " alt="" coords="7,80,97,107"/>
<area shape="rect" href="classabstract_ch.html" title=" " alt="" coords="9,5,95,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for out_Modbus:</div>
<div class="dyncontent">
<div class="center"><img src="classout___modbus__coll__graph.png" border="0" usemap="#aout___modbus_coll__map" alt="Collaboration graph"/></div>
<map name="out___modbus_coll__map" id="aout___modbus_coll__map">
<area shape="rect" title=" " alt="" coords="100,171,193,197"/>
<area shape="rect" href="classabstract_out.html" title=" " alt="" coords="14,81,105,108"/>
<area shape="rect" href="class_item.html" title=" " alt="" coords="17,171,65,197"/>
<area shape="rect" href="classabstract_ch.html" title=" " alt="" coords="16,5,103,32"/>
<area shape="rect" href="classmb_persistent.html" title=" " alt="" coords="129,81,228,108"/>
<area shape="rect" href="classch_persistent.html" title=" " alt="" coords="131,5,226,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="center">
<img src="classout___modbus.png" usemap="#out_5FModbus_map" alt=""/>
<map id="out_5FModbus_map" name="out_5FModbus_map">
<area href="classabstract_out.html" alt="abstractOut" shape="rect" coords="0,56,81,80"/>
<area href="classabstract_ch.html" alt="abstractCh" shape="rect" coords="0,0,81,24"/>
</map>
</div></div>
<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:ad5aff68ec31c500be860a4f56b095373"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#ad5aff68ec31c500be860a4f56b095373">out_Modbus</a> (<a class="el" href="class_item.html">Item</a> *_item)</td></tr>
<tr class="separator:ad5aff68ec31c500be860a4f56b095373"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf5452aac576901614eca795ab4ca440"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#acf5452aac576901614eca795ab4ca440">Setup</a> () override</td></tr>
<tr class="memdesc:acf5452aac576901614eca795ab4ca440"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove?? Now getChanType used instead. <a href="classout___modbus.html#acf5452aac576901614eca795ab4ca440">More...</a><br /></td></tr>
<tr class="separator:acf5452aac576901614eca795ab4ca440"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec6803a6033403f8ac4038236cac5cd9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#aec6803a6033403f8ac4038236cac5cd9">Poll</a> (short cause) override</td></tr>
<tr class="separator:aec6803a6033403f8ac4038236cac5cd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -109,17 +119,21 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a9cb4b395f5f8a6d15dcc429664a4174b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc0fc0ecdb6928cfc7906986b8139780"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#acc0fc0ecdb6928cfc7906986b8139780">Status</a> () override</td></tr>
<tr class="separator:acc0fc0ecdb6928cfc7906986b8139780"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b94efbbbbea5a4ad3b489dba8f9b268"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#a6b94efbbbbea5a4ad3b489dba8f9b268">isActive</a> () override</td></tr>
<tr class="separator:a6b94efbbbbea5a4ad3b489dba8f9b268"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2752cf2376840f3763572963be8785db"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#a2752cf2376840f3763572963be8785db">getChanType</a> () override</td></tr>
<tr class="separator:a2752cf2376840f3763572963be8785db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a784be57c40d67b41488b9585fe792019"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#a784be57c40d67b41488b9585fe792019">Ctrl</a> (<a class="el" href="classitem_cmd.html">itemCmd</a> cmd, char *subItem=NULL, bool toExecute=true) override</td></tr>
<tr class="memdesc:a784be57c40d67b41488b9585fe792019"><td class="mdescLeft">&#160;</td><td class="mdescRight">Control unified Modbus item <br />
<a href="classout___modbus.html#a784be57c40d67b41488b9585fe792019">More...</a><br /></td></tr>
<tr class="separator:a784be57c40d67b41488b9585fe792019"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a844c63be065d02f2f178399519b03245"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#a844c63be065d02f2f178399519b03245">getDefaultStorageType</a> ()</td></tr>
<tr class="separator:a844c63be065d02f2f178399519b03245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classabstract_out"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classabstract_out')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classabstract_out.html">abstractOut</a></td></tr>
<tr class="memitem:adec371468752bd5027c282cf933ba035 inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#adec371468752bd5027c282cf933ba035">abstractOut</a> (<a class="el" href="class_item.html">Item</a> *_item)</td></tr>
<tr class="separator:adec371468752bd5027c282cf933ba035 inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedf98f968abc36332dcddb7eab00fe13 inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#aedf98f968abc36332dcddb7eab00fe13">getDefaultOnVal</a> ()</td></tr>
<tr class="separator:aedf98f968abc36332dcddb7eab00fe13 inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4d536357ee52043a4d338ce2106350e inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#af4d536357ee52043a4d338ce2106350e">isActive</a> ()</td></tr>
<tr class="separator:af4d536357ee52043a4d338ce2106350e inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade514d6b6152e87a70d66932c74e1656 inherit pub_methods_classabstract_out"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classitem_cmd.html">itemCmd</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#ade514d6b6152e87a70d66932c74e1656">getDefaultOnVal</a> ()</td></tr>
<tr class="separator:ade514d6b6152e87a70d66932c74e1656 inherit pub_methods_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classabstract_ch"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classabstract_ch')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classabstract_ch.html">abstractCh</a></td></tr>
<tr class="memitem:a8f13aa9c0f6749f7f064d1930667aaed inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a8f13aa9c0f6749f7f064d1930667aaed">abstractCh</a> ()</td></tr>
<tr class="separator:a8f13aa9c0f6749f7f064d1930667aaed inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -132,8 +146,10 @@ Public Member Functions</h2></td></tr>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aea16d64ad349120558951f92205d5249"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#aea16d64ad349120558951f92205d5249">getConfig</a> ()</td></tr>
<tr class="separator:aea16d64ad349120558951f92205d5249"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a026f3ad193b151565f70a72d1c8ca48b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#a026f3ad193b151565f70a72d1c8ca48b">findRegister</a> (int registerNum, int posInBuffer)</td></tr>
<tr class="separator:a026f3ad193b151565f70a72d1c8ca48b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa347eb3b465ef05c3430a0d2076c4d49"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#aa347eb3b465ef05c3430a0d2076c4d49">findRegister</a> (int registerNum, int posInBuffer, int regType)</td></tr>
<tr class="separator:aa347eb3b465ef05c3430a0d2076c4d49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d1bd45dc65b511db41aaf5eadb4ab0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classout___modbus.html#a7d1bd45dc65b511db41aaf5eadb4ab0e">pollModbus</a> (aJsonObject *reg, int regType)</td></tr>
<tr class="separator:a7d1bd45dc65b511db41aaf5eadb4ab0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classabstract_ch"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classabstract_ch')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classabstract_ch.html">abstractCh</a></td></tr>
<tr class="memitem:a4f1da04403789b710ca3929c57af9d32 inherit pro_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a4f1da04403789b710ca3929c57af9d32">publishTopic</a> (const char *topic, long value, const char *subtopic=NULL)</td></tr>
<tr class="separator:a4f1da04403789b710ca3929c57af9d32 inherit pro_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -218,12 +234,15 @@ Protected Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Control unified Modbus item <br />
</p>
<p>Implements <a class="el" href="classabstract_out.html#aacaa5ef80fdc683ef96a4dc80d24692a">abstractOut</a>.</p>
</div>
</div>
<a id="a026f3ad193b151565f70a72d1c8ca48b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a026f3ad193b151565f70a72d1c8ca48b">&#9670;&nbsp;</a></span>findRegister()</h2>
<a id="aa347eb3b465ef05c3430a0d2076c4d49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa347eb3b465ef05c3430a0d2076c4d49">&#9670;&nbsp;</a></span>findRegister()</h2>
<div class="memitem">
<div class="memproto">
@@ -241,7 +260,13 @@ Protected Attributes</h2></td></tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>posInBuffer</em>&#160;</td>
<td class="paramname"><em>posInBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>regType</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -310,8 +335,8 @@ Protected Attributes</h2></td></tr>
</div>
</div>
<a id="a6b94efbbbbea5a4ad3b489dba8f9b268"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b94efbbbbea5a4ad3b489dba8f9b268">&#9670;&nbsp;</a></span>isActive()</h2>
<a id="a844c63be065d02f2f178399519b03245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a844c63be065d02f2f178399519b03245">&#9670;&nbsp;</a></span>getDefaultStorageType()</h2>
<div class="memitem">
<div class="memproto">
@@ -320,7 +345,7 @@ Protected Attributes</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int out_Modbus::isActive </td>
<td class="memname">int out_Modbus::getDefaultStorageType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
@@ -328,12 +353,12 @@ Protected Attributes</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classabstract_out.html#aec9af01cfc42f385cdf36ce51c8f3387">abstractOut</a>.</p>
<p>Reimplemented from <a class="el" href="classabstract_out.html#a786157307bd9438b8fbff24421b95330">abstractOut</a>.</p>
</div>
</div>
@@ -363,6 +388,42 @@ Protected Attributes</h2></td></tr>
<p>Implements <a class="el" href="classabstract_ch.html#a044156a4dc4ca38d3e731b7df23d058a">abstractCh</a>.</p>
</div>
</div>
<a id="a7d1bd45dc65b511db41aaf5eadb4ab0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d1bd45dc65b511db41aaf5eadb4ab0e">&#9670;&nbsp;</a></span>pollModbus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void out_Modbus::pollModbus </td>
<td>(</td>
<td class="paramtype">aJsonObject *&#160;</td>
<td class="paramname"><em>reg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>regType</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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>
<a id="acf5452aac576901614eca795ab4ca440"></a>
@@ -388,7 +449,9 @@ Protected Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classabstract_ch.html#aeaf6346625245be1774a6d27d9cece4e">abstractCh</a>.</p>
<p>Remove?? Now getChanType used instead. </p>
<p>Reimplemented from <a class="el" href="classabstract_out.html#ad84ffc96dafea9cbe5c91f35c90ffe3b">abstractOut</a>.</p>
</div>
</div>
@@ -470,13 +533,17 @@ Protected Attributes</h2></td></tr>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="out__modbus_8h_source.html">out_modbus.h</a></li>
<li><a class="el" href="out__modbus_8cpp.html">out_modbus.cpp</a></li>
<li>modules/<a class="el" href="out__modbus_8h_source.html">out_modbus.h</a></li>
<li>modules/<a class="el" href="out__modbus_8cpp.html">out_modbus.cpp</a></li>
</ul>
</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="classout___modbus.html">out_Modbus</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>