Files
2026-10-16 13:08:06 +02:00

256 lines
14 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: SpindlePhysicalParams Struct 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>
<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('structSpindlePhysicalParams.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="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">SpindlePhysicalParams Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="Spindle_8h_source.html">Spindle.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a58a62895bf4d12b4b2c443431fb3cf38" id="r_a58a62895bf4d12b4b2c443431fb3cf38"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a58a62895bf4d12b4b2c443431fb3cf38">setDutyCycle</a> )(<a class="el" href="Spindle_8h.html#a3d7552ef760330fd6f48acef7e0aa9be">SpindleHandle_t</a> h, void *<a class="el" href="#a0bca5167d854343844b69767dfd05d1b">context</a>, int backwards, float dutyCycle)</td></tr>
<tr class="separator:a58a62895bf4d12b4b2c443431fb3cf38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53f799f4576e8bc616374a30f074a9a9" id="r_a53f799f4576e8bc616374a30f074a9a9"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a53f799f4576e8bc616374a30f074a9a9">enaPWM</a> )(<a class="el" href="Spindle_8h.html#a3d7552ef760330fd6f48acef7e0aa9be">SpindleHandle_t</a> h, void *<a class="el" href="#a0bca5167d854343844b69767dfd05d1b">context</a>, int ena)</td></tr>
<tr class="separator:a53f799f4576e8bc616374a30f074a9a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfaf8529f3786ebbbdf35ac5f82378c9" id="r_adfaf8529f3786ebbbdf35ac5f82378c9"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adfaf8529f3786ebbbdf35ac5f82378c9">maxRPM</a></td></tr>
<tr class="separator:adfaf8529f3786ebbbdf35ac5f82378c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c87b88b1401fb6b3ec633a6b10ae00a" id="r_a7c87b88b1401fb6b3ec633a6b10ae00a"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c87b88b1401fb6b3ec633a6b10ae00a">absMinRPM</a></td></tr>
<tr class="separator:a7c87b88b1401fb6b3ec633a6b10ae00a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4bdae3ef239883e33e869386af2539c" id="r_ab4bdae3ef239883e33e869386af2539c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab4bdae3ef239883e33e869386af2539c">minRPM</a></td></tr>
<tr class="separator:ab4bdae3ef239883e33e869386af2539c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bca5167d854343844b69767dfd05d1b" id="r_a0bca5167d854343844b69767dfd05d1b"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0bca5167d854343844b69767dfd05d1b">context</a></td></tr>
<tr class="separator:a0bca5167d854343844b69767dfd05d1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="Spindle_8h.html#a668bd557de626b1ef65f4d756d58146c">SpindlePhysicalParams_t</a> structure is represents the abstraction functions and members as a container. The objetcs are passed as structure pointer when calling SPINDLE_CreateInstance. It contains function pointers to platform specific functions which enable the spindle or regulate the speed and direction of it. There are also limit values for the maximum, minimum and absolute minimum RPM and an additional context pointer which is passed the the abstraction functions. The user must provide a configured structure in its design when calling SPINDLE_CreateInstance. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a7c87b88b1401fb6b3ec633a6b10ae00a" name="a7c87b88b1401fb6b3ec633a6b10ae00a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c87b88b1401fb6b3ec633a6b10ae00a">&#9670;&#160;</a></span>absMinRPM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SpindlePhysicalParams::absMinRPM</td>
</tr>
</table>
</div><div class="memdoc">
<p>specifies the minimum possible absolute RPM value which is usable with the spindle a requested RPM value lower than this value is limited and therefore its not possible to let the spindle run slower. This value is used for clock wise and counter clock wise spindle rotation in the same way. </p>
</div>
</div>
<a id="a0bca5167d854343844b69767dfd05d1b" name="a0bca5167d854343844b69767dfd05d1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bca5167d854343844b69767dfd05d1b">&#9670;&#160;</a></span>context</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* SpindlePhysicalParams::context</td>
</tr>
</table>
</div><div class="memdoc">
<p>optional context pointer for platform abstraction. can be null. </p>
</div>
</div>
<a id="a53f799f4576e8bc616374a30f074a9a9" name="a53f799f4576e8bc616374a30f074a9a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53f799f4576e8bc616374a30f074a9a9">&#9670;&#160;</a></span>enaPWM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* SpindlePhysicalParams::enaPWM) (<a class="el" href="Spindle_8h.html#a3d7552ef760330fd6f48acef7e0aa9be">SpindleHandle_t</a> h, void *<a class="el" href="#a0bca5167d854343844b69767dfd05d1b">context</a>, int ena)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function pointer is used to enable or disable the PWM output and to set the enable outputs od the half bridges of the spindle</p>
<p>The pointer must not be null</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">h</td><td>optional handle of the spindle library. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">context</td><td>optional context pointer the user has passed by the SPINDLE_CreateInstance call. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ena</td><td>value that sets enable or disable state (1 = enabled, 0 = disabled)</td></tr>
</table>
</dd>
</dl>
<p>The behavior is schematically as follows: </p><div class="plantumlgraph">
<img src="inline_umlgraph_1.png" />
</div>
</div>
</div>
<a id="adfaf8529f3786ebbbdf35ac5f82378c9" name="adfaf8529f3786ebbbdf35ac5f82378c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfaf8529f3786ebbbdf35ac5f82378c9">&#9670;&#160;</a></span>maxRPM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SpindlePhysicalParams::maxRPM</td>
</tr>
</table>
</div><div class="memdoc">
<p>specifies the maximum positive RPM value which represents a duty cycle of 1.0 </p>
</div>
</div>
<a id="ab4bdae3ef239883e33e869386af2539c" name="ab4bdae3ef239883e33e869386af2539c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4bdae3ef239883e33e869386af2539c">&#9670;&#160;</a></span>minRPM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SpindlePhysicalParams::minRPM</td>
</tr>
</table>
</div><div class="memdoc">
<p>specifies the minimum negative RPM value. Mostly this value is symmetrical to the max value which means it can be the same value </p>
</div>
</div>
<a id="a58a62895bf4d12b4b2c443431fb3cf38" name="a58a62895bf4d12b4b2c443431fb3cf38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58a62895bf4d12b4b2c443431fb3cf38">&#9670;&#160;</a></span>setDutyCycle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* SpindlePhysicalParams::setDutyCycle) (<a class="el" href="Spindle_8h.html#a3d7552ef760330fd6f48acef7e0aa9be">SpindleHandle_t</a> h, void *<a class="el" href="#a0bca5167d854343844b69767dfd05d1b">context</a>, int backwards, float dutyCycle)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function pointer is used to change the duty cycle of the spindle. This function is necessary for changing the PWM generation itself. It also sets the direction of the spindle which means turning clock wise or counter clock wise</p>
<p>The pointer must not be null</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">h</td><td>optional handle of the spindle library. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">context</td><td>optional context pointer the user has passed by the SPINDLE_CreateInstance call. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dutyCycle</td><td>value between 0 = 0% and 1 = 100% </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">backwards</td><td>sets the direction of the spindle (clockwise or counter clockwise = backward).</td></tr>
</table>
</dd>
</dl>
<p>The behavior is schematically as follows: </p><div class="plantumlgraph">
<img src="inline_umlgraph_3.png" />
</div>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>C:/HomeGit/dhbw/EmbSys/RealtimeProg/MCU_STM32_60h/libs/LibSpindle/inc/<a class="el" href="Spindle_8h_source.html">Spindle.h</a></li>
</ul>
</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="structSpindlePhysicalParams.html">SpindlePhysicalParams</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>