deploy: cc48cca779
This commit is contained in:
1 parent
42624d163b
commit
f433c2cbab
8 files changed
+847
-443
No files matched your search
Binary file not shown.
Binary file not shown.
+10
-10
@@ -254,17 +254,19 @@
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="software/header_files.html#_CPPv415error_detection6size_tPK7uint8_t">error_detection (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv411error_state">error_state (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv47error_t">error_t (C++ enum)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv4N7error_t36FLASH_SAFE_EXECUTE_CORE_INIT_FAILUREE">error_t::FLASH_SAFE_EXECUTE_CORE_INIT_FAILURE (C++ enumerator)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv4N7error_t32FLASH_SAFE_EXECUTE_ERASE_FAILUREE">error_t::FLASH_SAFE_EXECUTE_ERASE_FAILURE (C++ enumerator)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv4N7error_t34FLASH_SAFE_EXECUTE_PROGRAM_FAILUREE">error_t::FLASH_SAFE_EXECUTE_PROGRAM_FAILURE (C++ enumerator)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="software/header_files.html#_CPPv4N7error_t34FLASH_SAFE_EXECUTE_PROGRAM_FAILUREE">error_t::FLASH_SAFE_EXECUTE_PROGRAM_FAILURE (C++ enumerator)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv4N7error_t27FLASH_SIZE_READBACK_FAILUREE">error_t::FLASH_SIZE_READBACK_FAILURE (C++ enumerator)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv4N7error_t17INVALID_DIRECTIONE">error_t::INVALID_DIRECTION (C++ enumerator)</a>
|
||||
@@ -371,12 +373,12 @@
|
||||
<h2 id="P">P</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="software/header_files.html#_CPPv417pid_control_timer">pid_control_timer (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv415pid_parameter_t">pid_parameter_t (C++ type)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv416pid_parameters_t">pid_parameters_t (C++ struct)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="software/header_files.html#_CPPv416pid_parameters_t">(C++ type)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="software/header_files.html#_CPPv4N16pid_parameters_t4cd_0E">pid_parameters_t::cd_0 (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv4N16pid_parameters_t4cd_1E">pid_parameters_t::cd_1 (C++ member)</a>
|
||||
@@ -397,10 +399,10 @@
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv4N16pid_parameters_t3k_dE">pid_parameters_t::k_d (C++ member)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="software/header_files.html#_CPPv4N16pid_parameters_t3k_iE">pid_parameters_t::k_i (C++ member)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="software/header_files.html#_CPPv4N16pid_parameters_t3k_pE">pid_parameters_t::k_p (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv4N16pid_parameters_t7k_p_m_1E">pid_parameters_t::k_p_m_1 (C++ member)</a>
|
||||
@@ -454,8 +456,6 @@
|
||||
<li><a href="software/header_files.html#_CPPv411set_outputs8uint32_t">set_outputs (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv412speed_helperP22controller_parameter_t">speed_helper (C++ function)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv418speed_helper_timer">speed_helper_timer (C++ member)</a>
|
||||
</li>
|
||||
<li><a href="software/header_files.html#_CPPv412speed_step_t">speed_step_t (C++ enum)</a>
|
||||
</li>
|
||||
|
||||
+25
-4
@@ -168,7 +168,7 @@
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="software/header_files.html#core1-h">core1.h</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv420startup_parameters_t"><code class="docutils literal notranslate"><span class="pre">startup_parameters_t</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv415pid_parameter_t"><code class="docutils literal notranslate"><span class="pre">pid_parameter_t</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv416pid_parameters_t"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv422controller_parameter_t"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv417controller_mode_t"><code class="docutils literal notranslate"><span class="pre">controller_mode_t</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv47measure7uint8_t7uint8_t7uint8_t7uint8_t11direction_t"><code class="docutils literal notranslate"><span class="pre">measure()</span></code></a></li>
|
||||
@@ -184,7 +184,29 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N20startup_parameters_t5levelE"><code class="docutils literal notranslate"><span class="pre">startup_parameters_t::level</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_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-l3"><a class="reference internal" href="software/header_files.html#_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-l3"><a class="reference internal" href="software/header_files.html#_CPPv416pid_parameters_t"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t3k_iE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_i</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t3k_dE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_d</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t1tE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::t</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t3tauE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::tau</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t4ci_0E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::ci_0</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t4cd_0E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::cd_0</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t4cd_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::cd_1</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t11int_lim_maxE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::int_lim_max</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t11int_lim_minE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::int_lim_min</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t10max_outputE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::max_output</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t3k_pE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t1eE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::e</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t6e_prevE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::e_prev</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t6i_prevE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::i_prev</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t6d_prevE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::d_prev</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t13k_p_x_1_shiftE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_x_1_shift</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t7k_p_x_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_x_1</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t7k_p_x_2E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_x_2</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t7k_p_y_0E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_y_0</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t7k_p_y_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_y_1</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t7k_p_y_2E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_y_2</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t7k_p_m_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_m_1</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N16pid_parameters_t7k_p_m_2E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_m_2</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N22controller_parameter_t4modeE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::mode</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N22controller_parameter_t8feed_fwdE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::feed_fwd</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv4N22controller_parameter_t8setpointE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::setpoint</span></code></a></li>
|
||||
@@ -213,13 +235,12 @@
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv411clear_error7error_t"><code class="docutils literal notranslate"><span class="pre">clear_error()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv416clear_all_errorsv"><code class="docutils literal notranslate"><span class="pre">clear_all_errors()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv415get_error_statev"><code class="docutils literal notranslate"><span class="pre">get_error_state()</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv417pid_control_timer"><code class="docutils literal notranslate"><span class="pre">pid_control_timer</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv418speed_helper_timer"><code class="docutils literal notranslate"><span class="pre">speed_helper_timer</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv414CV_ARRAY_FLASH"><code class="docutils literal notranslate"><span class="pre">CV_ARRAY_FLASH</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv417speed_step_target"><code class="docutils literal notranslate"><span class="pre">speed_step_target</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv422speed_step_target_prev"><code class="docutils literal notranslate"><span class="pre">speed_step_target_prev</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv419cv_setup_check_done"><code class="docutils literal notranslate"><span class="pre">cv_setup_check_done</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv433flash_safe_execute_core_init_done"><code class="docutils literal notranslate"><span class="pre">flash_safe_execute_core_init_done</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="software/header_files.html#_CPPv411error_state"><code class="docutils literal notranslate"><span class="pre">error_state</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="software/header_files.html#cv-h">CV.h</a><ul>
|
||||
|
||||
Binary file not shown.
@@ -1 +1 @@
|
||||
Search.setIndex({"alltitles": {"1. Where to get the board?": [[0, "where-to-get-the-board"]], "2. Production files?": [[0, "production-files"]], "3. Building the software": [[0, "building-the-software"]], "4. Flashing the software": [[0, "flashing-the-software"]], "4.1. Flashing the software via .uf2 file": [[0, "flashing-the-software-via-uf2-file"]], "4.2. Flashing the software via SWD": [[0, "flashing-the-software-via-swd"]], "5. Wiring": [[0, "wiring"]], "6. Resolving issues": [[0, "resolving-issues"]], "Auxiliary Outputs": [[2, "auxiliary-outputs"], [3, "auxiliary-outputs"]], "Back-EMF voltage measurement": [[11, "back-emf-voltage-measurement"]], "CV List": [[5, "cv-list"]], "CV Reset:": [[8, "cv-reset"]], "CV.h": [[9, "cv-h"]], "CV_{116} to CV_{171} - PWM Slice configuration": [[5, "cv-116-to-cv-171-pwm-slice-configuration"]], "CV_{11} - Packet timeout": [[5, "cv-11-packet-timeout"]], "CV_{12} - Permitted operating modes": [[5, "cv-12-permitted-operating-modes"]], "CV_{17} & CV_{18} - 14-Bit extended/long address": [[5, "cv-17-cv-18-14-bit-extended-long-address"]], "CV_{1} - Basic address": [[5, "cv-1-basic-address"]], "CV_{29} - Decoder Configuration": [[5, "cv-29-decoder-configuration"]], "CV_{2} - v_{min}": [[5, "cv-2-v-min"]], "CV_{31} & CV_{32} - Extended CV pointer (Read-Only)": [[5, "cv-31-cv-32-extended-cv-pointer-read-only"]], "CV_{3} - Acceleration rate": [[5, "cv-3-acceleration-rate"]], "CV_{4} - Deceleration rate": [[5, "cv-4-deceleration-rate"]], "CV_{5} - v_{max}": [[5, "cv-5-v-max"]], "CV_{6} - v_{mid}": [[5, "cv-6-v-mid"]], "CV_{7} - Version No. (Read-Only)": [[5, "cv-7-version-no-read-only"]], "CV_{8} - Manufacturer (Read-Only)": [[5, "cv-8-manufacturer-read-only"]], "CV_{9} - Motor PWM Frequency": [[5, "cv-9-motor-pwm-frequency"]], "Check your motor:": [[8, "check-your-motor"]], "Checking the power supply:": [[8, "checking-the-power-supply"]], "Complete Schematic": [[2, "complete-schematic"], [3, "complete-schematic"]], "Configuration Variables (CV)": [[5, null]], "Contents:": [[4, null], [7, null], [10, null]], "Control Loop & Digital Controller": [[11, "control-loop-digital-controller"]], "DCC signal decoding": [[11, "dcc-signal-decoding"]], "Debugging and Logging": [[6, null]], "Debugging via SWD": [[6, "debugging-via-swd"]], "Electrical Characteristics": [[2, "electrical-characteristics"], [3, "electrical-characteristics"]], "Electrical Characteristics & Absolute Maximum Ratings": [[2, "id2"], [3, "id2"]], "Enable logging and or debug via SWD": [[8, "enable-logging-and-or-debug-via-swd"]], "Feed-forward": [[11, "id2"]], "GPIO": [[2, "gpio"], [3, "gpio"]], "Gain Scheduling": [[11, "gain-scheduling"]], "Getting started": [[0, null]], "Hardware": [[1, null]], "Input Stage": [[2, "input-stage"], [3, "input-stage"]], "Logging": [[6, "logging"]], "Microcontroller": [[2, "microcontroller"], [3, "microcontroller"]], "Motor Driver": [[2, "motor-driver"], [3, "motor-driver"]], "Other": [[7, null]], "Overview": [[2, null], [3, null], [11, "overview"]], "PID Controller": [[11, "pid-controller"]], "RP2040-Decoder Documentation": [[4, null]], "Reset all CVs": [[5, "reset-all-cvs"]], "Revision 0.3": [[1, "revision-0-3"]], "Revision 1.0": [[1, "revision-1-0"]], "Software": [[10, null]], "Software Description": [[11, null]], "Speed step configuration": [[5, "speed-step-configuration"]], "Startup Controller": [[11, "startup-controller"]], "Troubleshooting": [[8, null]], "Wiring the Decoder": [[2, "wiring-the-decoder"], [3, "wiring-the-decoder"]], "core0.h": [[9, null]], "core1.h": [[9, "core1-h"]], "shared.h": [[9, "shared-h"]]}, "docnames": ["gs/getting_started", "hardware/index", "hardware/rev_0_3/hw_description", "hardware/rev_1_0/hw_description", "index", "other/CV_list", "other/debug_logging", "other/index", "other/troubleshooting", "software/header_files", "software/index", "software/sw_description"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["gs/getting_started.rst", "hardware/index.rst", "hardware/rev_0_3/hw_description.rst", "hardware/rev_1_0/hw_description.rst", "index.rst", "other/CV_list.rst", "other/debug_logging.rst", "other/index.rst", "other/troubleshooting.rst", "software/header_files.rst", "software/index.rst", "software/sw_description.rst"], "indexentries": {"_125m (c macro)": [[9, "c._125M", false]], "absolute_val (c++ function)": [[9, "_CPPv412absolute_vali", false]], "acknowledge (c++ function)": [[9, "_CPPv411acknowledgev", false]], "adc_calibration_iterations (c macro)": [[9, "c.ADC_CALIBRATION_ITERATIONS", false]], "adc_offset_adjustment (c++ function)": [[9, "_CPPv421adc_offset_adjustment8uint32_t", false]], "address_evaluation (c++ function)": [[9, "_CPPv418address_evaluation6size_tA_K7uint8_t", false]Line truncated
|
||||
Search.setIndex({"alltitles": {"1. Where to get the board?": [[0, "where-to-get-the-board"]], "2. Production files?": [[0, "production-files"]], "3. Building the software": [[0, "building-the-software"]], "4. Flashing the software": [[0, "flashing-the-software"]], "4.1. Flashing the software via .uf2 file": [[0, "flashing-the-software-via-uf2-file"]], "4.2. Flashing the software via SWD": [[0, "flashing-the-software-via-swd"]], "5. Wiring": [[0, "wiring"]], "6. Resolving issues": [[0, "resolving-issues"]], "Auxiliary Outputs": [[2, "auxiliary-outputs"], [3, "auxiliary-outputs"]], "Back-EMF voltage measurement": [[11, "back-emf-voltage-measurement"]], "CV List": [[5, "cv-list"]], "CV Reset:": [[8, "cv-reset"]], "CV.h": [[9, "cv-h"]], "CV_{116} to CV_{171} - PWM Slice configuration": [[5, "cv-116-to-cv-171-pwm-slice-configuration"]], "CV_{11} - Packet timeout": [[5, "cv-11-packet-timeout"]], "CV_{12} - Permitted operating modes": [[5, "cv-12-permitted-operating-modes"]], "CV_{17} & CV_{18} - 14-Bit extended/long address": [[5, "cv-17-cv-18-14-bit-extended-long-address"]], "CV_{1} - Basic address": [[5, "cv-1-basic-address"]], "CV_{29} - Decoder Configuration": [[5, "cv-29-decoder-configuration"]], "CV_{2} - v_{min}": [[5, "cv-2-v-min"]], "CV_{31} & CV_{32} - Extended CV pointer (Read-Only)": [[5, "cv-31-cv-32-extended-cv-pointer-read-only"]], "CV_{3} - Acceleration rate": [[5, "cv-3-acceleration-rate"]], "CV_{4} - Deceleration rate": [[5, "cv-4-deceleration-rate"]], "CV_{5} - v_{max}": [[5, "cv-5-v-max"]], "CV_{6} - v_{mid}": [[5, "cv-6-v-mid"]], "CV_{7} - Version No. (Read-Only)": [[5, "cv-7-version-no-read-only"]], "CV_{8} - Manufacturer (Read-Only)": [[5, "cv-8-manufacturer-read-only"]], "CV_{9} - Motor PWM Frequency": [[5, "cv-9-motor-pwm-frequency"]], "Check your motor:": [[8, "check-your-motor"]], "Checking the power supply:": [[8, "checking-the-power-supply"]], "Complete Schematic": [[2, "complete-schematic"], [3, "complete-schematic"]], "Configuration Variables (CV)": [[5, null]], "Contents:": [[4, null], [7, null], [10, null]], "Control Loop & Digital Controller": [[11, "control-loop-digital-controller"]], "DCC signal decoding": [[11, "dcc-signal-decoding"]], "Debugging and Logging": [[6, null]], "Debugging via SWD": [[6, "debugging-via-swd"]], "Electrical Characteristics": [[2, "electrical-characteristics"], [3, "electrical-characteristics"]], "Electrical Characteristics & Absolute Maximum Ratings": [[2, "id2"], [3, "id2"]], "Enable logging and or debug via SWD": [[8, "enable-logging-and-or-debug-via-swd"]], "Feed-forward": [[11, "id2"]], "GPIO": [[2, "gpio"], [3, "gpio"]], "Gain Scheduling": [[11, "gain-scheduling"]], "Getting started": [[0, null]], "Hardware": [[1, null]], "Input Stage": [[2, "input-stage"], [3, "input-stage"]], "Logging": [[6, "logging"]], "Microcontroller": [[2, "microcontroller"], [3, "microcontroller"]], "Motor Driver": [[2, "motor-driver"], [3, "motor-driver"]], "Other": [[7, null]], "Overview": [[2, null], [3, null], [11, "overview"]], "PID Controller": [[11, "pid-controller"]], "RP2040-Decoder Documentation": [[4, null]], "Reset all CVs": [[5, "reset-all-cvs"]], "Revision 0.3": [[1, "revision-0-3"]], "Revision 1.0": [[1, "revision-1-0"]], "Software": [[10, null]], "Software Description": [[11, null]], "Speed step configuration": [[5, "speed-step-configuration"]], "Startup Controller": [[11, "startup-controller"]], "Troubleshooting": [[8, null]], "Wiring the Decoder": [[2, "wiring-the-decoder"], [3, "wiring-the-decoder"]], "core0.h": [[9, null]], "core1.h": [[9, "core1-h"]], "shared.h": [[9, "shared-h"]]}, "docnames": ["gs/getting_started", "hardware/index", "hardware/rev_0_3/hw_description", "hardware/rev_1_0/hw_description", "index", "other/CV_list", "other/debug_logging", "other/index", "other/troubleshooting", "software/header_files", "software/index", "software/sw_description"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["gs/getting_started.rst", "hardware/index.rst", "hardware/rev_0_3/hw_description.rst", "hardware/rev_1_0/hw_description.rst", "index.rst", "other/CV_list.rst", "other/debug_logging.rst", "other/index.rst", "other/troubleshooting.rst", "software/header_files.rst", "software/index.rst", "software/sw_description.rst"], "indexentries": {"_125m (c macro)": [[9, "c._125M", false]], "absolute_val (c++ function)": [[9, "_CPPv412absolute_vali", false]], "acknowledge (c++ function)": [[9, "_CPPv411acknowledgev", false]], "adc_calibration_iterations (c macro)": [[9, "c.ADC_CALIBRATION_ITERATIONS", false]], "adc_offset_adjustment (c++ function)": [[9, "_CPPv421adc_offset_adjustment8uint32_t", false]], "address_evaluation (c++ function)": [[9, "_CPPv418address_evaluation6size_tA_K7uint8_t", false]Line truncated
|
||||
File diff suppressed because it is too large.
Load diff
@@ -140,7 +140,7 @@
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="header_files.html#core1-h">core1.h</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv420startup_parameters_t"><code class="docutils literal notranslate"><span class="pre">startup_parameters_t</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv415pid_parameter_t"><code class="docutils literal notranslate"><span class="pre">pid_parameter_t</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv416pid_parameters_t"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv422controller_parameter_t"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv417controller_mode_t"><code class="docutils literal notranslate"><span class="pre">controller_mode_t</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N17controller_mode_t12STARTUP_MODEE"><code class="docutils literal notranslate"><span class="pre">controller_mode_t::STARTUP_MODE</span></code></a></li>
|
||||
@@ -160,32 +160,29 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N20startup_parameters_t5levelE"><code class="docutils literal notranslate"><span class="pre">startup_parameters_t::level</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_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-l2"><a class="reference internal" href="header_files.html#_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-l2"><a class="reference internal" href="header_files.html#_CPPv416pid_parameters_t"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t</span></code></a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t3k_iE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_i</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t3k_dE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_d</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t1tE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::t</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t3tauE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::tau</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t4ci_0E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::ci_0</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t4cd_0E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::cd_0</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t4cd_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::cd_1</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t11int_lim_maxE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::int_lim_max</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t11int_lim_minE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::int_lim_min</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t10max_outputE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::max_output</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t3k_pE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t1eE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::e</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t6e_prevE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::e_prev</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t6i_prevE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::i_prev</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t6d_prevE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::d_prev</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t13k_p_x_1_shiftE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_x_1_shift</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_x_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_x_1</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_x_2E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_x_2</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_y_0E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_y_0</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_y_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_y_1</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_y_2E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_y_2</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_m_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_m_1</span></code></a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_m_2E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_m_2</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t3k_iE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_i</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t3k_dE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_d</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t1tE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::t</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t3tauE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::tau</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t4ci_0E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::ci_0</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t4cd_0E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::cd_0</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t4cd_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::cd_1</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t11int_lim_maxE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::int_lim_max</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t11int_lim_minE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::int_lim_min</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t10max_outputE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::max_output</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t3k_pE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t1eE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::e</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t6e_prevE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::e_prev</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t6i_prevE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::i_prev</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t6d_prevE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::d_prev</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t13k_p_x_1_shiftE"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_x_1_shift</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_x_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_x_1</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_x_2E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_x_2</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_y_0E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_y_0</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_y_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_y_1</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_y_2E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_y_2</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_m_1E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_m_1</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N16pid_parameters_t7k_p_m_2E"><code class="docutils literal notranslate"><span class="pre">pid_parameters_t::k_p_m_2</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N22controller_parameter_t4modeE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::mode</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N22controller_parameter_t8feed_fwdE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::feed_fwd</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv4N22controller_parameter_t8setpointE"><code class="docutils literal notranslate"><span class="pre">controller_parameter_t::setpoint</span></code></a></li>
|
||||
@@ -485,13 +482,12 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv411clear_error7error_t"><code class="docutils literal notranslate"><span class="pre">clear_error()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv416clear_all_errorsv"><code class="docutils literal notranslate"><span class="pre">clear_all_errors()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv415get_error_statev"><code class="docutils literal notranslate"><span class="pre">get_error_state()</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv417pid_control_timer"><code class="docutils literal notranslate"><span class="pre">pid_control_timer</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv418speed_helper_timer"><code class="docutils literal notranslate"><span class="pre">speed_helper_timer</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv414CV_ARRAY_FLASH"><code class="docutils literal notranslate"><span class="pre">CV_ARRAY_FLASH</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv417speed_step_target"><code class="docutils literal notranslate"><span class="pre">speed_step_target</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv422speed_step_target_prev"><code class="docutils literal notranslate"><span class="pre">speed_step_target_prev</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv419cv_setup_check_done"><code class="docutils literal notranslate"><span class="pre">cv_setup_check_done</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv433flash_safe_execute_core_init_done"><code class="docutils literal notranslate"><span class="pre">flash_safe_execute_core_init_done</span></code></a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="header_files.html#_CPPv411error_state"><code class="docutils literal notranslate"><span class="pre">error_state</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="header_files.html#cv-h">CV.h</a><ul>
|
||||
|
||||
Reference in new issue
Block a user