You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
CMSIS-DSP/v1.11.0/structarm__pid__instance__q...

278 lines
13 KiB
HTML

<!-- HTML header for doxygen 1.9.2-->
<!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=11"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CMSIS-DSP: arm_pid_instance_q31 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="footer.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="$extra_stylesheet" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
<link href="version.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../version.js"></script>
</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: 55px;">
<td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
<td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
<div id="projectname">CMSIS-DSP
&#160;<span id="projectnumber"><script type="text/javascript">
<!--
writeHeader.call(this);
writeVersionDropdown(this);
//-->
</script>
</span>
</div>
<div id="projectbrief">CMSIS DSP Software Library</div>
</td>
<!--END !PROJECT_NAME-->
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
<li><a href="modules.html"><span>&#160;API&#160;Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</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 */
$(document).ready(function(){initNavTree('structarm__pid__instance__q31.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="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">arm_pid_instance_q31 Struct Reference<div class="ingroups"><a class="el" href="group__groupController.html">Controller Functions</a> &raquo; <a class="el" href="group__PID.html">PID Motor Control</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Instance structure for the Q31 PID Control.
</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:ab58496a4137da4c667915a5fc0ef57ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#ab58496a4137da4c667915a5fc0ef57ef">A0</a></td></tr>
<tr class="separator:ab58496a4137da4c667915a5fc0ef57ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb897c84724b56948e4222aca8d0e1f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#aeb897c84724b56948e4222aca8d0e1f4">A1</a></td></tr>
<tr class="separator:aeb897c84724b56948e4222aca8d0e1f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ae945f839719fb2c04c978724b78ebb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#a4ae945f839719fb2c04c978724b78ebb">A2</a></td></tr>
<tr class="separator:a4ae945f839719fb2c04c978724b78ebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0a2da4da9a94af652873ec7e7be4880"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#af0a2da4da9a94af652873ec7e7be4880">state</a> [3]</td></tr>
<tr class="separator:af0a2da4da9a94af652873ec7e7be4880"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ec4b37fe2246a7e017dd07578fe5bbd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#a6ec4b37fe2246a7e017dd07578fe5bbd">Kp</a></td></tr>
<tr class="separator:a6ec4b37fe2246a7e017dd07578fe5bbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84a6c05c16369c905193da0d5fc9a7b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#a84a6c05c16369c905193da0d5fc9a7b0">Ki</a></td></tr>
<tr class="separator:a84a6c05c16369c905193da0d5fc9a7b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a213bbf14da7ea536998f611977173552"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#a213bbf14da7ea536998f611977173552">Kd</a></td></tr>
<tr class="separator:a213bbf14da7ea536998f611977173552"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="ab58496a4137da4c667915a5fc0ef57ef" name="ab58496a4137da4c667915a5fc0ef57ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab58496a4137da4c667915a5fc0ef57ef">&#9670;&nbsp;</a></span>A0</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> A0</td>
</tr>
</table>
</div><div class="memdoc">
<p >The derived gain, A0 = Kp + Ki + Kd . </p>
</div>
</div>
<a id="aeb897c84724b56948e4222aca8d0e1f4" name="aeb897c84724b56948e4222aca8d0e1f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb897c84724b56948e4222aca8d0e1f4">&#9670;&nbsp;</a></span>A1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> A1</td>
</tr>
</table>
</div><div class="memdoc">
<p >The derived gain, A1 = -Kp - 2Kd. </p>
</div>
</div>
<a id="a4ae945f839719fb2c04c978724b78ebb" name="a4ae945f839719fb2c04c978724b78ebb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ae945f839719fb2c04c978724b78ebb">&#9670;&nbsp;</a></span>A2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> A2</td>
</tr>
</table>
</div><div class="memdoc">
<p >The derived gain, A2 = Kd . </p>
</div>
</div>
<a id="a213bbf14da7ea536998f611977173552" name="a213bbf14da7ea536998f611977173552"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a213bbf14da7ea536998f611977173552">&#9670;&nbsp;</a></span>Kd</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Kd</td>
</tr>
</table>
</div><div class="memdoc">
<p >The derivative gain. </p>
</div>
</div>
<a id="a84a6c05c16369c905193da0d5fc9a7b0" name="a84a6c05c16369c905193da0d5fc9a7b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84a6c05c16369c905193da0d5fc9a7b0">&#9670;&nbsp;</a></span>Ki</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ki</td>
</tr>
</table>
</div><div class="memdoc">
<p >The integral gain. </p>
</div>
</div>
<a id="a6ec4b37fe2246a7e017dd07578fe5bbd" name="a6ec4b37fe2246a7e017dd07578fe5bbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ec4b37fe2246a7e017dd07578fe5bbd">&#9670;&nbsp;</a></span>Kp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Kp</td>
</tr>
</table>
</div><div class="memdoc">
<p >The proportional gain. </p>
</div>
</div>
<a id="af0a2da4da9a94af652873ec7e7be4880" name="af0a2da4da9a94af652873ec7e7be4880"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0a2da4da9a94af652873ec7e7be4880">&#9670;&nbsp;</a></span>state</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math__types_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> state[3]</td>
</tr>
</table>
</div><div class="memdoc">
<p >The state array of length 3. </p>
</div>
</div>
</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="structarm__pid__instance__q31.html">arm_pid_instance_q31</a></li>
<li class="footer">
<script type="text/javascript">
<!--
writeFooter.call(this);
//-->
</script>
</li>
</ul>
</div>
</body>
</html>