Files
Fr-ssspindel_HNP/libs/LibSpindle/doc/html/Spindle_8h_source.html
T
2026-10-16 18:25:42 +02:00

167 lines
15 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LibSpindle-C-Library: C:/HomeGit/dhbw/EmbSys/RealtimeProg/MCU_STM32_60h/libs/LibSpindle/inc/Spindle.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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="banner.png"/></td>
<td id="projectalign">
<div id="projectname">LibSpindle-C-Library<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Library Code documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('Spindle_8h_source.html',''); initResizable(true); });
/* @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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">Spindle.h</div></div>
</div><!--header-->
<div class="contents">
<a href="Spindle_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Controller.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Created on: Dec 9, 2024</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Author: Thorsten</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#ifndef INC_SPINDLE_CONTROLLER_H_</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define INC_SPINDLE_CONTROLLER_H_</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &quot;Console.h&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="Spindle_8h.html#a3d7552ef760330fd6f48acef7e0aa9be"> 19</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structSpindleHandle.html">SpindleHandle</a>* <a class="code hl_typedef" href="Spindle_8h.html#a3d7552ef760330fd6f48acef7e0aa9be">SpindleHandle_t</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span></div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="};">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="structSpindlePhysicalParams.html"> 29</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structSpindlePhysicalParams.html">SpindlePhysicalParams</a></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>{</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="structSpindlePhysicalParams.html#a58a62895bf4d12b4b2c443431fb3cf38"> 51</a></span> void (*<a class="code hl_variable" href="structSpindlePhysicalParams.html#a58a62895bf4d12b4b2c443431fb3cf38">setDutyCycle</a>)(<a class="code hl_typedef" href="Spindle_8h.html#a3d7552ef760330fd6f48acef7e0aa9be">SpindleHandle_t</a> h, <span class="keywordtype">void</span>* <a class="code hl_variable" href="structSpindlePhysicalParams.html#a0bca5167d854343844b69767dfd05d1b">context</a>, <span class="keywordtype">int</span> backwards, <span class="keywordtype">float</span> dutyCycle);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="structSpindlePhysicalParams.html#a53f799f4576e8bc616374a30f074a9a9"> 82</a></span> void (*<a class="code hl_variable" href="structSpindlePhysicalParams.html#a53f799f4576e8bc616374a30f074a9a9">enaPWM</a>) (<a class="code hl_typedef" href="Spindle_8h.html#a3d7552ef760330fd6f48acef7e0aa9be">SpindleHandle_t</a> h, <span class="keywordtype">void</span>* <a class="code hl_variable" href="structSpindlePhysicalParams.html#a0bca5167d854343844b69767dfd05d1b">context</a>, <span class="keywordtype">int</span> ena);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="structSpindlePhysicalParams.html#adfaf8529f3786ebbbdf35ac5f82378c9"> 88</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="structSpindlePhysicalParams.html#adfaf8529f3786ebbbdf35ac5f82378c9">maxRPM</a>;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="structSpindlePhysicalParams.html#a7c87b88b1401fb6b3ec633a6b10ae00a"> 96</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="structSpindlePhysicalParams.html#a7c87b88b1401fb6b3ec633a6b10ae00a">absMinRPM</a>;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="structSpindlePhysicalParams.html#ab4bdae3ef239883e33e869386af2539c"> 102</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="structSpindlePhysicalParams.html#ab4bdae3ef239883e33e869386af2539c">minRPM</a>;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="structSpindlePhysicalParams.html#a0bca5167d854343844b69767dfd05d1b"> 107</a></span> <span class="keywordtype">void</span>* <a class="code hl_variable" href="structSpindlePhysicalParams.html#a0bca5167d854343844b69767dfd05d1b">context</a>;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="Spindle_8h.html#a668bd557de626b1ef65f4d756d58146c"> 109</a></span>} <a class="code hl_typedef" href="Spindle_8h.html#a668bd557de626b1ef65f4d756d58146c">SpindlePhysicalParams_t</a>;</div>
</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><a class="code hl_typedef" href="Spindle_8h.html#a3d7552ef760330fd6f48acef7e0aa9be">SpindleHandle_t</a> <a class="code hl_function" href="Spindle_8h.html#ac853c2ad50f0e661cd06c2c68fe465d3">SPINDLE_CreateInstance</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> uxStackDepth, <span class="keywordtype">int</span> xPrio, ConsoleHandle_t cH, <a class="code hl_typedef" href="Spindle_8h.html#a668bd557de626b1ef65f4d756d58146c">SpindlePhysicalParams_t</a>* p );</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> </div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> </div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span><span class="preprocessor">#endif </span><span class="comment">/* INC_SPINDLE_CONTROLLER_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aSpindle_8h_html_a3d7552ef760330fd6f48acef7e0aa9be"><div class="ttname"><a href="Spindle_8h.html#a3d7552ef760330fd6f48acef7e0aa9be">SpindleHandle_t</a></div><div class="ttdeci">struct SpindleHandle * SpindleHandle_t</div><div class="ttdef"><b>Definition</b> Spindle.h:19</div></div>
<div class="ttc" id="aSpindle_8h_html_a668bd557de626b1ef65f4d756d58146c"><div class="ttname"><a href="Spindle_8h.html#a668bd557de626b1ef65f4d756d58146c">SpindlePhysicalParams_t</a></div><div class="ttdeci">struct SpindlePhysicalParams SpindlePhysicalParams_t</div></div>
<div class="ttc" id="aSpindle_8h_html_ac853c2ad50f0e661cd06c2c68fe465d3"><div class="ttname"><a href="Spindle_8h.html#ac853c2ad50f0e661cd06c2c68fe465d3">SPINDLE_CreateInstance</a></div><div class="ttdeci">SpindleHandle_t SPINDLE_CreateInstance(unsigned int uxStackDepth, int xPrio, ConsoleHandle_t cH, SpindlePhysicalParams_t *p)</div><div class="ttdef"><b>Definition</b> Spindle.c:357</div></div>
<div class="ttc" id="astructSpindleHandle_html"><div class="ttname"><a href="structSpindleHandle.html">SpindleHandle</a></div><div class="ttdef"><b>Definition</b> Spindle.c:97</div></div>
<div class="ttc" id="astructSpindlePhysicalParams_html"><div class="ttname"><a href="structSpindlePhysicalParams.html">SpindlePhysicalParams</a></div><div class="ttdef"><b>Definition</b> Spindle.h:30</div></div>
<div class="ttc" id="astructSpindlePhysicalParams_html_a0bca5167d854343844b69767dfd05d1b"><div class="ttname"><a href="structSpindlePhysicalParams.html#a0bca5167d854343844b69767dfd05d1b">SpindlePhysicalParams::context</a></div><div class="ttdeci">void * context</div><div class="ttdef"><b>Definition</b> Spindle.h:107</div></div>
<div class="ttc" id="astructSpindlePhysicalParams_html_a53f799f4576e8bc616374a30f074a9a9"><div class="ttname"><a href="structSpindlePhysicalParams.html#a53f799f4576e8bc616374a30f074a9a9">SpindlePhysicalParams::enaPWM</a></div><div class="ttdeci">void(* enaPWM)(SpindleHandle_t h, void *context, int ena)</div><div class="ttdef"><b>Definition</b> Spindle.h:82</div></div>
<div class="ttc" id="astructSpindlePhysicalParams_html_a58a62895bf4d12b4b2c443431fb3cf38"><div class="ttname"><a href="structSpindlePhysicalParams.html#a58a62895bf4d12b4b2c443431fb3cf38">SpindlePhysicalParams::setDutyCycle</a></div><div class="ttdeci">void(* setDutyCycle)(SpindleHandle_t h, void *context, int backwards, float dutyCycle)</div><div class="ttdef"><b>Definition</b> Spindle.h:51</div></div>
<div class="ttc" id="astructSpindlePhysicalParams_html_a7c87b88b1401fb6b3ec633a6b10ae00a"><div class="ttname"><a href="structSpindlePhysicalParams.html#a7c87b88b1401fb6b3ec633a6b10ae00a">SpindlePhysicalParams::absMinRPM</a></div><div class="ttdeci">float absMinRPM</div><div class="ttdef"><b>Definition</b> Spindle.h:96</div></div>
<div class="ttc" id="astructSpindlePhysicalParams_html_ab4bdae3ef239883e33e869386af2539c"><div class="ttname"><a href="structSpindlePhysicalParams.html#ab4bdae3ef239883e33e869386af2539c">SpindlePhysicalParams::minRPM</a></div><div class="ttdeci">float minRPM</div><div class="ttdef"><b>Definition</b> Spindle.h:102</div></div>
<div class="ttc" id="astructSpindlePhysicalParams_html_adfaf8529f3786ebbbdf35ac5f82378c9"><div class="ttname"><a href="structSpindlePhysicalParams.html#adfaf8529f3786ebbbdf35ac5f82378c9">SpindlePhysicalParams::maxRPM</a></div><div class="ttdeci">float maxRPM</div><div class="ttdef"><b>Definition</b> Spindle.h:88</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="Spindle_8h.html">Spindle.h</a></li>
<li class="footer">Generated on Thu Oct 30 2025 19:28:48 for LibSpindle-C-Library by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>