mirror of
https://github.com/anklimov/lighthub
synced 2025-12-06 11:49:51 +03:00
136 lines
13 KiB
HTML
136 lines
13 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: abstractch.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
|
|
 <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&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('abstractch_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">abstractch.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="abstractch_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> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#include "Arduino.h"</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"><a class="line" href="abstractch_8h.html#ad5c9fbfc15fa16113c539de3867f54fc"> 4</a></span> <span class="preprocessor">#define CST_UNKNOWN 0</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"><a class="line" href="abstractch_8h.html#ab7dea1d4d49f436619dd52ce3da0d6c3"> 5</a></span> <span class="preprocessor">#define CST_INITIALIZED 1</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="abstractch_8h.html#adcf23ecf1f6e4dbc5a6780645425399e"> 6</a></span> <span class="preprocessor">#define CST_FAILED 2</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="classabstract_ch.html"> 8</a></span> <span class="keyword">class </span><a class="code" href="classabstract_ch.html">abstractCh</a> {</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="classabstract_ch.html#a8f13aa9c0f6749f7f064d1930667aaed"> 10</a></span>  <a class="code" href="classabstract_ch.html#a8f13aa9c0f6749f7f064d1930667aaed">abstractCh</a>(){};</div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="classabstract_ch.html#a58f34f5341674622c30f5c005ceadead"> 11</a></span>  <span class="keyword">virtual</span> <a class="code" href="classabstract_ch.html#a58f34f5341674622c30f5c005ceadead">~abstractCh</a>(){};</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="classabstract_ch.html#a044156a4dc4ca38d3e731b7df23d058a"> 12</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#a044156a4dc4ca38d3e731b7df23d058a">Poll</a>(<span class="keywordtype">short</span> cause) = 0;</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classabstract_ch.html#aeaf6346625245be1774a6d27d9cece4e"> 13</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#aeaf6346625245be1774a6d27d9cece4e">Setup</a>() =0; <span class="comment">//Should initialize hardware and reserve resources</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classabstract_ch.html#a2e75f5b76a25accdb1de0c936951a93f"> 14</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#a2e75f5b76a25accdb1de0c936951a93f">Anounce</a> () {<span class="keywordflow">return</span> 0;};</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="classabstract_ch.html#afb7b6f4586412a13f8f6ac08061e5ae0"> 15</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#afb7b6f4586412a13f8f6ac08061e5ae0">Stop</a>() {<span class="keywordflow">return</span> 0;}; <span class="comment">//Should free resources</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classabstract_ch.html#aefb8821172a2e66f49ea0da9b7c205a5"> 16</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#aefb8821172a2e66f49ea0da9b7c205a5">Status</a>() {<span class="keywordflow">return</span> <a class="code" href="abstractch_8h.html#ad5c9fbfc15fa16113c539de3867f54fc">CST_UNKNOWN</a>;}</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#a4f1da04403789b710ca3929c57af9d32">publishTopic</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* topic, <span class="keywordtype">long</span> value, <span class="keyword">const</span> <span class="keywordtype">char</span>* subtopic = NULL);</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#a4f1da04403789b710ca3929c57af9d32">publishTopic</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* topic, <span class="keywordtype">float</span> value, <span class="keyword">const</span> <span class="keywordtype">char</span>* subtopic = NULL );</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classabstract_ch.html#a4f1da04403789b710ca3929c57af9d32">publishTopic</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* topic, <span class="keyword">const</span> <span class="keywordtype">char</span> * value, <span class="keyword">const</span> <span class="keywordtype">char</span>* subtopic = NULL);</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">//friend Input;</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> };</div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclassabstract_ch_html_a2e75f5b76a25accdb1de0c936951a93f"><div class="ttname"><a href="classabstract_ch.html#a2e75f5b76a25accdb1de0c936951a93f">abstractCh::Anounce</a></div><div class="ttdeci">virtual int Anounce()</div><div class="ttdef"><b>Definition:</b> abstractch.h:14</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="aabstractch_8h_html_ad5c9fbfc15fa16113c539de3867f54fc"><div class="ttname"><a href="abstractch_8h.html#ad5c9fbfc15fa16113c539de3867f54fc">CST_UNKNOWN</a></div><div class="ttdeci">#define CST_UNKNOWN</div><div class="ttdef"><b>Definition:</b> abstractch.h:4</div></div>
|
|
<div class="ttc" id="aclassabstract_ch_html"><div class="ttname"><a href="classabstract_ch.html">abstractCh</a></div><div class="ttdef"><b>Definition:</b> abstractch.h:8</div></div>
|
|
<div class="ttc" id="aclassabstract_ch_html_a8f13aa9c0f6749f7f064d1930667aaed"><div class="ttname"><a href="classabstract_ch.html#a8f13aa9c0f6749f7f064d1930667aaed">abstractCh::abstractCh</a></div><div class="ttdeci">abstractCh()</div><div class="ttdef"><b>Definition:</b> abstractch.h:10</div></div>
|
|
<div class="ttc" id="aclassabstract_ch_html_aeaf6346625245be1774a6d27d9cece4e"><div class="ttname"><a href="classabstract_ch.html#aeaf6346625245be1774a6d27d9cece4e">abstractCh::Setup</a></div><div class="ttdeci">virtual int Setup()=0</div></div>
|
|
<div class="ttc" id="aclassabstract_ch_html_a58f34f5341674622c30f5c005ceadead"><div class="ttname"><a href="classabstract_ch.html#a58f34f5341674622c30f5c005ceadead">abstractCh::~abstractCh</a></div><div class="ttdeci">virtual ~abstractCh()</div><div class="ttdef"><b>Definition:</b> abstractch.h:11</div></div>
|
|
<div class="ttc" id="aclassabstract_ch_html_a4f1da04403789b710ca3929c57af9d32"><div class="ttname"><a href="classabstract_ch.html#a4f1da04403789b710ca3929c57af9d32">abstractCh::publishTopic</a></div><div class="ttdeci">virtual int publishTopic(const char *topic, long value, const char *subtopic=NULL)</div><div class="ttdef"><b>Definition:</b> abstractch.cpp:12</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_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>
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="abstractch_8h.html">abstractch.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>
|