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

Refactored beta

Browse Source 
+Doxigen autogenerated docs
This commit is contained in:
Andrey Klimov
2020-11-19 23:47:35 +03:00
parent 9fa9e0f481
commit 7bfe7ed330
601 changed files with 70469 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

333
docs/html/classcolor_channel.html Normal file
View File

@@ -0,0 +1,333 @@
<!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: colorChannel Class Reference</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="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
</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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classcolor_channel-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">colorChannel Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="colorchannel_8h_source.html">colorchannel.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for colorChannel:</div>
<div class="dyncontent">
<div class="center">
<img src="classcolor_channel.png" usemap="#colorChannel_map" alt=""/>
<map id="colorChannel_map" name="colorChannel_map">
<area href="classabstract_out.html" alt="abstractOut" shape="rect" coords="98,56,186,80"/>
<area href="classabstract_ch.html" alt="abstractCh" shape="rect" coords="98,0,186,24"/>
<area href="classout__dmx.html" alt="out_dmx" shape="rect" coords="0,168,88,192"/>
<area href="classout__pwm.html" alt="out_pwm" shape="rect" coords="98,168,186,192"/>
<area href="classout___s_p_i_led.html" alt="out_SPILed" shape="rect" coords="196,168,284,192"/>
</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:af5d8c0be99104c65484560a5a1c2cfd2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcolor_channel.html#af5d8c0be99104c65484560a5a1c2cfd2">colorChannel</a> (<a class="el" href="class_item.html">Item</a> *_item)</td></tr>
<tr class="separator:af5d8c0be99104c65484560a5a1c2cfd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d7354cc266c98067b7b43cbf8707feb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcolor_channel.html#a9d7354cc266c98067b7b43cbf8707feb">Ctrl</a> (<a class="el" href="classitem_cmd.html">itemCmd</a> cmd, char *subItem=NULL, bool toExecute=true) override</td></tr>
<tr class="separator:a9d7354cc266c98067b7b43cbf8707feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c835d00ee8af04679f03465617c2873"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcolor_channel.html#a6c835d00ee8af04679f03465617c2873">PixelCtrl</a> (<a class="el" href="classitem_cmd.html">itemCmd</a> cmd, char *subItem=NULL, bool show=true)=0</td></tr>
<tr class="separator:a6c835d00ee8af04679f03465617c2873"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09276ae99835316b9a222df20fb45097"><td class="memItemLeft" align="right" valign="top">short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcolor_channel.html#a09276ae99835316b9a222df20fb45097">getChannelAddr</a> (short n=0)</td></tr>
<tr class="separator:a09276ae99835316b9a222df20fb45097"><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:aec9af01cfc42f385cdf36ce51c8f3387 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#aec9af01cfc42f385cdf36ce51c8f3387">isActive</a> ()</td></tr>
<tr class="separator:aec9af01cfc42f385cdf36ce51c8f3387 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:a3f7033b9cda791ad810c4837ed5909f2 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#a3f7033b9cda791ad810c4837ed5909f2">getChanType</a> ()</td></tr>
<tr class="separator:a3f7033b9cda791ad810c4837ed5909f2 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>
<tr class="memitem:a58f34f5341674622c30f5c005ceadead inherit pub_methods_classabstract_ch"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_ch.html#a58f34f5341674622c30f5c005ceadead">~abstractCh</a> ()</td></tr>
<tr class="separator:a58f34f5341674622c30f5c005ceadead inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a044156a4dc4ca38d3e731b7df23d058a inherit pub_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#a044156a4dc4ca38d3e731b7df23d058a">Poll</a> (short cause)=0</td></tr>
<tr class="separator:a044156a4dc4ca38d3e731b7df23d058a inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaf6346625245be1774a6d27d9cece4e inherit pub_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#aeaf6346625245be1774a6d27d9cece4e">Setup</a> ()=0</td></tr>
<tr class="separator:aeaf6346625245be1774a6d27d9cece4e inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e75f5b76a25accdb1de0c936951a93f inherit pub_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#a2e75f5b76a25accdb1de0c936951a93f">Anounce</a> ()</td></tr>
<tr class="separator:a2e75f5b76a25accdb1de0c936951a93f inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb7b6f4586412a13f8f6ac08061e5ae0 inherit pub_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#afb7b6f4586412a13f8f6ac08061e5ae0">Stop</a> ()</td></tr>
<tr class="separator:afb7b6f4586412a13f8f6ac08061e5ae0 inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefb8821172a2e66f49ea0da9b7c205a5 inherit pub_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#aefb8821172a2e66f49ea0da9b7c205a5">Status</a> ()</td></tr>
<tr class="separator:aefb8821172a2e66f49ea0da9b7c205a5 inherit pub_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a4dd2fa654273b3bf9a3413ee2966fdce"><td class="memItemLeft" align="right" valign="top">short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcolor_channel.html#a4dd2fa654273b3bf9a3413ee2966fdce">iaddr</a></td></tr>
<tr class="separator:a4dd2fa654273b3bf9a3413ee2966fdce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace14fae07b9d51500db5d0191f5a7081"><td class="memItemLeft" align="right" valign="top">short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcolor_channel.html#ace14fae07b9d51500db5d0191f5a7081">numArgs</a></td></tr>
<tr class="separator:ace14fae07b9d51500db5d0191f5a7081"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classabstract_out"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classabstract_out')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classabstract_out.html">abstractOut</a></td></tr>
<tr class="memitem:af93f193ac2f0621d0ba08f1f1d11e8b7 inherit pro_attribs_classabstract_out"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_item.html">Item</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classabstract_out.html#af93f193ac2f0621d0ba08f1f1d11e8b7">item</a></td></tr>
<tr class="separator:af93f193ac2f0621d0ba08f1f1d11e8b7 inherit pro_attribs_classabstract_out"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></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>
<tr class="memitem:ac24cfc96e7efabae120799b7a23680c6 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#ac24cfc96e7efabae120799b7a23680c6">publishTopic</a> (const char *topic, float value, const char *subtopic=NULL)</td></tr>
<tr class="separator:ac24cfc96e7efabae120799b7a23680c6 inherit pro_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9404148b9515bd6c1e167a235d844cb8 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#a9404148b9515bd6c1e167a235d844cb8">publishTopic</a> (const char *topic, const char *value, const char *subtopic=NULL)</td></tr>
<tr class="separator:a9404148b9515bd6c1e167a235d844cb8 inherit pro_methods_classabstract_ch"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af5d8c0be99104c65484560a5a1c2cfd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5d8c0be99104c65484560a5a1c2cfd2">&#9670;&nbsp;</a></span>colorChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">colorChannel::colorChannel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_item.html">Item</a> *&#160;</td>
<td class="paramname"><em>_item</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9d7354cc266c98067b7b43cbf8707feb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d7354cc266c98067b7b43cbf8707feb">&#9670;&nbsp;</a></span>Ctrl()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int colorChannel::Ctrl </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> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>toExecute</em> = <code>true</code>&#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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classabstract_out.html#aacaa5ef80fdc683ef96a4dc80d24692a">abstractOut</a>.</p>
</div>
</div>
<a id="a09276ae99835316b9a222df20fb45097"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09276ae99835316b9a222df20fb45097">&#9670;&nbsp;</a></span>getChannelAddr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">short colorChannel::getChannelAddr </td>
<td>(</td>
<td class="paramtype">short&#160;</td>
<td class="paramname"><em>n</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6c835d00ee8af04679f03465617c2873"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c835d00ee8af04679f03465617c2873">&#9670;&nbsp;</a></span>PixelCtrl()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int colorChannel::PixelCtrl </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> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>show</em> = <code>true</code>&#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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classout___s_p_i_led.html#a75d1e9b7333a0bb9777df807634607b3">out_SPILed</a>, <a class="el" href="classout__pwm.html#adcb4bb3d03aa8c4b7e12796136b5cd1e">out_pwm</a>, and <a class="el" href="classout__dmx.html#ad33a8e316c5c8d409cddf4dcd8b15fcc">out_dmx</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a4dd2fa654273b3bf9a3413ee2966fdce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4dd2fa654273b3bf9a3413ee2966fdce">&#9670;&nbsp;</a></span>iaddr</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">short colorChannel::iaddr</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="ace14fae07b9d51500db5d0191f5a7081"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace14fae07b9d51500db5d0191f5a7081">&#9670;&nbsp;</a></span>numArgs</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">short colorChannel::numArgs</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>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/Users/andrey/Documents/Arduino/lighthub/lighthub/<a class="el" href="colorchannel_8h_source.html">colorchannel.h</a></li>
<li>/Users/andrey/Documents/Arduino/lighthub/lighthub/<a class="el" href="colorchannel_8cpp.html">colorchannel.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- 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>
</body>
</html>