Files
RP2040-Decoder/sphinx/html/software/header_files.html
T
2024-11-27 22:16:41 +00:00

1052 lines
112 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Header files &mdash; RP2040-Decoder 0.3, 1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=6bd3bce2"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Configuration Variables (CV)" href="../other/CV_list.html" />
<link rel="prev" title="Software Description" href="sw_description.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
RP2040-Decoder
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../other/getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../hardware/hw.html">Hardware</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="sw.html">Software</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="sw_description.html">Software Description</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Header files</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#core0-h">core0.h</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv411two_std_devA_Kf8uint32_t"><code class="docutils literal notranslate"><span class="pre">two_std_dev()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv421adc_offset_adjustment8uint32_t"><code class="docutils literal notranslate"><span class="pre">adc_offset_adjustment()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv411acknowledgev"><code class="docutils literal notranslate"><span class="pre">acknowledge()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv413verify_cv_bit8uint16_tb7uint8_t"><code class="docutils literal notranslate"><span class="pre">verify_cv_bit()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv414verify_cv_byte8uint16_t7uint8_t"><code class="docutils literal notranslate"><span class="pre">verify_cv_byte()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv413write_cv_byte8uint16_t7uint8_t"><code class="docutils literal notranslate"><span class="pre">write_cv_byte()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv412program_mode7uint8_tA_K7uint8_t"><code class="docutils literal notranslate"><span class="pre">program_mode()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv411set_outputs8uint32_t"><code class="docutils literal notranslate"><span class="pre">set_outputs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv423update_active_functions8uint32_t7uint8_tb"><code class="docutils literal notranslate"><span class="pre">update_active_functions()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv415error_detection6int8_tPK7uint8_t"><code class="docutils literal notranslate"><span class="pre">error_detection()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv415is_long_address7uint8_tA_K7uint8_t"><code class="docutils literal notranslate"><span class="pre">is_long_address()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv418address_evaluation7uint8_tA_K7uint8_t"><code class="docutils literal notranslate"><span class="pre">address_evaluation()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv422instruction_evaluation7uint8_tA_K7uint8_t"><code class="docutils literal notranslate"><span class="pre">instruction_evaluation()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv419reset_message_check7uint8_tPCK7uint8_t"><code class="docutils literal notranslate"><span class="pre">reset_message_check()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv418verify_dcc_messagev"><code class="docutils literal notranslate"><span class="pre">verify_dcc_message()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv418bits_to_byte_array6int8_tA_7uint8_t"><code class="docutils literal notranslate"><span class="pre">bits_to_byte_array()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv416evaluate_messagev"><code class="docutils literal notranslate"><span class="pre">evaluate_message()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv417track_signal_risejm"><code class="docutils literal notranslate"><span class="pre">track_signal_rise()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv417track_signal_falljm"><code class="docutils literal notranslate"><span class="pre">track_signal_fall()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv412init_outputsv"><code class="docutils literal notranslate"><span class="pre">init_outputs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv414cv_setup_checkv"><code class="docutils literal notranslate"><span class="pre">cv_setup_check()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv414init_motor_pwm7uint8_t"><code class="docutils literal notranslate"><span class="pre">init_motor_pwm()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv48init_adcv"><code class="docutils literal notranslate"><span class="pre">init_adc()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv411clr_bit_arr"><code class="docutils literal notranslate"><span class="pre">clr_bit_arr</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#core1-h">core1.h</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv420startup_parameters_t"><code class="docutils literal notranslate"><span class="pre">startup_parameters_t</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv415pid_parameter_t"><code class="docutils literal notranslate"><span class="pre">pid_parameter_t</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv422controller_parameter_t"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv417controller_mode_t"><code class="docutils literal notranslate"><span class="pre">controller_mode_t</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv440get_speed_step_table_index_of_speed_step7uint8_t"><code class="docutils literal notranslate"><span class="pre">get_speed_step_table_index_of_speed_step()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv412speed_helperP15repeating_timer"><code class="docutils literal notranslate"><span class="pre">speed_helper()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv416adjust_pwm_level8uint16_t"><code class="docutils literal notranslate"><span class="pre">adjust_pwm_level()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv46get_kpPK22controller_parameter_t"><code class="docutils literal notranslate"><span class="pre">get_kp()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv417get_initial_levelP22controller_parameter_t"><code class="docutils literal notranslate"><span class="pre">get_initial_level()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv423controller_startup_modeP22controller_parameter_t"><code class="docutils literal notranslate"><span class="pre">controller_startup_mode()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv418controller_generalP15repeating_timer"><code class="docutils literal notranslate"><span class="pre">controller_general()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv415init_controllerP22controller_parameter_t"><code class="docutils literal notranslate"><span class="pre">init_controller()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N20startup_parameters_t5levelE"><code class="docutils literal notranslate"><span class="pre">startup_parameters_t::level</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N20startup_parameters_t12base_pwm_arrE"><code class="docutils literal notranslate"><span class="pre">startup_parameters_t::base_pwm_arr</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N20startup_parameters_t14base_pwm_arr_iE"><code class="docutils literal notranslate"><span class="pre">startup_parameters_t::base_pwm_arr_i</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv416pid_parameters_t"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t4modeE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::mode</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t8feed_fwdE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::feed_fwd</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t8setpointE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::setpoint</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t11speed_tableE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::speed_table</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t7startupE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::startup</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t3pidE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::pid</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t11measurementE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::measurement</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t16measurement_prevE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::measurement_prev</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t21measurement_correctedE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::measurement_corrected</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t10adc_offsetE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::adc_offset</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t15msr_delay_in_usE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::msr_delay_in_us</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t20msr_total_iterationsE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::msr_total_iterations</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t17l_side_arr_cutoffE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::l_side_arr_cutoff</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv4N22controller_parameter_t17r_side_arr_cutoffE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::r_side_arr_cutoff</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#shared-h">shared.h</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv411core1_entryv"><code class="docutils literal notranslate"><span class="pre">core1_entry()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv416write_cv_handler8uint16_t7uint8_t"><code class="docutils literal notranslate"><span class="pre">write_cv_handler()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_tb"><code class="docutils literal notranslate"><span class="pre">measure()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv412get_32bit_CV8uint16_t"><code class="docutils literal notranslate"><span class="pre">get_32bit_CV()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv412get_16bit_CV8uint16_t"><code class="docutils literal notranslate"><span class="pre">get_16bit_CV()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv427get_direction_of_speed_step7uint8_t"><code class="docutils literal notranslate"><span class="pre">get_direction_of_speed_step()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv417pid_control_timer"><code class="docutils literal notranslate"><span class="pre">pid_control_timer</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv418speed_helper_timer"><code class="docutils literal notranslate"><span class="pre">speed_helper_timer</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv414CV_ARRAY_FLASH"><code class="docutils literal notranslate"><span class="pre">CV_ARRAY_FLASH</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv417speed_step_target"><code class="docutils literal notranslate"><span class="pre">speed_step_target</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#_CPPv422speed_step_target_prev"><code class="docutils literal notranslate"><span class="pre">speed_step_target_prev</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#cv-h">CV.h</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../other/CV_list.html">Configuration Variables (CV)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../other/troubleshooting.html">Troubleshooting</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">RP2040-Decoder</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="sw.html">Software</a></li>
<li class="breadcrumb-item active">Header files</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/software/header_files.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="header-files">
<h1>Header files<a class="headerlink" href="#header-files" title="Link to this heading"></a></h1>
<section id="core0-h">
<h2>core0.h<a class="headerlink" href="#core0-h" title="Link to this heading"></a></h2>
<p>Used exclusively by core0 </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-defines">Defines</p>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.SIZE_BYTE_ARRAY">
<span class="target" id="core0_8h_1a8cbe85a94beae30d747e6a6e85d1ae77"></span><span class="sig-name descname"><span class="n"><span class="pre">SIZE_BYTE_ARRAY</span></span></span><a class="headerlink" href="#c.SIZE_BYTE_ARRAY" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.MESSAGE_3_BYTES">
<span class="target" id="core0_8h_1a8a9a8f8772123235b03debb48fa8a973"></span><span class="sig-name descname"><span class="n"><span class="pre">MESSAGE_3_BYTES</span></span></span><a class="headerlink" href="#c.MESSAGE_3_BYTES" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.MESSAGE_MASK_3_BYTES">
<span class="target" id="core0_8h_1acf2f95404177396e3c93496d3b1d709d"></span><span class="sig-name descname"><span class="n"><span class="pre">MESSAGE_MASK_3_BYTES</span></span></span><a class="headerlink" href="#c.MESSAGE_MASK_3_BYTES" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.MESSAGE_4_BYTES">
<span class="target" id="core0_8h_1a884ecc75183e104a60d283a494d163b6"></span><span class="sig-name descname"><span class="n"><span class="pre">MESSAGE_4_BYTES</span></span></span><a class="headerlink" href="#c.MESSAGE_4_BYTES" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.MESSAGE_MASK_4_BYTES">
<span class="target" id="core0_8h_1adf19b4efd2b349355d55755444620350"></span><span class="sig-name descname"><span class="n"><span class="pre">MESSAGE_MASK_4_BYTES</span></span></span><a class="headerlink" href="#c.MESSAGE_MASK_4_BYTES" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.MESSAGE_5_BYTES">
<span class="target" id="core0_8h_1a1ea7db2e0ad13e6cd1cf221d72d86bb1"></span><span class="sig-name descname"><span class="n"><span class="pre">MESSAGE_5_BYTES</span></span></span><a class="headerlink" href="#c.MESSAGE_5_BYTES" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.MESSAGE_MASK_5_BYTES">
<span class="target" id="core0_8h_1acdd45d7e2d818186f88953c361831b55"></span><span class="sig-name descname"><span class="n"><span class="pre">MESSAGE_MASK_5_BYTES</span></span></span><a class="headerlink" href="#c.MESSAGE_MASK_5_BYTES" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv411two_std_devA_Kf8uint32_t">
<span id="_CPPv311two_std_devA_Kf8uint32_t"></span><span id="_CPPv211two_std_devA_Kf8uint32_t"></span><span id="two_std_dev__floatCA.uint32_t"></span><span class="target" id="core0_8h_1a8db7b95e52c5a24409a057b5354aacac"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">two_std_dev</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">arr</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span>, <span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv411two_std_devA_Kf8uint32_t" title="Link to this definition"></a><br /></dt>
<dd><p>Function returns average of values deviating less than twice the standard deviation from original average. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>arr</strong> – input array </p></li>
<li><p><strong>length</strong> – amount of elements in input array </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>average value of values deviating less than 2*standard_dev. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv421adc_offset_adjustment8uint32_t">
<span id="_CPPv321adc_offset_adjustment8uint32_t"></span><span id="_CPPv221adc_offset_adjustment8uint32_t"></span><span id="adc_offset_adjustment__uint32_t"></span><span class="target" id="core0_8h_1ad6501226575466c1d36d7d71ec192ed2"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">adc_offset_adjustment</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">n</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421adc_offset_adjustment8uint32_t" title="Link to this definition"></a><br /></dt>
<dd><p>Measures ADC offset and saves the offset value to flash memory. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>n</strong> – Amount of measurements to be done </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv411acknowledgev">
<span id="_CPPv311acknowledgev"></span><span id="_CPPv211acknowledgev"></span><span id="acknowledge"></span><span class="target" id="core0_8h_1ac87bd6623f47a32e08278afe923477fd"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">acknowledge</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv411acknowledgev" title="Link to this definition"></a><br /></dt>
<dd><p>Function for acknowledging a CV write or CV verify instruction. </p>
<p>Acknowledgement works by creating a spike in current consumption, normally realized by running the motor in alternating directions. This current increase is detected by the command station. Refers to NMRA S-9.2.3 Section D and RCN-216 Section 3 </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv413verify_cv_bit8uint16_tb7uint8_t">
<span id="_CPPv313verify_cv_bit8uint16_tb7uint8_t"></span><span id="_CPPv213verify_cv_bit8uint16_tb7uint8_t"></span><span id="verify_cv_bit__uint16_t.b.uint8_t"></span><span class="target" id="core0_8h_1afc9694833148886687130bfc41c0278b"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">verify_cv_bit</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">cv_address</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">bit_val</span></span>, <span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">bit_pos</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413verify_cv_bit8uint16_tb7uint8_t" title="Link to this definition"></a><br /></dt>
<dd><p>Function for verifying a single bit of a CV. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cv_address</strong> – CV Address </p></li>
<li><p><strong>bit_val</strong> – Value of bit to be verified </p></li>
<li><p><strong>bit_pos</strong> – Position of bit to be verified </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv414verify_cv_byte8uint16_t7uint8_t">
<span id="_CPPv314verify_cv_byte8uint16_t7uint8_t"></span><span id="_CPPv214verify_cv_byte8uint16_t7uint8_t"></span><span id="verify_cv_byte__uint16_t.uint8_t"></span><span class="target" id="core0_8h_1a28319b022b8ee5ff0a38ef2581a4967e"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">verify_cv_byte</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">cv_address</span></span>, <span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">cv_data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414verify_cv_byte8uint16_t7uint8_t" title="Link to this definition"></a><br /></dt>
<dd><p>Function for verifying a CV byte. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cv_address</strong> – CV Address </p></li>
<li><p><strong>cv_data</strong> – Byte to be verified </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv413write_cv_byte8uint16_t7uint8_t">
<span id="_CPPv313write_cv_byte8uint16_t7uint8_t"></span><span id="_CPPv213write_cv_byte8uint16_t7uint8_t"></span><span id="write_cv_byte__uint16_t.uint8_t"></span><span class="target" id="core0_8h_1a19046d77097b4236a15890613d6f5300"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">write_cv_byte</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">cv_address</span></span>, <span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">cv_data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413write_cv_byte8uint16_t7uint8_t" title="Link to this definition"></a><br /></dt>
<dd><p>Function for writing a CV byte. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cv_address</strong> – </p></li>
<li><p><strong>cv_data</strong> – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv412program_mode7uint8_tA_K7uint8_t">
<span id="_CPPv312program_mode7uint8_tA_K7uint8_t"></span><span id="_CPPv212program_mode7uint8_tA_K7uint8_t"></span><span id="program_mode__uint8_t.uint8_tCA"></span><span class="target" id="core0_8h_1a5036684f11eb837835390659f9e0c4a9"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">program_mode</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">number_of_bytes</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">byte_array</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412program_mode7uint8_tA_K7uint8_t" title="Link to this definition"></a><br /></dt>
<dd><p><p>CV Programming mode function Used on entering programming mode in order to write CV values to persistent flash memory or verify/read bits/bytes from flash.</p>
<p>Refers to NMRA Standard 9.2.3 (“Service Mode Programming”) or RCN-216</p>
</p>
<p>Procedure:<ol class="loweralpha simple">
<li><p>Checks for valid programming command</p></li>
<li><p>Disables core1 timers</p></li>
<li><p>Resets core1</p></li>
<li><p>Saves interrupts</p></li>
<li><p>Evaluates the type of programming instruction Write byte / Verify byte / Verify bit and runs corresponding function</p></li>
<li><p>Restores interrupts</p></li>
<li><p>Launch core1</p></li>
</ol>
</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>number_of_bytes</strong> – Number of bytes in byte_array[] </p></li>
<li><p><strong>byte_array</strong> – Pointer to byte_array[] </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv411set_outputs8uint32_t">
<span id="_CPPv311set_outputs8uint32_t"></span><span id="_CPPv211set_outputs8uint32_t"></span><span id="set_outputs__uint32_t"></span><span class="target" id="core0_8h_1a278792ebcab284a57b088283d570957e"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">set_outputs</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">functions_to_set_bitmask</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv411set_outputs8uint32_t" title="Link to this definition"></a><br /></dt>
<dd><p>Set outputs according to function mapping in CV257 to CV512. </p>
<p>This function maps the functions and direction to the mapped outputs configured in CV257 to CV512. Also enables PWM when enabled according to CV112 to CV115.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>functions_to_set_bitmask</strong> – Function bitmask F0 is bit0, F1 is bit1, … </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv423update_active_functions8uint32_t7uint8_tb">
<span id="_CPPv323update_active_functions8uint32_t7uint8_tb"></span><span id="_CPPv223update_active_functions8uint32_t7uint8_tb"></span><span id="update_active_functions__uint32_t.uint8_t.b"></span><span class="target" id="core0_8h_1a38173806a6d7c084467c72ce23cc47a2"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">update_active_functions</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">new_function_bitmask</span></span>, <span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">clr_bit_ind</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">direction_change</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423update_active_functions8uint32_t7uint8_tb" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv415error_detection6int8_tPK7uint8_t">
<span id="_CPPv315error_detection6int8_tPK7uint8_t"></span><span id="_CPPv215error_detection6int8_tPK7uint8_t"></span><span id="error_detection__int8_t.uint8_tCP"></span><span class="target" id="core0_8h_1a9ac1fe49e3a7374fa60cdf3996138b2c"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">error_detection</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">number_of_bytes</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">byte_array</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415error_detection6int8_tPK7uint8_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv415is_long_address7uint8_tA_K7uint8_t">
<span id="_CPPv315is_long_address7uint8_tA_K7uint8_t"></span><span id="_CPPv215is_long_address7uint8_tA_K7uint8_t"></span><span id="is_long_address__uint8_t.uint8_tCA"></span><span class="target" id="core0_8h_1a0c3523e21bb4baefbe045caa9e35c2d7"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">is_long_address</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">number_of_bytes</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">byte_array</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415is_long_address7uint8_tA_K7uint8_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418address_evaluation7uint8_tA_K7uint8_t">
<span id="_CPPv318address_evaluation7uint8_tA_K7uint8_t"></span><span id="_CPPv218address_evaluation7uint8_tA_K7uint8_t"></span><span id="address_evaluation__uint8_t.uint8_tCA"></span><span class="target" id="core0_8h_1a88ebfc9c05785e606880d290dee9216d"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">address_evaluation</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">number_of_bytes</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">byte_array</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418address_evaluation7uint8_tA_K7uint8_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv422instruction_evaluation7uint8_tA_K7uint8_t">
<span id="_CPPv322instruction_evaluation7uint8_tA_K7uint8_t"></span><span id="_CPPv222instruction_evaluation7uint8_tA_K7uint8_t"></span><span id="instruction_evaluation__uint8_t.uint8_tCA"></span><span class="target" id="core0_8h_1ab7c4b425f063f7945344c8209a097eca"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">instruction_evaluation</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">number_of_bytes</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">byte_array</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422instruction_evaluation7uint8_tA_K7uint8_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv419reset_message_check7uint8_tPCK7uint8_t">
<span id="_CPPv319reset_message_check7uint8_tPCK7uint8_t"></span><span id="_CPPv219reset_message_check7uint8_tPCK7uint8_t"></span><span id="reset_message_check__uint8_t.uint8_tCPC"></span><span class="target" id="core0_8h_1a0ba04419ee6b760e8a19868d3fffc0be"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">reset_message_check</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">number_of_bytes</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">byte_array</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv419reset_message_check7uint8_tPCK7uint8_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418verify_dcc_messagev">
<span id="_CPPv318verify_dcc_messagev"></span><span id="_CPPv218verify_dcc_messagev"></span><span id="verify_dcc_message"></span><span class="target" id="core0_8h_1afe010c2c968965623f9a7409a997b1a8"></span><span class="n"><span class="pre">int8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">verify_dcc_message</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418verify_dcc_messagev" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418bits_to_byte_array6int8_tA_7uint8_t">
<span id="_CPPv318bits_to_byte_array6int8_tA_7uint8_t"></span><span id="_CPPv218bits_to_byte_array6int8_tA_7uint8_t"></span><span id="bits_to_byte_array__int8_t.uint8_tA"></span><span class="target" id="core0_8h_1ac801d52a750572fda6908c63ab265571"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bits_to_byte_array</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">number_of_bytes</span></span>, <span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">byte_array</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418bits_to_byte_array6int8_tA_7uint8_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv416evaluate_messagev">
<span id="_CPPv316evaluate_messagev"></span><span id="_CPPv216evaluate_messagev"></span><span id="evaluate_message"></span><span class="target" id="core0_8h_1a0fc8afa31d573a86427f7e73bdb8a07c"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">evaluate_message</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416evaluate_messagev" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv417track_signal_risejm">
<span id="_CPPv317track_signal_risejm"></span><span id="_CPPv217track_signal_risejm"></span><span id="track_signal_rise__unsigned-i.unsigned-l-i"></span><span class="target" id="core0_8h_1a9e63f26cc0e48c67410c6729a3798126"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">track_signal_rise</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">gpio</span></span>, <span class="kt"><span class="pre">long</span></span><span class="w"> </span><span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">events</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417track_signal_risejm" title="Link to this definition"></a><br /></dt>
<dd><p>Track signal rising edge interrupt callback function. </p>
<p>Saves timer counter value using get_absolute_time(), then disables rising edge IRQ and enables falling edge IRQ. Parameters are unused.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>gpio</strong> – Unused parameter </p></li>
<li><p><strong>events</strong> – Unused parameter </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv417track_signal_falljm">
<span id="_CPPv317track_signal_falljm"></span><span id="_CPPv217track_signal_falljm"></span><span id="track_signal_fall__unsigned-i.unsigned-l-i"></span><span class="target" id="core0_8h_1aa8ee69201d93bb812e1fe4f5feadbfdf"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">track_signal_fall</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">gpio</span></span>, <span class="kt"><span class="pre">long</span></span><span class="w"> </span><span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">events</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417track_signal_falljm" title="Link to this definition"></a><br /></dt>
<dd><p>Track signal falling edge interrupt callback function. </p>
<p>Saves timer counter value using get_absolute_time(), then calculates time difference between rising and falling edge. When the time difference is greater than 87us, this bit is interpreted as a logical 0. Refers to NMRA S-9.1 and RCN-210 standards Puts the latest bit value into buffer, then evaluates complete buffer using evaluate_message(). Parameters are unused.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>gpio</strong> – Unused parameter </p></li>
<li><p><strong>events</strong> – Unused parameter </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv412init_outputsv">
<span id="_CPPv312init_outputsv"></span><span id="_CPPv212init_outputsv"></span><span id="init_outputs"></span><span class="target" id="core0_8h_1a10e6b83317f9b22b5264200049a77138"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">init_outputs</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412init_outputsv" title="Link to this definition"></a><br /></dt>
<dd><p>Output initialization function. </p>
<p><p>Initializes all allowed GPIO outputs as outputs</p>
<p>Sets PWM functionality for GPIOs configured as PWM pins CV_112 - CV_115 (see</p>
CV.h<p>for reference)</p>
<p>PWM frequency and clock divider are configured according to CV_116 - CV_171 (see</p>
CV.h for reference) </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv414cv_setup_checkv">
<span id="_CPPv314cv_setup_checkv"></span><span id="_CPPv214cv_setup_checkv"></span><span id="cv_setup_check"></span><span class="target" id="core0_8h_1afdf05cec06f673d2763ab0631cbe62f8"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cv_setup_check</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414cv_setup_checkv" title="Link to this definition"></a><br /></dt>
<dd><p>Checks various CV values in order to detect factory condition or pending calibrations. </p>
<p>Procedure:<ol class="loweralpha simple">
<li><p>Check for flash memory factory condition when found write default values specified in CV.h to flash memory</p></li>
<li><p>Check for existing ADC offset setup when not found write 7 to read-only CV_7 in order to trigger a ADC offset measurement/calibration</p></li>
<li><p>Check for base PWM configuration/calibration, run calibration when none is found </p></li>
</ol>
</p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv414init_motor_pwm7uint8_t">
<span id="_CPPv314init_motor_pwm7uint8_t"></span><span id="_CPPv214init_motor_pwm7uint8_t"></span><span id="init_motor_pwm__uint8_t"></span><span class="target" id="core0_8h_1aebc81e473ba119c0ce42cacb4efeec69"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">init_motor_pwm</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">gpio</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414init_motor_pwm7uint8_t" title="Link to this definition"></a><br /></dt>
<dd><p>Function initializes motor PWM for pin specified. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>gpio</strong> – GPIO pin </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv48init_adcv">
<span id="_CPPv38init_adcv"></span><span id="_CPPv28init_adcv"></span><span id="init_adc"></span><span class="target" id="core0_8h_1a2d55adaff96e84bf99460f7c9d24f7a4"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">init_adc</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv48init_adcv" title="Link to this definition"></a><br /></dt>
<dd><p>Initializes ADC. </p>
<p>Function initializes ADC, corresponding GPIO pins and ADC FIFO </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-variables">Variables</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv411clr_bit_arr">
<span id="_CPPv311clr_bit_arr"></span><span id="_CPPv211clr_bit_arr"></span><span id="clr_bit_arr__uint32_tCA"></span><span class="target" id="core0_8h_1a3cb7d222f559f6157b67e5b778b3752d"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">clr_bit_arr</span></span></span><span class="p"><span class="pre">[</span></span><span class="m"><span class="pre">6</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="m"><span class="pre">0b11111111111111111111111111100000</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="m"><span class="pre">0b11111111111111111111111000011111</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="m"><span class="pre">0b11111111111111111110000111111111</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="m"><span class="pre">0b11111111111000000001111111111111</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="m"><span class="pre">0b11100000000111111111111111111111</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="m"><span class="pre">0b00011111111111111111111111111111</span></span><span class="p"><span class="pre">,</span></span><span class="p"><span class="pre">}</span></span><a class="headerlink" href="#_CPPv411clr_bit_arr" title="Link to this definition"></a><br /></dt>
<dd><p>Bitmasks used for clearing bits corresponding to function blocks. </p>
<p>[0] = F0-F4 [1] = F5-F8 [2] = F9-F12 [3] = F13-F20 [4] = F21-F28 [5] = F29-F31 </p>
</dd></dl>
</div>
</section>
<section id="core1-h">
<h2>core1.h<a class="headerlink" href="#core1-h" title="Link to this heading"></a></h2>
<p>Used exclusively by core1 </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-defines">Defines</p>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.BASE_PWM_ARR_LEN">
<span class="target" id="core1_8h_1aba55513f2c3a6926e69e09292f8bb949"></span><span class="sig-name descname"><span class="n"><span class="pre">BASE_PWM_ARR_LEN</span></span></span><a class="headerlink" href="#c.BASE_PWM_ARR_LEN" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-typedefs">Typedefs</p>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv420startup_parameters_t">
<span id="_CPPv320startup_parameters_t"></span><span id="_CPPv220startup_parameters_t"></span><span id="startup_parameters_t"></span><span class="target" id="core1_8h_1a268e45d9ddfaadbcc98fee4bc680a27b"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv420startup_parameters_t" title="startup_parameters_t"><span class="n"><span class="pre">startup_parameters_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">startup_parameters_t</span></span></span><a class="headerlink" href="#_CPPv420startup_parameters_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv415pid_parameter_t">
<span id="_CPPv315pid_parameter_t"></span><span id="_CPPv215pid_parameter_t"></span><span id="pid_parameter_t"></span><span class="target" id="core1_8h_1af9bb6e8065eac375407665b91ae271ec"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv416pid_parameters_t" title="pid_parameters_t"><span class="n"><span class="pre">pid_parameters_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">pid_parameter_t</span></span></span><a class="headerlink" href="#_CPPv415pid_parameter_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv422controller_parameter_t">
<span id="_CPPv322controller_parameter_t"></span><span id="_CPPv222controller_parameter_t"></span><span id="controller_parameter_t"></span><span class="target" id="core1_8h_1a1c65bfdf8751d4b575b5a4b8fc38f1bd"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv422controller_parameter_t" title="controller_parameter_t"><span class="n"><span class="pre">controller_parameter_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">controller_parameter_t</span></span></span><a class="headerlink" href="#_CPPv422controller_parameter_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dt class="sig sig-object cpp" id="_CPPv417controller_mode_t">
<span id="_CPPv317controller_mode_t"></span><span id="_CPPv217controller_mode_t"></span><span class="target" id="core1_8h_1a8cd3c75f3685b80544413fd0a411633b"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">controller_mode_t</span></span></span><a class="headerlink" href="#_CPPv417controller_mode_t" title="Link to this definition"></a><br /></dt>
<dd><p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N17controller_mode_t12STARTUP_MODEE">
<span id="_CPPv3N17controller_mode_t12STARTUP_MODEE"></span><span id="_CPPv2N17controller_mode_t12STARTUP_MODEE"></span><span class="target" id="core1_8h_1a8cd3c75f3685b80544413fd0a411633ba7628f1de6231530731abb5ee61043446"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">STARTUP_MODE</span></span></span><a class="headerlink" href="#_CPPv4N17controller_mode_t12STARTUP_MODEE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N17controller_mode_t8PID_MODEE">
<span id="_CPPv3N17controller_mode_t8PID_MODEE"></span><span id="_CPPv2N17controller_mode_t8PID_MODEE"></span><span class="target" id="core1_8h_1a8cd3c75f3685b80544413fd0a411633ba858d0333c99a5e207e2dcff3420bc607"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PID_MODE</span></span></span><a class="headerlink" href="#_CPPv4N17controller_mode_t8PID_MODEE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv440get_speed_step_table_index_of_speed_step7uint8_t">
<span id="_CPPv340get_speed_step_table_index_of_speed_step7uint8_t"></span><span id="_CPPv240get_speed_step_table_index_of_speed_step7uint8_t"></span><span id="get_speed_step_table_index_of_speed_step__uint8_t"></span><span class="target" id="core1_8h_1ad15a9b1bde5e8add464971f292fec1b4"></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">get_speed_step_table_index_of_speed_step</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">speed_step</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv440get_speed_step_table_index_of_speed_step7uint8_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv412speed_helperP15repeating_timer">
<span id="_CPPv312speed_helperP15repeating_timer"></span><span id="_CPPv212speed_helperP15repeating_timer"></span><span id="speed_helper__repeating_timerP"></span><span class="target" id="core1_8h_1abf0e710f65cc80280ed489c5f67cdddb"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">speed_helper</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="n"><span class="pre">repeating_timer</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">t</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412speed_helperP15repeating_timer" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv416adjust_pwm_level8uint16_t">
<span id="_CPPv316adjust_pwm_level8uint16_t"></span><span id="_CPPv216adjust_pwm_level8uint16_t"></span><span id="adjust_pwm_level__uint16_t"></span><span class="target" id="core1_8h_1ab1cbb775c3da8f7890db76d05fa0a584"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">adjust_pwm_level</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">level</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416adjust_pwm_level8uint16_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv46get_kpPK22controller_parameter_t">
<span id="_CPPv36get_kpPK22controller_parameter_t"></span><span id="_CPPv26get_kpPK22controller_parameter_t"></span><span id="get_kp__controller_parameter_tCP"></span><span class="target" id="core1_8h_1a3755e0b693c7bf6b6439e5e824d332be"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">get_kp</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv422controller_parameter_t" title="controller_parameter_t"><span class="n"><span class="pre">controller_parameter_t</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ctrl_par</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv46get_kpPK22controller_parameter_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv417get_initial_levelP22controller_parameter_t">
<span id="_CPPv317get_initial_levelP22controller_parameter_t"></span><span id="_CPPv217get_initial_levelP22controller_parameter_t"></span><span id="get_initial_level__controller_parameter_tP"></span><span class="target" id="core1_8h_1ad5fe7c9d50449d3e4ef78ec94565419a"></span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">get_initial_level</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv422controller_parameter_t" title="controller_parameter_t"><span class="n"><span class="pre">controller_parameter_t</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ctrl_par</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417get_initial_levelP22controller_parameter_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv423controller_startup_modeP22controller_parameter_t">
<span id="_CPPv323controller_startup_modeP22controller_parameter_t"></span><span id="_CPPv223controller_startup_modeP22controller_parameter_t"></span><span id="controller_startup_mode__controller_parameter_tP"></span><span class="target" id="core1_8h_1a40279375ef2e5f7d89bf1898415405a6"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">controller_startup_mode</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv422controller_parameter_t" title="controller_parameter_t"><span class="n"><span class="pre">controller_parameter_t</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ctrl_par</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423controller_startup_modeP22controller_parameter_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv418controller_generalP15repeating_timer">
<span id="_CPPv318controller_generalP15repeating_timer"></span><span id="_CPPv218controller_generalP15repeating_timer"></span><span id="controller_general__repeating_timerP"></span><span class="target" id="core1_8h_1a90048e7088301c59c840e1c31a55b1d6"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">controller_general</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="n"><span class="pre">repeating_timer</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">t</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418controller_generalP15repeating_timer" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv415init_controllerP22controller_parameter_t">
<span id="_CPPv315init_controllerP22controller_parameter_t"></span><span id="_CPPv215init_controllerP22controller_parameter_t"></span><span id="init_controller__controller_parameter_tP"></span><span class="target" id="core1_8h_1adb04e81dde81def278aed72d25cbb105"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">init_controller</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv422controller_parameter_t" title="controller_parameter_t"><span class="n"><span class="pre">controller_parameter_t</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">ctrl_par</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415init_controllerP22controller_parameter_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
<dl class="cpp struct">
<dt class="sig sig-object cpp">
<span class="target" id="structstartup__parameters__t"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">startup_parameters_t</span></span></span><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20startup_parameters_t5levelE">
<span id="_CPPv3N20startup_parameters_t5levelE"></span><span id="_CPPv2N20startup_parameters_t5levelE"></span><span id="startup_parameters_t::level__uint16_t"></span><span class="target" id="structstartup__parameters__t_1a1ac2053478d46e58029bb3800bb5c38c"></span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">level</span></span></span><a class="headerlink" href="#_CPPv4N20startup_parameters_t5levelE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20startup_parameters_t12base_pwm_arrE">
<span id="_CPPv3N20startup_parameters_t12base_pwm_arrE"></span><span id="_CPPv2N20startup_parameters_t12base_pwm_arrE"></span><span id="startup_parameters_t::base_pwm_arr__uint16_tA"></span><span class="target" id="structstartup__parameters__t_1ae89e6e6396857820ed6e39f3a23c9c89"></span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">base_pwm_arr</span></span></span><span class="p"><span class="pre">[</span></span><span class="n"><span class="pre">BASE_PWM_ARR_LEN</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#_CPPv4N20startup_parameters_t12base_pwm_arrE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N20startup_parameters_t14base_pwm_arr_iE">
<span id="_CPPv3N20startup_parameters_t14base_pwm_arr_iE"></span><span id="_CPPv2N20startup_parameters_t14base_pwm_arr_iE"></span><span id="startup_parameters_t::base_pwm_arr_i__uint16_t"></span><span class="target" id="structstartup__parameters__t_1a3a5c3482f5a55e10eb1701a258793371"></span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">base_pwm_arr_i</span></span></span><a class="headerlink" href="#_CPPv4N20startup_parameters_t14base_pwm_arr_iE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv416pid_parameters_t">
<span id="_CPPv316pid_parameters_t"></span><span id="_CPPv216pid_parameters_t"></span><span id="pid_parameters_t"></span><span class="target" id="structpid__parameters__t"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">pid_parameters_t</span></span></span><a class="headerlink" href="#_CPPv416pid_parameters_t" title="Link to this definition"></a><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t3k_iE">
<span id="_CPPv3N16pid_parameters_t3k_iE"></span><span id="_CPPv2N16pid_parameters_t3k_iE"></span><span id="pid_parameters_t::k_i__float"></span><span class="target" id="structpid__parameters__t_1aa46df41f1f9df7fa8df802299b6748c2"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_i</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t3k_iE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t3k_dE">
<span id="_CPPv3N16pid_parameters_t3k_dE"></span><span id="_CPPv2N16pid_parameters_t3k_dE"></span><span id="pid_parameters_t::k_d__float"></span><span class="target" id="structpid__parameters__t_1a1f8ecf470c12550b42ebdb049d37d85b"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_d</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t3k_dE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t1tE">
<span id="_CPPv3N16pid_parameters_t1tE"></span><span id="_CPPv2N16pid_parameters_t1tE"></span><span id="pid_parameters_t::t__float"></span><span class="target" id="structpid__parameters__t_1a47040e90d5954e5bd223b9f2bcdff9a0"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">t</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t1tE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t3tauE">
<span id="_CPPv3N16pid_parameters_t3tauE"></span><span id="_CPPv2N16pid_parameters_t3tauE"></span><span id="pid_parameters_t::tau__float"></span><span class="target" id="structpid__parameters__t_1a0dc08b41dec4104379000e56151f723d"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">tau</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t3tauE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t4ci_0E">
<span id="_CPPv3N16pid_parameters_t4ci_0E"></span><span id="_CPPv2N16pid_parameters_t4ci_0E"></span><span id="pid_parameters_t::ci_0__float"></span><span class="target" id="structpid__parameters__t_1a1ce3d508c6da7fe69a5af3cf50d409b6"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ci_0</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t4ci_0E" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t4cd_0E">
<span id="_CPPv3N16pid_parameters_t4cd_0E"></span><span id="_CPPv2N16pid_parameters_t4cd_0E"></span><span id="pid_parameters_t::cd_0__float"></span><span class="target" id="structpid__parameters__t_1ac3e4fd58ba4d922720ef45e8516760bb"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cd_0</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t4cd_0E" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t4cd_1E">
<span id="_CPPv3N16pid_parameters_t4cd_1E"></span><span id="_CPPv2N16pid_parameters_t4cd_1E"></span><span id="pid_parameters_t::cd_1__float"></span><span class="target" id="structpid__parameters__t_1a63a90165b0e303654ca82e002cacb8e0"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cd_1</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t4cd_1E" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t11int_lim_maxE">
<span id="_CPPv3N16pid_parameters_t11int_lim_maxE"></span><span id="_CPPv2N16pid_parameters_t11int_lim_maxE"></span><span id="pid_parameters_t::int_lim_max__float"></span><span class="target" id="structpid__parameters__t_1a9ec36119304ff43381622aa00d332a62"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">int_lim_max</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t11int_lim_maxE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t11int_lim_minE">
<span id="_CPPv3N16pid_parameters_t11int_lim_minE"></span><span id="_CPPv2N16pid_parameters_t11int_lim_minE"></span><span id="pid_parameters_t::int_lim_min__float"></span><span class="target" id="structpid__parameters__t_1a9796e791e4c2623f4e7d3deb0ea7b08d"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">int_lim_min</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t11int_lim_minE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t10max_outputE">
<span id="_CPPv3N16pid_parameters_t10max_outputE"></span><span id="_CPPv2N16pid_parameters_t10max_outputE"></span><span id="pid_parameters_t::max_output__float"></span><span class="target" id="structpid__parameters__t_1ab2350f82628ae38c4018505fbf1a5883"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">max_output</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t10max_outputE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t3k_pE">
<span id="_CPPv3N16pid_parameters_t3k_pE"></span><span id="_CPPv2N16pid_parameters_t3k_pE"></span><span id="pid_parameters_t::k_p__float"></span><span class="target" id="structpid__parameters__t_1a72b1c5c96245d66176878e7aa38c8756"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_p</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t3k_pE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t1eE">
<span id="_CPPv3N16pid_parameters_t1eE"></span><span id="_CPPv2N16pid_parameters_t1eE"></span><span id="pid_parameters_t::e__float"></span><span class="target" id="structpid__parameters__t_1a0375e1f2063e86a27feae3e853a32a03"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">e</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t1eE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t6e_prevE">
<span id="_CPPv3N16pid_parameters_t6e_prevE"></span><span id="_CPPv2N16pid_parameters_t6e_prevE"></span><span id="pid_parameters_t::e_prev__float"></span><span class="target" id="structpid__parameters__t_1aa92d5226aecc4e8b6c3742fdd4d445bf"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">e_prev</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t6e_prevE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t6i_prevE">
<span id="_CPPv3N16pid_parameters_t6i_prevE"></span><span id="_CPPv2N16pid_parameters_t6i_prevE"></span><span id="pid_parameters_t::i_prev__float"></span><span class="target" id="structpid__parameters__t_1a65e9c8e3b0f3f9aaf267ee7b6e554c10"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">i_prev</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t6i_prevE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t6d_prevE">
<span id="_CPPv3N16pid_parameters_t6d_prevE"></span><span id="_CPPv2N16pid_parameters_t6d_prevE"></span><span id="pid_parameters_t::d_prev__float"></span><span class="target" id="structpid__parameters__t_1a220a56923c26a8cf841d50ea57b5a67d"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">d_prev</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t6d_prevE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t13k_p_x_1_shiftE">
<span id="_CPPv3N16pid_parameters_t13k_p_x_1_shiftE"></span><span id="_CPPv2N16pid_parameters_t13k_p_x_1_shiftE"></span><span id="pid_parameters_t::k_p_x_1_shift__float"></span><span class="target" id="structpid__parameters__t_1a77300a339f34b169d0da5073e4335d00"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_p_x_1_shift</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t13k_p_x_1_shiftE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t7k_p_x_1E">
<span id="_CPPv3N16pid_parameters_t7k_p_x_1E"></span><span id="_CPPv2N16pid_parameters_t7k_p_x_1E"></span><span id="pid_parameters_t::k_p_x_1__float"></span><span class="target" id="structpid__parameters__t_1a91788e0a694057fc26c5e501143fdd7f"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_p_x_1</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t7k_p_x_1E" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t7k_p_x_2E">
<span id="_CPPv3N16pid_parameters_t7k_p_x_2E"></span><span id="_CPPv2N16pid_parameters_t7k_p_x_2E"></span><span id="pid_parameters_t::k_p_x_2__float"></span><span class="target" id="structpid__parameters__t_1aa166dddd26e1e159ecc9e5fe767ee1b7"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_p_x_2</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t7k_p_x_2E" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t7k_p_y_0E">
<span id="_CPPv3N16pid_parameters_t7k_p_y_0E"></span><span id="_CPPv2N16pid_parameters_t7k_p_y_0E"></span><span id="pid_parameters_t::k_p_y_0__float"></span><span class="target" id="structpid__parameters__t_1aee24c721339963d2af868ba253a21097"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_p_y_0</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t7k_p_y_0E" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t7k_p_y_1E">
<span id="_CPPv3N16pid_parameters_t7k_p_y_1E"></span><span id="_CPPv2N16pid_parameters_t7k_p_y_1E"></span><span id="pid_parameters_t::k_p_y_1__float"></span><span class="target" id="structpid__parameters__t_1ab0d0b7909058c7df5eb614e1ac7f1b00"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_p_y_1</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t7k_p_y_1E" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t7k_p_y_2E">
<span id="_CPPv3N16pid_parameters_t7k_p_y_2E"></span><span id="_CPPv2N16pid_parameters_t7k_p_y_2E"></span><span id="pid_parameters_t::k_p_y_2__float"></span><span class="target" id="structpid__parameters__t_1a2852a8d2c96680ef60a9b2efea405bbe"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_p_y_2</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t7k_p_y_2E" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t7k_p_m_1E">
<span id="_CPPv3N16pid_parameters_t7k_p_m_1E"></span><span id="_CPPv2N16pid_parameters_t7k_p_m_1E"></span><span id="pid_parameters_t::k_p_m_1__float"></span><span class="target" id="structpid__parameters__t_1a2e9b3a89f232699c362cf2e36b8f7053"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_p_m_1</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t7k_p_m_1E" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16pid_parameters_t7k_p_m_2E">
<span id="_CPPv3N16pid_parameters_t7k_p_m_2E"></span><span id="_CPPv2N16pid_parameters_t7k_p_m_2E"></span><span id="pid_parameters_t::k_p_m_2__float"></span><span class="target" id="structpid__parameters__t_1a2cb5fa5271b325369bf135668b286c06"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">k_p_m_2</span></span></span><a class="headerlink" href="#_CPPv4N16pid_parameters_t7k_p_m_2E" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
<dl class="cpp struct">
<dt class="sig sig-object cpp">
<span class="target" id="structcontroller__parameter__t"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">controller_parameter_t</span></span></span><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t4modeE">
<span id="_CPPv3N22controller_parameter_t4modeE"></span><span id="_CPPv2N22controller_parameter_t4modeE"></span><span id="controller_parameter_t::mode__controller_mode_t"></span><span class="target" id="structcontroller__parameter__t_1ab1ae402f2f7f09d0d05442395db34fc2"></span><a class="reference internal" href="#_CPPv417controller_mode_t" title="controller_mode_t"><span class="n"><span class="pre">controller_mode_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">mode</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t4modeE" title="Link to this definition"></a><br /></dt>
<dd><p>General Variables </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t8feed_fwdE">
<span id="_CPPv3N22controller_parameter_t8feed_fwdE"></span><span id="_CPPv2N22controller_parameter_t8feed_fwdE"></span><span id="controller_parameter_t::feed_fwd__float"></span><span class="target" id="structcontroller__parameter__t_1aa1bd918ef17ead45c71448a6267825cf"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">feed_fwd</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t8feed_fwdE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t8setpointE">
<span id="_CPPv3N22controller_parameter_t8setpointE"></span><span id="_CPPv2N22controller_parameter_t8setpointE"></span><span id="controller_parameter_t::setpoint__uint32_t"></span><span class="target" id="structcontroller__parameter__t_1ab9634817457d201f929a9bc098c1f766"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">setpoint</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t8setpointE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t11speed_tableE">
<span id="_CPPv3N22controller_parameter_t11speed_tableE"></span><span id="_CPPv2N22controller_parameter_t11speed_tableE"></span><span id="controller_parameter_t::speed_table__uint16_tA"></span><span class="target" id="structcontroller__parameter__t_1a2b09ccb832a336dabdc013ed562c37b7"></span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">speed_table</span></span></span><span class="p"><span class="pre">[</span></span><span class="m"><span class="pre">127</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t11speed_tableE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t7startupE">
<span id="_CPPv3N22controller_parameter_t7startupE"></span><span id="_CPPv2N22controller_parameter_t7startupE"></span><span id="controller_parameter_t::startup__startup_parameters_t"></span><span class="target" id="structcontroller__parameter__t_1a822da032b330334aa8a0733a91179ba5"></span><a class="reference internal" href="#_CPPv420startup_parameters_t" title="startup_parameters_t"><span class="n"><span class="pre">startup_parameters_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">startup</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t7startupE" title="Link to this definition"></a><br /></dt>
<dd><p>Startup controller mode specific variables </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t3pidE">
<span id="_CPPv3N22controller_parameter_t3pidE"></span><span id="_CPPv2N22controller_parameter_t3pidE"></span><span id="controller_parameter_t::pid__pid_parameter_t"></span><span class="target" id="structcontroller__parameter__t_1a16b8de518efae3670eb11e322e30441b"></span><a class="reference internal" href="#_CPPv415pid_parameter_t" title="pid_parameter_t"><span class="n"><span class="pre">pid_parameter_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">pid</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t3pidE" title="Link to this definition"></a><br /></dt>
<dd><p>PID Controller variables </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t11measurementE">
<span id="_CPPv3N22controller_parameter_t11measurementE"></span><span id="_CPPv2N22controller_parameter_t11measurementE"></span><span id="controller_parameter_t::measurement__float"></span><span class="target" id="structcontroller__parameter__t_1a2e388384f042125782740d5c07479f84"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">measurement</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t11measurementE" title="Link to this definition"></a><br /></dt>
<dd><p>Measurement Variables </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t16measurement_prevE">
<span id="_CPPv3N22controller_parameter_t16measurement_prevE"></span><span id="_CPPv2N22controller_parameter_t16measurement_prevE"></span><span id="controller_parameter_t::measurement_prev__float"></span><span class="target" id="structcontroller__parameter__t_1a72a9ce7353fc3820cd19ca6f64399cfa"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">measurement_prev</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t16measurement_prevE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t21measurement_correctedE">
<span id="_CPPv3N22controller_parameter_t21measurement_correctedE"></span><span id="_CPPv2N22controller_parameter_t21measurement_correctedE"></span><span id="controller_parameter_t::measurement_corrected__float"></span><span class="target" id="structcontroller__parameter__t_1aec58b594e332c724cbfbea5066fefd60"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">measurement_corrected</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t21measurement_correctedE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t10adc_offsetE">
<span id="_CPPv3N22controller_parameter_t10adc_offsetE"></span><span id="_CPPv2N22controller_parameter_t10adc_offsetE"></span><span id="controller_parameter_t::adc_offset__float"></span><span class="target" id="structcontroller__parameter__t_1a4de7e33660f98516e5b9621f3f821f74"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">adc_offset</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t10adc_offsetE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t15msr_delay_in_usE">
<span id="_CPPv3N22controller_parameter_t15msr_delay_in_usE"></span><span id="_CPPv2N22controller_parameter_t15msr_delay_in_usE"></span><span id="controller_parameter_t::msr_delay_in_us__uint8_t"></span><span class="target" id="structcontroller__parameter__t_1a0ae5a278e180343a62f8f9e2ae2457a1"></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">msr_delay_in_us</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t15msr_delay_in_usE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t20msr_total_iterationsE">
<span id="_CPPv3N22controller_parameter_t20msr_total_iterationsE"></span><span id="_CPPv2N22controller_parameter_t20msr_total_iterationsE"></span><span id="controller_parameter_t::msr_total_iterations__uint8_t"></span><span class="target" id="structcontroller__parameter__t_1aff7757c736665c0344bd5fe3517e989b"></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">msr_total_iterations</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t20msr_total_iterationsE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t17l_side_arr_cutoffE">
<span id="_CPPv3N22controller_parameter_t17l_side_arr_cutoffE"></span><span id="_CPPv2N22controller_parameter_t17l_side_arr_cutoffE"></span><span id="controller_parameter_t::l_side_arr_cutoff__uint8_t"></span><span class="target" id="structcontroller__parameter__t_1a0aa2e48fa1fbdb2de2519d50c3dfe820"></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">l_side_arr_cutoff</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t17l_side_arr_cutoffE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N22controller_parameter_t17r_side_arr_cutoffE">
<span id="_CPPv3N22controller_parameter_t17r_side_arr_cutoffE"></span><span id="_CPPv2N22controller_parameter_t17r_side_arr_cutoffE"></span><span id="controller_parameter_t::r_side_arr_cutoff__uint8_t"></span><span class="target" id="structcontroller__parameter__t_1a082cd031e88fe690cb0440899fa69d5d"></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">r_side_arr_cutoff</span></span></span><a class="headerlink" href="#_CPPv4N22controller_parameter_t17r_side_arr_cutoffE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
</section>
<section id="shared-h">
<h2>shared.h<a class="headerlink" href="#shared-h" title="Link to this heading"></a></h2>
<p>Used by both cores </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-defines">Defines</p>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.LOGLEVEL">
<span class="target" id="shared_8h_1a6c6fd5e242df15a7a42e9b75d55d5d3c"></span><span class="sig-name descname"><span class="n"><span class="pre">LOGLEVEL</span></span></span><a class="headerlink" href="#c.LOGLEVEL" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.LOG">
<span class="target" id="shared_8h_1acaa1c3fa56061380a29889d703236251"></span><span class="sig-name descname"><span class="n"><span class="pre">LOG</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">level</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.LOG" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c._125M">
<span class="target" id="shared_8h_1a11ae1c54493c00fc571ead5bca55d269"></span><span class="sig-name descname"><span class="n"><span class="pre">_125M</span></span></span><a class="headerlink" href="#c._125M" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.DCC_INPUT_PIN">
<span class="target" id="shared_8h_1ac71e492f5f272f07b812ebe18757a2f4"></span><span class="sig-name descname"><span class="n"><span class="pre">DCC_INPUT_PIN</span></span></span><a class="headerlink" href="#c.DCC_INPUT_PIN" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.MOTOR_FWD_PIN">
<span class="target" id="shared_8h_1a480d8c98b645b4e4f17d894f550c3626"></span><span class="sig-name descname"><span class="n"><span class="pre">MOTOR_FWD_PIN</span></span></span><a class="headerlink" href="#c.MOTOR_FWD_PIN" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.MOTOR_REV_PIN">
<span class="target" id="shared_8h_1a313656e92150fc5f9203726df3a8a68c"></span><span class="sig-name descname"><span class="n"><span class="pre">MOTOR_REV_PIN</span></span></span><a class="headerlink" href="#c.MOTOR_REV_PIN" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.FWD_V_EMF_ADC_PIN">
<span class="target" id="shared_8h_1adbc76b66e92d86f9cfe27f51253a5038"></span><span class="sig-name descname"><span class="n"><span class="pre">FWD_V_EMF_ADC_PIN</span></span></span><a class="headerlink" href="#c.FWD_V_EMF_ADC_PIN" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.REV_V_EMF_ADC_PIN">
<span class="target" id="shared_8h_1af7c9c4bc8bfd08aa5169978af9bf17c9"></span><span class="sig-name descname"><span class="n"><span class="pre">REV_V_EMF_ADC_PIN</span></span></span><a class="headerlink" href="#c.REV_V_EMF_ADC_PIN" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.GPIO_OUTPUT_PIN_MASK">
<span class="target" id="shared_8h_1a613516de560d9a5355520b76b256a58d"></span><span class="sig-name descname"><span class="n"><span class="pre">GPIO_OUTPUT_PIN_MASK</span></span></span><a class="headerlink" href="#c.GPIO_OUTPUT_PIN_MASK" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.GPIO_ILLEGAL_MASK">
<span class="target" id="shared_8h_1a544001c09a62a396743e564a9e0bd9d4"></span><span class="sig-name descname"><span class="n"><span class="pre">GPIO_ILLEGAL_MASK</span></span></span><a class="headerlink" href="#c.GPIO_ILLEGAL_MASK" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.GPIO_ALLOWED_OUTPUTS">
<span class="target" id="shared_8h_1ae4b0910bc8b035c26ded8b9498bf4f50"></span><span class="sig-name descname"><span class="n"><span class="pre">GPIO_ALLOWED_OUTPUTS</span></span></span><a class="headerlink" href="#c.GPIO_ALLOWED_OUTPUTS" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.FLASH_TARGET_OFFSET">
<span class="target" id="shared_8h_1a21df7978a7e635eaa5037d4c853cd15d"></span><span class="sig-name descname"><span class="n"><span class="pre">FLASH_TARGET_OFFSET</span></span></span><a class="headerlink" href="#c.FLASH_TARGET_OFFSET" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv411core1_entryv">
<span id="_CPPv311core1_entryv"></span><span id="_CPPv211core1_entryv"></span><span id="core1_entry"></span><span class="target" id="shared_8h_1a9f153132b8b4afad133b952111e18bd9"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">core1_entry</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv411core1_entryv" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv416write_cv_handler8uint16_t7uint8_t">
<span id="_CPPv316write_cv_handler8uint16_t7uint8_t"></span><span id="_CPPv216write_cv_handler8uint16_t7uint8_t"></span><span id="write_cv_handler__uint16_t.uint8_t"></span><span class="target" id="shared_8h_1a58018bb4ac50fbe1d7df43baa1decc82"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">write_cv_handler</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">cv_index</span></span>, <span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">cv_data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416write_cv_handler8uint16_t7uint8_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_tb">
<span id="_CPPv37measure7uint8_t7uint8_t7uint8_t7uint8_tb"></span><span id="_CPPv27measure7uint8_t7uint8_t7uint8_t7uint8_tb"></span><span id="measure__uint8_t.uint8_t.uint8_t.uint8_t.b"></span><span class="target" id="shared_8h_1a10fb56d0c68ae9f38512204e089fe026"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">measure</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">total_iterations</span></span>, <span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">measurement_delay_us</span></span>, <span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">l_side_arr_cutoff</span></span>, <span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">r_side_arr_cutoff</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">direction</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_tb" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv412get_32bit_CV8uint16_t">
<span id="_CPPv312get_32bit_CV8uint16_t"></span><span id="_CPPv212get_32bit_CV8uint16_t"></span><span id="get_32bit_CV__uint16_t"></span><span class="target" id="shared_8h_1affc14a889b226b8ebcbf64774a5e1c53"></span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">get_32bit_CV</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">CV_start_index</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412get_32bit_CV8uint16_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv412get_16bit_CV8uint16_t">
<span id="_CPPv312get_16bit_CV8uint16_t"></span><span id="_CPPv212get_16bit_CV8uint16_t"></span><span id="get_16bit_CV__uint16_t"></span><span class="target" id="shared_8h_1a32beddf80bbca0e114f8d72ed3937889"></span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">get_16bit_CV</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint16_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">CV_start_index</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412get_16bit_CV8uint16_t" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv427get_direction_of_speed_step7uint8_t">
<span id="_CPPv327get_direction_of_speed_step7uint8_t"></span><span id="_CPPv227get_direction_of_speed_step7uint8_t"></span><span id="get_direction_of_speed_step__uint8_t"></span><span class="target" id="shared_8h_1aed72641466dd9da550e446ad104607d0"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">get_direction_of_speed_step</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">speed_step</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427get_direction_of_speed_step7uint8_t" title="Link to this definition"></a><br /></dt>
<dd><p>Calculates the direction based on a speed step byte. </p>
<p>This function calculates the direction of movement based on the value of the <code class="docutils literal notranslate"><span class="pre">speed_step</span></code> byte. It refers to the “128 Speed Control” standard as outlined in NMRA Standard 9.2.1 section 2.3.2.1 or RCN-212 section 2.2.2.</p>
<p>The following speed steps are defined:</p>
<p><table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>DEC </p></th>
<th class="head"><p>BIN </p></th>
<th class="head"><p>DIRECTION </p></th>
<th class="head"><p>DEFINITION </p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>000 </p></td>
<td><p>0000 0000 </p></td>
<td><p>Reverse </p></td>
<td><p>STOP </p></td>
</tr>
<tr class="row-odd"><td><p>001 </p></td>
<td><p>0000 0001 </p></td>
<td><p>Reverse </p></td>
<td><p>EMERGENCY STOP </p></td>
</tr>
<tr class="row-even"><td><p>002 </p></td>
<td><p>0000 0010 </p></td>
<td><p>Reverse </p></td>
<td><p>Speed step 001 </p></td>
</tr>
<tr class="row-odd"><td><p>003 </p></td>
<td><p>0000 0011 </p></td>
<td><p>Reverse </p></td>
<td><p>Speed step 002 </p></td>
</tr>
<tr class="row-even"><td><p>004 </p></td>
<td><p>0000 0100 </p></td>
<td><p>Reverse </p></td>
<td><p>Speed step 003 </p></td>
</tr>
<tr class="row-odd"><td><p>… </p></td>
<td><p>…. …. </p></td>
<td><p>Reverse </p></td>
<td><p>… </p></td>
</tr>
<tr class="row-even"><td><p>126 </p></td>
<td><p>0111 1110 </p></td>
<td><p>Reverse </p></td>
<td><p>Speed step 125 </p></td>
</tr>
<tr class="row-odd"><td><p>127 </p></td>
<td><p>0111 1111 </p></td>
<td><p>Reverse </p></td>
<td><p>Speed step 126 </p></td>
</tr>
<tr class="row-even"><td><p>128 </p></td>
<td><p>1000 0000 </p></td>
<td><p>Forward </p></td>
<td><p>STOP </p></td>
</tr>
<tr class="row-odd"><td><p>129 </p></td>
<td><p>1000 0001 </p></td>
<td><p>Forward </p></td>
<td><p>EMERGENCY STOP </p></td>
</tr>
<tr class="row-even"><td><p>130 </p></td>
<td><p>1000 0010 </p></td>
<td><p>Forward </p></td>
<td><p>Speed step 001 </p></td>
</tr>
<tr class="row-odd"><td><p>131 </p></td>
<td><p>1000 0011 </p></td>
<td><p>Forward </p></td>
<td><p>Speed step 002 </p></td>
</tr>
<tr class="row-even"><td><p>132 </p></td>
<td><p>1000 0100 </p></td>
<td><p>Forward </p></td>
<td><p>Speed step 003 </p></td>
</tr>
<tr class="row-odd"><td><p>… </p></td>
<td><p>…. …. </p></td>
<td><p>Forward </p></td>
<td><p>… </p></td>
</tr>
<tr class="row-even"><td><p>254 </p></td>
<td><p>1111 1110 </p></td>
<td><p>Forward </p></td>
<td><p>Speed step 125 </p></td>
</tr>
<tr class="row-odd"><td><p>255 </p></td>
<td><p>1111 1111 </p></td>
<td><p>Forward </p></td>
<td><p>Speed step 126 </p></td>
</tr>
</tbody>
</table>
</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>speed_step</strong> – The speed step byte. </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">true</span></code> for forward direction, <code class="docutils literal notranslate"><span class="pre">false</span></code> for reverse direction. </p>
</dd>
</dl>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-variables">Variables</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv417pid_control_timer">
<span id="_CPPv317pid_control_timer"></span><span id="_CPPv217pid_control_timer"></span><span id="pid_control_timer__repeating_timer_t"></span><span class="target" id="shared_8h_1acb0acf1449e6540098ea12180e946d48"></span><span class="n"><span class="pre">repeating_timer_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">pid_control_timer</span></span></span><a class="headerlink" href="#_CPPv417pid_control_timer" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv418speed_helper_timer">
<span id="_CPPv318speed_helper_timer"></span><span id="_CPPv218speed_helper_timer"></span><span id="speed_helper_timer__repeating_timer_t"></span><span class="target" id="shared_8h_1a997c9c1785ccb1f19d61d96ddb9c6d1a"></span><span class="n"><span class="pre">repeating_timer_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">speed_helper_timer</span></span></span><a class="headerlink" href="#_CPPv418speed_helper_timer" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv414CV_ARRAY_FLASH">
<span id="_CPPv314CV_ARRAY_FLASH"></span><span id="_CPPv214CV_ARRAY_FLASH"></span><span id="CV_ARRAY_FLASH__uint8_tCP"></span><span class="target" id="shared_8h_1ac1d1205049d95e5b1789bbabe78375df"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">CV_ARRAY_FLASH</span></span></span><a class="headerlink" href="#_CPPv414CV_ARRAY_FLASH" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv417speed_step_target">
<span id="_CPPv317speed_step_target"></span><span id="_CPPv217speed_step_target"></span><span id="speed_step_target__uint8_t"></span><span class="target" id="shared_8h_1afe526de436479f50bbbf21d68b132b5c"></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">speed_step_target</span></span></span><a class="headerlink" href="#_CPPv417speed_step_target" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv422speed_step_target_prev">
<span id="_CPPv322speed_step_target_prev"></span><span id="_CPPv222speed_step_target_prev"></span><span id="speed_step_target_prev__uint8_t"></span><span class="target" id="shared_8h_1af3e1c0713b69e9c5b7c71a01d4e5475c"></span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">speed_step_target_prev</span></span></span><a class="headerlink" href="#_CPPv422speed_step_target_prev" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
</section>
<section id="cv-h">
<h2>CV.h<a class="headerlink" href="#cv-h" title="Link to this heading"></a></h2>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-defines">Defines</p>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.CV_ARRAY_SIZE">
<span class="target" id="CV_8h_1a02e12d74b0732a0c7c123ddbb7b168db"></span><span class="sig-name descname"><span class="n"><span class="pre">CV_ARRAY_SIZE</span></span></span><a class="headerlink" href="#c.CV_ARRAY_SIZE" title="Link to this definition"></a><br /></dt>
<dd></dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp">
<span class="target" id="CV_8h_1aea9ea29b1d7e4e37735ef4f735b18f7b"></span><span class="sig-name descname"><span class="pre">uint8_t</span> <span class="pre">__in_flash</span> <span class="pre">(&quot;Default_CV_values&quot;)</span> <span class="pre">CV_ARRAY_DEFAULT[CV_ARRAY_SIZE]</span></span></dt>
<dd></dd></dl>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="sw_description.html" class="btn btn-neutral float-left" title="Software Description" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../other/CV_list.html" class="btn btn-neutral float-right" title="Configuration Variables (CV)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Gabriel Koppenstein.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>