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

142
docs/html/out__motor_8h_source.html Normal file
View File

@@ -0,0 +1,142 @@
<!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: /Users/andrey/Documents/Arduino/lighthub/lighthub/modules/out_motor.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="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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_82d7c1f210290ade9e0671f857ad27e3.html">lighthub</a></li><li class="navelem"><a class="el" href="dir_a26efa385a8243117251e7dce4d75390.html">modules</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">out_motor.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="out__motor_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">#ifndef MOTOR_DISABLE</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; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef POS_ERR</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="out__motor_8h.html#abf9aa60d6eb4e068e3f5907f04371dc2"> 8</a></span>&#160;<span class="preprocessor">#define POS_ERR 2</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// The number of simultaniusly working motors</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#ifndef MOTOR_QUOTE</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="out__motor_8h.html#a1ae2d51e9799d2a525499bd722676e3c"> 13</a></span>&#160;<span class="preprocessor">#define MOTOR_QUOTE 2</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">static</span> int8_t motorQuote = <a class="code" href="out__motor_8h.html#a1ae2d51e9799d2a525499bd722676e3c">MOTOR_QUOTE</a>;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classout___motor.html"> 18</a></span>&#160;<span class="keyword">class </span><a class="code" href="classout___motor.html">out_Motor</a> : <span class="keyword">public</span> <a class="code" href="classabstract_out.html">abstractOut</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classout___motor.html#a7698763731e54149861a9bdcc18e6344"> 21</a></span>&#160; <a class="code" href="classout___motor.html#a7698763731e54149861a9bdcc18e6344">out_Motor</a>(<a class="code" href="class_item.html">Item</a> * _item):<a class="code" href="classabstract_out.html">abstractOut</a>(_item){<a class="code" href="classout___motor.html#a7ba2681d317e29a412e44741ae1ff5e4">getConfig</a>();};</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classout___motor.html#ab9f2b433a4fedd6fec5b9cb504b934f4">Setup</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classout___motor.html#a7a98c58b6c32cc20b7b05ad07a07c231">Poll</a>(<span class="keywordtype">short</span> cause) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classout___motor.html#aafdbaaaf47776dd8c0c5d6bfa32bb3c2">Stop</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classout___motor.html#a47de22f0ce071787ac14a19897337cea">Status</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classout___motor.html#ac2a224d74421c1a28d34a83779a45bdc">isActive</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classout___motor.html#afd67d9b6e08f14074a236d5222809226">getChanType</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</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="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classout___motor.html#aa731e4d1848e07ac7dc4a99a0ddad942">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="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classout___motor.html#aaa2493a4399f63fd8d17e37f0c731791"> 31</a></span>&#160; int8_t <a class="code" href="classout___motor.html#aaa2493a4399f63fd8d17e37f0c731791">pinUp</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classout___motor.html#af21db4b38c3676a038c93d403b227152"> 32</a></span>&#160; int8_t <a class="code" href="classout___motor.html#af21db4b38c3676a038c93d403b227152">pinDown</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classout___motor.html#ae4052839e88ca4a59e83c35400d239cf"> 33</a></span>&#160; int8_t <a class="code" href="classout___motor.html#ae4052839e88ca4a59e83c35400d239cf">pinFeedback</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classout___motor.html#a58e72bff70d2915b7b508d0605a082e8"> 34</a></span>&#160; int16_t <a class="code" href="classout___motor.html#a58e72bff70d2915b7b508d0605a082e8">maxOnTime</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classout___motor.html#aa002cd716f47ee74a72dcd4e335b80ae"> 35</a></span>&#160; uint16_t <a class="code" href="classout___motor.html#aa002cd716f47ee74a72dcd4e335b80ae">feedbackOpen</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classout___motor.html#ad8179a6054b692c3f00c5fa350f59e3f"> 36</a></span>&#160; uint16_t <a class="code" href="classout___motor.html#ad8179a6054b692c3f00c5fa350f59e3f">feedbackClosed</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classout___motor.html#a7ba2681d317e29a412e44741ae1ff5e4">getConfig</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;};</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassout___motor_html_ae4052839e88ca4a59e83c35400d239cf"><div class="ttname"><a href="classout___motor.html#ae4052839e88ca4a59e83c35400d239cf">out_Motor::pinFeedback</a></div><div class="ttdeci">int8_t pinFeedback</div><div class="ttdef"><b>Definition:</b> out_motor.h:33</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:174</div></div>
<div class="ttc" id="aclassout___motor_html_ac2a224d74421c1a28d34a83779a45bdc"><div class="ttname"><a href="classout___motor.html#ac2a224d74421c1a28d34a83779a45bdc">out_Motor::isActive</a></div><div class="ttdeci">int isActive() override</div><div class="ttdef"><b>Definition:</b> out_motor.cpp:67</div></div>
<div class="ttc" id="aclassout___motor_html_ad8179a6054b692c3f00c5fa350f59e3f"><div class="ttname"><a href="classout___motor.html#ad8179a6054b692c3f00c5fa350f59e3f">out_Motor::feedbackClosed</a></div><div class="ttdeci">uint16_t feedbackClosed</div><div class="ttdef"><b>Definition:</b> out_motor.h:36</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="aclassout___motor_html_a7ba2681d317e29a412e44741ae1ff5e4"><div class="ttname"><a href="classout___motor.html#a7ba2681d317e29a412e44741ae1ff5e4">out_Motor::getConfig</a></div><div class="ttdeci">void getConfig()</div><div class="ttdef"><b>Definition:</b> out_motor.cpp:13</div></div>
<div class="ttc" id="aclassout___motor_html_aa002cd716f47ee74a72dcd4e335b80ae"><div class="ttname"><a href="classout___motor.html#aa002cd716f47ee74a72dcd4e335b80ae">out_Motor::feedbackOpen</a></div><div class="ttdeci">uint16_t feedbackOpen</div><div class="ttdef"><b>Definition:</b> out_motor.h:35</div></div>
<div class="ttc" id="aclassout___motor_html_a47de22f0ce071787ac14a19897337cea"><div class="ttname"><a href="classout___motor.html#a47de22f0ce071787ac14a19897337cea">out_Motor::Status</a></div><div class="ttdeci">int Status() override</div><div class="ttdef"><b>Definition:</b> out_motor.cpp:62</div></div>
<div class="ttc" id="aclassout___motor_html_ab9f2b433a4fedd6fec5b9cb504b934f4"><div class="ttname"><a href="classout___motor.html#ab9f2b433a4fedd6fec5b9cb504b934f4">out_Motor::Setup</a></div><div class="ttdeci">int Setup() override</div><div class="ttdef"><b>Definition:</b> out_motor.cpp:35</div></div>
<div class="ttc" id="aclassout___motor_html"><div class="ttname"><a href="classout___motor.html">out_Motor</a></div><div class="ttdef"><b>Definition:</b> out_motor.h:18</div></div>
<div class="ttc" id="aclassout___motor_html_af21db4b38c3676a038c93d403b227152"><div class="ttname"><a href="classout___motor.html#af21db4b38c3676a038c93d403b227152">out_Motor::pinDown</a></div><div class="ttdeci">int8_t pinDown</div><div class="ttdef"><b>Definition:</b> out_motor.h:32</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:92</div></div>
<div class="ttc" id="aclassout___motor_html_aaa2493a4399f63fd8d17e37f0c731791"><div class="ttname"><a href="classout___motor.html#aaa2493a4399f63fd8d17e37f0c731791">out_Motor::pinUp</a></div><div class="ttdeci">int8_t pinUp</div><div class="ttdef"><b>Definition:</b> out_motor.h:31</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="aclassout___motor_html_a58e72bff70d2915b7b508d0605a082e8"><div class="ttname"><a href="classout___motor.html#a58e72bff70d2915b7b508d0605a082e8">out_Motor::maxOnTime</a></div><div class="ttdeci">int16_t maxOnTime</div><div class="ttdef"><b>Definition:</b> out_motor.h:34</div></div>
<div class="ttc" id="aclassout___motor_html_aafdbaaaf47776dd8c0c5d6bfa32bb3c2"><div class="ttname"><a href="classout___motor.html#aafdbaaaf47776dd8c0c5d6bfa32bb3c2">out_Motor::Stop</a></div><div class="ttdeci">int Stop() override</div><div class="ttdef"><b>Definition:</b> out_motor.cpp:52</div></div>
<div class="ttc" id="aout__motor_8h_html_a1ae2d51e9799d2a525499bd722676e3c"><div class="ttname"><a href="out__motor_8h.html#a1ae2d51e9799d2a525499bd722676e3c">MOTOR_QUOTE</a></div><div class="ttdeci">#define MOTOR_QUOTE</div><div class="ttdef"><b>Definition:</b> out_motor.h:13</div></div>
<div class="ttc" id="aclassout___motor_html_aa731e4d1848e07ac7dc4a99a0ddad942"><div class="ttname"><a href="classout___motor.html#aa731e4d1848e07ac7dc4a99a0ddad942">out_Motor::Ctrl</a></div><div class="ttdeci">int Ctrl(itemCmd cmd, char *subItem=NULL, bool toExecute=true) override</div><div class="ttdef"><b>Definition:</b> out_motor.cpp:214</div></div>
<div class="ttc" id="aclassout___motor_html_afd67d9b6e08f14074a236d5222809226"><div class="ttname"><a href="classout___motor.html#afd67d9b6e08f14074a236d5222809226">out_Motor::getChanType</a></div><div class="ttdeci">int getChanType() override</div><div class="ttdef"><b>Definition:</b> out_motor.cpp:207</div></div>
<div class="ttc" id="aclassout___motor_html_a7698763731e54149861a9bdcc18e6344"><div class="ttname"><a href="classout___motor.html#a7698763731e54149861a9bdcc18e6344">out_Motor::out_Motor</a></div><div class="ttdeci">out_Motor(Item *_item)</div><div class="ttdef"><b>Definition:</b> out_motor.h:21</div></div>
<div class="ttc" id="aclassout___motor_html_a7a98c58b6c32cc20b7b05ad07a07c231"><div class="ttname"><a href="classout___motor.html#a7a98c58b6c32cc20b7b05ad07a07c231">out_Motor::Poll</a></div><div class="ttdeci">int Poll(short cause) override</div><div class="ttdef"><b>Definition:</b> out_motor.cpp:72</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 -->
<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>