ghoscht/xmclib
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
xmclib/CMSIS/Documentation/DSP/html/structarm__pid__instance__f32.html

265 lines
14 KiB
HTML
Raw Normal View History

Init xmclib
2024-10-17 17:09:59 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>arm_pid_instance_f32 Struct Reference</title>
<title>CMSIS-DSP: arm_pid_instance_f32 Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="cmsis.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="printComponentTabs.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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: 46px;">
<td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">CMSIS-DSP
&#160;<span id="projectnumber">Version 1.5.1</span>
</div>
<div id="projectbrief">CMSIS DSP Software Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</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>Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
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.png" 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">
$(document).ready(function(){initNavTree('structarm__pid__instance__f32.html','');});
</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></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_f32 Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Instance structure for the floating-point PID Control.
</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ad7b0bed64915d0a25a3409fa2dc45556"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__f32.html#ad7b0bed64915d0a25a3409fa2dc45556">A0</a></td></tr>
<tr class="separator:ad7b0bed64915d0a25a3409fa2dc45556"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7def89571c50f7137a213326a396e560"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__f32.html#a7def89571c50f7137a213326a396e560">A1</a></td></tr>
<tr class="separator:a7def89571c50f7137a213326a396e560"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a155acf642ba2f521869f19d694cd7fa0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__f32.html#a155acf642ba2f521869f19d694cd7fa0">A2</a></td></tr>
<tr class="separator:a155acf642ba2f521869f19d694cd7fa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd394e1e52fb1d526aa472c83b8f2464"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__f32.html#afd394e1e52fb1d526aa472c83b8f2464">state</a> [3]</td></tr>
<tr class="separator:afd394e1e52fb1d526aa472c83b8f2464"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9b9aa9e413c6cec376a9dddc9f01ebe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__f32.html#aa9b9aa9e413c6cec376a9dddc9f01ebe">Kp</a></td></tr>
<tr class="separator:aa9b9aa9e413c6cec376a9dddc9f01ebe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0feffde05fe391eeab3bf78e953830a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__f32.html#ac0feffde05fe391eeab3bf78e953830a">Ki</a></td></tr>
<tr class="separator:ac0feffde05fe391eeab3bf78e953830a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5b68fbf84d16188ae4747ff91f6f088"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__f32.html#ad5b68fbf84d16188ae4747ff91f6f088">Kd</a></td></tr>
<tr class="separator:ad5b68fbf84d16188ae4747ff91f6f088"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ad7b0bed64915d0a25a3409fa2dc45556"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_pid_instance_f32::A0</td>
</tr>
</table>
</div><div class="memdoc">
<p>The derived gain, A0 = Kp + Ki + Kd . </p>
<p>Referenced by <a class="el" href="group__PID.html#ga9380d08046dd7ec2f5015f569206b9ce">arm_pid_f32()</a>, and <a class="el" href="group__PID.html#gae31536b19b82b93ed184fb1ab73cfcb3">arm_pid_init_f32()</a>.</p>
</div>
</div>
<a class="anchor" id="a7def89571c50f7137a213326a396e560"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_pid_instance_f32::A1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The derived gain, A1 = -Kp - 2Kd. </p>
<p>Referenced by <a class="el" href="group__PID.html#ga9380d08046dd7ec2f5015f569206b9ce">arm_pid_f32()</a>, and <a class="el" href="group__PID.html#gae31536b19b82b93ed184fb1ab73cfcb3">arm_pid_init_f32()</a>.</p>
</div>
</div>
<a class="anchor" id="a155acf642ba2f521869f19d694cd7fa0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_pid_instance_f32::A2</td>
</tr>
</table>
</div><div class="memdoc">
<p>The derived gain, A2 = Kd . </p>
<p>Referenced by <a class="el" href="group__PID.html#ga9380d08046dd7ec2f5015f569206b9ce">arm_pid_f32()</a>, and <a class="el" href="group__PID.html#gae31536b19b82b93ed184fb1ab73cfcb3">arm_pid_init_f32()</a>.</p>
</div>
</div>
<a class="anchor" id="ad5b68fbf84d16188ae4747ff91f6f088"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_pid_instance_f32::Kd</td>
</tr>
</table>
</div><div class="memdoc">
<p>The derivative gain. </p>
<p>Referenced by <a class="el" href="group__PID.html#gae31536b19b82b93ed184fb1ab73cfcb3">arm_pid_init_f32()</a>.</p>
</div>
</div>
<a class="anchor" id="ac0feffde05fe391eeab3bf78e953830a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_pid_instance_f32::Ki</td>
</tr>
</table>
</div><div class="memdoc">
<p>The integral gain. </p>
<p>Referenced by <a class="el" href="group__PID.html#gae31536b19b82b93ed184fb1ab73cfcb3">arm_pid_init_f32()</a>.</p>
</div>
</div>
<a class="anchor" id="aa9b9aa9e413c6cec376a9dddc9f01ebe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_pid_instance_f32::Kp</td>
</tr>
</table>
</div><div class="memdoc">
<p>The proportional gain. </p>
<p>Referenced by <a class="el" href="group__PID.html#gae31536b19b82b93ed184fb1ab73cfcb3">arm_pid_init_f32()</a>.</p>
</div>
</div>
<a class="anchor" id="afd394e1e52fb1d526aa472c83b8f2464"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> arm_pid_instance_f32::state[3]</td>
</tr>
</table>
</div><div class="memdoc">
<p>The state array of length 3. </p>
<p>Referenced by <a class="el" href="group__PID.html#ga9380d08046dd7ec2f5015f569206b9ce">arm_pid_f32()</a>, <a class="el" href="group__PID.html#gae31536b19b82b93ed184fb1ab73cfcb3">arm_pid_init_f32()</a>, and <a class="el" href="group__PID.html#ga9ec860bcb6f8ca31205bf0f1b51ab723">arm_pid_reset_f32()</a>.</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__f32.html">arm_pid_instance_f32</a></li>
<li class="footer">Generated on Wed Feb 8 2017 10:20:52 for CMSIS-DSP by ARM Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>
Reference in a new issue Copy permalink