Files
lighthub/docs/html/out__uartbridge_8h_source.html
2022-01-06 02:01:16 +03:00

198 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LightHub: modules/out_uartbridge.h Source File</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="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>
<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="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>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @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('out__uartbridge_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">out_uartbridge.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="out__uartbridge_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="options_8h.html">options.h</a>&quot;</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#ifdef UARTBRIDGE_ENABLE</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="abstractout_8h.html">abstractout.h</a>&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="item_8h.html">item.h</a>&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="item_cmd_8h.html">itemCmd.h</a>&quot;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="utils_8h.html">utils.h</a>&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#if defined(ESP32)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#define serialParamType uint32_t</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#define serialParamType uint16_t</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define SOURCE_PORT_A 5551</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define SOURCE_PORT_B 5552</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define MAX_PDU 64</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef MODULE_UATRBRIDGE_UARTA</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define MODULE_UATRBRIDGE_UARTA Serial1</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef MODULE_UATRBRIDGE_UARTB</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define MODULE_UATRBRIDGE_UARTB Serial2</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#ifndef MODULE_UATRBRIDGE_UARTA_RX_PIN</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define MODULE_UATRBRIDGE_UARTA_RX_PIN 15</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#ifndef MODULE_UATRBRIDGE_UARTA_TX_PIN</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define MODULE_UATRBRIDGE_UARTA_TX_PIN 2</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#ifndef MODULE_UATRBRIDGE_UARTB_RX_PIN</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#define MODULE_UATRBRIDGE_UARTB_RX_PIN -1</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#ifndef MODULE_UATRBRIDGE_UARTB_TX_PIN</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define MODULE_UATRBRIDGE_UARTB_TX_PIN -1</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"> 43</span>&#160;<span class="keyword">class </span>ubPersistent : <span class="keyword">public</span> <a class="code" href="classch_persistent.html">chPersistent</a> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment">// int addr</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; int8_t driverStatus;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">int</span> baud;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="utils_8h.html#af725dabbb9d86c575157b3bbc24d6d55">serialParamType</a> serialParam;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="comment">//uint16_t pollingInterval;</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">//uint32_t timestamp;</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">//aJsonObject * pollingRegisters;</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="comment">//aJsonObject * pollingIrs;</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">//aJsonObject * parameters;</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;};</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#define PDELAY 10 </span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">class </span>out_UARTbridge : <span class="keyword">public</span> <a class="code" href="classabstract_out.html">abstractOut</a> {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; out_UARTbridge(<a class="code" href="class_item.html">Item</a> * _item):<a class="code" href="classabstract_out.html">abstractOut</a>(_item){store = (ubPersistent *) item-&gt;getPersistent();};</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classabstract_out.html#ad84ffc96dafea9cbe5c91f35c90ffe3b">Setup</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#a044156a4dc4ca38d3e731b7df23d058a">Poll</a>(<span class="keywordtype">short</span> cause) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#afb7b6f4586412a13f8f6ac08061e5ae0">Stop</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#aefb8821172a2e66f49ea0da9b7c205a5">Status</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classabstract_out.html#a3f7033b9cda791ad810c4837ed5909f2">getChanType</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classabstract_out.html#aacaa5ef80fdc683ef96a4dc80d24692a">Ctrl</a>(<a class="code" href="classitem_cmd.html">itemCmd</a> cmd, <span class="keywordtype">char</span>* subItem=NULL, <span class="keywordtype">bool</span> toExecute=<span class="keyword">true</span>) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classabstract_out.html#a786157307bd9438b8fbff24421b95330">getDefaultStorageType</a>(){<span class="keywordflow">return</span> <a class="code" href="item_cmd_8h.html#a9bbd91c0ea3ac6af8f0deadcddce706c">ST_INT32</a>;};</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">//int Ctrl(short cmd, short n=0, int * Parameters=NULL, int suffixCode=0, char* subItem=NULL) override;</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; ubPersistent * store;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">bool</span> getConfig();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment">// int findRegister(int registerNum, int posInBuffer, int regType);</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="comment">// void pollModbus(aJsonObject * reg, int regType);</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;};</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassabstract_out_html_aacaa5ef80fdc683ef96a4dc80d24692a"><div class="ttname"><a href="classabstract_out.html#aacaa5ef80fdc683ef96a4dc80d24692a">abstractOut::Ctrl</a></div><div class="ttdeci">virtual int Ctrl(itemCmd cmd, char *subItem=NULL, bool toExecute=true)=0</div></div>
<div class="ttc" id="aitem_cmd_8h_html"><div class="ttname"><a href="item_cmd_8h.html">itemCmd.h</a></div></div>
<div class="ttc" id="aclassitem_cmd_html"><div class="ttname"><a href="classitem_cmd.html">itemCmd</a></div><div class="ttdef"><b>Definition:</b> itemCmd.h:153</div></div>
<div class="ttc" id="aclassabstract_ch_html_afb7b6f4586412a13f8f6ac08061e5ae0"><div class="ttname"><a href="classabstract_ch.html#afb7b6f4586412a13f8f6ac08061e5ae0">abstractCh::Stop</a></div><div class="ttdeci">virtual int Stop()</div><div class="ttdef"><b>Definition:</b> abstractch.h:15</div></div>
<div class="ttc" id="aclassch_persistent_html"><div class="ttname"><a href="classch_persistent.html">chPersistent</a></div><div class="ttdef"><b>Definition:</b> abstractout.h:7</div></div>
<div class="ttc" id="aitem_cmd_8h_html_a9bbd91c0ea3ac6af8f0deadcddce706c"><div class="ttname"><a href="item_cmd_8h.html#a9bbd91c0ea3ac6af8f0deadcddce706c">ST_INT32</a></div><div class="ttdeci">#define ST_INT32</div><div class="ttdef"><b>Definition:</b> itemCmd.h:96</div></div>
<div class="ttc" id="autils_8h_html_af725dabbb9d86c575157b3bbc24d6d55"><div class="ttname"><a href="utils_8h.html#af725dabbb9d86c575157b3bbc24d6d55">serialParamType</a></div><div class="ttdeci">#define serialParamType</div><div class="ttdef"><b>Definition:</b> utils.h:49</div></div>
<div class="ttc" id="aoptions_8h_html"><div class="ttname"><a href="options_8h.html">options.h</a></div></div>
<div class="ttc" id="aclassabstract_out_html"><div class="ttname"><a href="classabstract_out.html">abstractOut</a></div><div class="ttdef"><b>Definition:</b> abstractout.h:8</div></div>
<div class="ttc" id="autils_8h_html"><div class="ttname"><a href="utils_8h.html">utils.h</a></div></div>
<div class="ttc" id="aclassabstract_out_html_a786157307bd9438b8fbff24421b95330"><div class="ttname"><a href="classabstract_out.html#a786157307bd9438b8fbff24421b95330">abstractOut::getDefaultStorageType</a></div><div class="ttdeci">virtual int getDefaultStorageType()</div><div class="ttdef"><b>Definition:</b> abstractout.h:15</div></div>
<div class="ttc" id="aclass_item_html"><div class="ttname"><a href="class_item.html">Item</a></div><div class="ttdef"><b>Definition:</b> item.h:104</div></div>
<div class="ttc" id="aabstractout_8h_html"><div class="ttname"><a href="abstractout_8h.html">abstractout.h</a></div></div>
<div class="ttc" id="aclassabstract_out_html_ad84ffc96dafea9cbe5c91f35c90ffe3b"><div class="ttname"><a href="classabstract_out.html#ad84ffc96dafea9cbe5c91f35c90ffe3b">abstractOut::Setup</a></div><div class="ttdeci">int Setup() override</div><div class="ttdoc">Remove?? Now getChanType used instead.</div><div class="ttdef"><b>Definition:</b> abstractout.cpp:20</div></div>
<div class="ttc" id="aclassabstract_ch_html_a044156a4dc4ca38d3e731b7df23d058a"><div class="ttname"><a href="classabstract_ch.html#a044156a4dc4ca38d3e731b7df23d058a">abstractCh::Poll</a></div><div class="ttdeci">virtual int Poll(short cause)=0</div></div>
<div class="ttc" id="aclassabstract_out_html_a3f7033b9cda791ad810c4837ed5909f2"><div class="ttname"><a href="classabstract_out.html#a3f7033b9cda791ad810c4837ed5909f2">abstractOut::getChanType</a></div><div class="ttdeci">virtual int getChanType()</div><div class="ttdef"><b>Definition:</b> abstractout.h:14</div></div>
<div class="ttc" id="aclassabstract_ch_html_aefb8821172a2e66f49ea0da9b7c205a5"><div class="ttname"><a href="classabstract_ch.html#aefb8821172a2e66f49ea0da9b7c205a5">abstractCh::Status</a></div><div class="ttdeci">virtual int Status()</div><div class="ttdef"><b>Definition:</b> abstractch.h:16</div></div>
<div class="ttc" id="aitem_8h_html"><div class="ttname"><a href="item_8h.html">item.h</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_e05d7e2b1ecd646af5bb94391405f3b5.html">modules</a></li><li class="navelem"><a class="el" href="out__uartbridge_8h.html">out_uartbridge.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>