Files
RP2040-Decoder/html/core1_8h_source.html
T
2024-11-26 16:27:45 +00:00

188 lines
20 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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RP2040-Decoder: core1.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="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="projectalign">
<div id="projectname">RP2040-Decoder
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="doc-content">
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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">core1.h</div></div>
</div><!--header-->
<div class="contents">
<a href="core1_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> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;<a class="code" href="shared_8h.html">shared.h</a>&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define BASE_PWM_ARR_LEN 16</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="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> STARTUP_MODE,</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> PID_MODE,</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>} controller_mode_t;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structstartup__parameters__t.html"> 18</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structstartup__parameters__t.html">startup_parameters_t</a> {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> uint16_t level;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> uint16_t base_pwm_arr[BASE_PWM_ARR_LEN];</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> uint16_t base_pwm_arr_i;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>}<a class="code hl_struct" href="structstartup__parameters__t.html">startup_parameters_t</a>;</div>
</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="foldopen" id="foldopen00024" data-start="{" data-end="};">
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="structpid__parameters__t.html"> 24</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structpid__parameters__t.html">pid_parameters_t</a>{</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// PID Controller variables</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">float</span> k_i; <span class="comment">// Integral gain</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">float</span> k_d; <span class="comment">// Derivative gain</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">float</span> t; <span class="comment">// Sampling time</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">float</span> tau; <span class="comment">// Low-pass-filter time constant</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">float</span> ci_0; <span class="comment">// (k_i*t)/2</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">float</span> cd_0; <span class="comment">// (k_d*2)/(2*tau+t)</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">float</span> cd_1; <span class="comment">// (2*tau-t)/(2*tau+t)</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">float</span> int_lim_max; <span class="comment">// max limit for integrator</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">float</span> int_lim_min; <span class="comment">// min limit for integrator</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">float</span> max_output; <span class="comment">// max possible pwm output value</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">float</span> k_p; <span class="comment">// Proportional gain</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">float</span> e; <span class="comment">// Error</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">float</span> e_prev; <span class="comment">// Previous Error</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">float</span> i_prev; <span class="comment">// Previous Integral Value</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">float</span> d_prev; <span class="comment">// Previous Derivative Value</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// Variable gain variables</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">float</span> k_p_x_1_shift;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">float</span> k_p_x_1;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">float</span> k_p_x_2;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">float</span> k_p_y_0;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">float</span> k_p_y_1;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">float</span> k_p_y_2;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">float</span> k_p_m_1;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">float</span> k_p_m_2;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>} <a class="code hl_struct" href="structpid__parameters__t.html">pid_parameter_t</a>;</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="foldopen" id="foldopen00052" data-start="{" data-end="};">
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="structcontroller__parameter__t.html"> 52</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structcontroller__parameter__t.html">controller_parameter_t</a>{</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="structcontroller__parameter__t.html#a0aa7cc1e193cb40c7b98541b8fa32251"> 56</a></span> controller_mode_t <a class="code hl_variable" href="structcontroller__parameter__t.html#a0aa7cc1e193cb40c7b98541b8fa32251">mode</a>; <span class="comment">// Controller mode</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordtype">float</span> feed_fwd; <span class="comment">// Feed forward value</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> uint32_t setpoint; <span class="comment">// Current setpoint</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> uint16_t speed_table[127]; <span class="comment">// Array with setpoint values corresponding to every speed step</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="structcontroller__parameter__t.html#a0f841c8cacf66a1496c64ac9864b5099"> 64</a></span> <a class="code hl_struct" href="structstartup__parameters__t.html">startup_parameters_t</a> <a class="code hl_variable" href="structcontroller__parameter__t.html#a0f841c8cacf66a1496c64ac9864b5099">startup</a>;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="structcontroller__parameter__t.html#a39e92719a0eea22432586540578a7e1d"> 69</a></span> <a class="code hl_struct" href="structpid__parameters__t.html">pid_parameter_t</a> <a class="code hl_variable" href="structcontroller__parameter__t.html#a39e92719a0eea22432586540578a7e1d">pid</a>;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="structcontroller__parameter__t.html#a32d7427eb6a58ee778a44f7107cd1c27"> 74</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="structcontroller__parameter__t.html#a32d7427eb6a58ee778a44f7107cd1c27">measurement</a>; <span class="comment">// Newest Measurement value</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">float</span> measurement_prev; <span class="comment">// Previous Measurement</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">float</span> measurement_corrected; <span class="comment">// measurement - adc_offset = measurement_corrected</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordtype">float</span> adc_offset; <span class="comment">// ADC offset value</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> uint8_t msr_delay_in_us; <span class="comment">// Delay before VEMF Measurement</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> uint8_t msr_total_iterations; <span class="comment">// Amount of samples</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> uint8_t l_side_arr_cutoff; <span class="comment">// Discarded samples (left side)</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> uint8_t r_side_arr_cutoff; <span class="comment">// Discarded samples (right side)</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>} <a class="code hl_struct" href="structcontroller__parameter__t.html">controller_parameter_t</a>;</div>
</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span>uint8_t get_speed_step_table_index_of_speed_step(uint8_t speed_step);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="keywordtype">bool</span> speed_helper(<span class="keyword">struct</span> repeating_timer *t);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="keywordtype">void</span> adjust_pwm_level(uint16_t level);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="keywordtype">float</span> get_kp(<span class="keyword">const</span> <a class="code hl_struct" href="structcontroller__parameter__t.html">controller_parameter_t</a> *ctrl_par);</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>uint16_t get_initial_level(<a class="code hl_struct" href="structcontroller__parameter__t.html">controller_parameter_t</a> * ctrl_par);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="keywordtype">void</span> controller_startup_mode(<a class="code hl_struct" href="structcontroller__parameter__t.html">controller_parameter_t</a> * ctrl_par);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="keywordtype">bool</span> controller_general(<span class="keyword">struct</span> repeating_timer * t);</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="keywordtype">void</span> init_controller(<a class="code hl_struct" href="structcontroller__parameter__t.html">controller_parameter_t</a> * ctrl_par);</div>
<div class="ttc" id="ashared_8h_html"><div class="ttname"><a href="shared_8h.html">shared.h</a></div></div>
<div class="ttc" id="astructcontroller__parameter__t_html"><div class="ttname"><a href="structcontroller__parameter__t.html">controller_parameter_t</a></div><div class="ttdef"><b>Definition</b> core1.h:52</div></div>
<div class="ttc" id="astructcontroller__parameter__t_html_a0aa7cc1e193cb40c7b98541b8fa32251"><div class="ttname"><a href="structcontroller__parameter__t.html#a0aa7cc1e193cb40c7b98541b8fa32251">controller_parameter_t::mode</a></div><div class="ttdeci">controller_mode_t mode</div><div class="ttdef"><b>Definition</b> core1.h:56</div></div>
<div class="ttc" id="astructcontroller__parameter__t_html_a0f841c8cacf66a1496c64ac9864b5099"><div class="ttname"><a href="structcontroller__parameter__t.html#a0f841c8cacf66a1496c64ac9864b5099">controller_parameter_t::startup</a></div><div class="ttdeci">startup_parameters_t startup</div><div class="ttdef"><b>Definition</b> core1.h:64</div></div>
<div class="ttc" id="astructcontroller__parameter__t_html_a32d7427eb6a58ee778a44f7107cd1c27"><div class="ttname"><a href="structcontroller__parameter__t.html#a32d7427eb6a58ee778a44f7107cd1c27">controller_parameter_t::measurement</a></div><div class="ttdeci">float measurement</div><div class="ttdef"><b>Definition</b> core1.h:74</div></div>
<div class="ttc" id="astructcontroller__parameter__t_html_a39e92719a0eea22432586540578a7e1d"><div class="ttname"><a href="structcontroller__parameter__t.html#a39e92719a0eea22432586540578a7e1d">controller_parameter_t::pid</a></div><div class="ttdeci">pid_parameter_t pid</div><div class="ttdef"><b>Definition</b> core1.h:69</div></div>
<div class="ttc" id="astructpid__parameters__t_html"><div class="ttname"><a href="structpid__parameters__t.html">pid_parameters_t</a></div><div class="ttdef"><b>Definition</b> core1.h:24</div></div>
<div class="ttc" id="astructstartup__parameters__t_html"><div class="ttname"><a href="structstartup__parameters__t.html">startup_parameters_t</a></div><div class="ttdef"><b>Definition</b> core1.h:18</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>