deploy: 21bee73f01
This commit is contained in:
1 parent
d50626fe42
commit
f0faeed754
8 files changed
+17
-7
No files matched your search
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -30,7 +30,7 @@ Note: If you are building for Hardware Rev 0.3 or below change the board definti
|
|||||||
|
|
||||||
For RP2040-Decoders with USB there is two ways of flashing the software:
|
For RP2040-Decoders with USB there is two ways of flashing the software:
|
||||||
|
|
||||||
1. Flasing via USB using the .uf2 file by copying it with your preferred file explorer.
|
1. Flashing via USB using the .uf2 file by copying it with your preferred file explorer.
|
||||||
2. Using Serial Wire Debug (SWD)
|
2. Using Serial Wire Debug (SWD)
|
||||||
|
|
||||||
2.1. Using another RP2040/RP2350-based board with `debugprobe software <https://github.com/raspberrypi/debugprobe>`_ on it. (Could be the RP2040-Decoder itself)
|
2.1. Using another RP2040/RP2350-based board with `debugprobe software <https://github.com/raspberrypi/debugprobe>`_ on it. (Could be the RP2040-Decoder itself)
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ Software files high level overview:
|
|||||||
- Debug logging configuration (via stdio using UART/USB)
|
- Debug logging configuration (via stdio using UART/USB)
|
||||||
- Linked libraries
|
- Linked libraries
|
||||||
|
|
||||||
- **RP2040-Decoder-board.h or RP2040-Decoder-board-legacy.h**
|
- **RP2040-Decoder-board-Rev-X_Y.h**
|
||||||
|
|
||||||
- Flash Size
|
- Flash Size
|
||||||
- Pin definitions
|
- Pin definitions
|
||||||
|
|||||||
@@ -109,7 +109,7 @@ The <a class="reference external" href="https://datasheets.raspberrypi.com/pico/
|
|||||||
<h2>4. Flashing the software<a class="headerlink" href="#flashing-the-software" title="Link to this heading"></a></h2>
|
<h2>4. Flashing the software<a class="headerlink" href="#flashing-the-software" title="Link to this heading"></a></h2>
|
||||||
<p>For RP2040-Decoders with USB there is two ways of flashing the software:</p>
|
<p>For RP2040-Decoders with USB there is two ways of flashing the software:</p>
|
||||||
<ol class="arabic">
|
<ol class="arabic">
|
||||||
<li><p>Flasing via USB using the .uf2 file by copying it with your preferred file explorer.</p></li>
|
<li><p>Flashing via USB using the .uf2 file by copying it with your preferred file explorer.</p></li>
|
||||||
<li><p>Using Serial Wire Debug (SWD)</p>
|
<li><p>Using Serial Wire Debug (SWD)</p>
|
||||||
<p>2.1. Using another RP2040/RP2350-based board with <a class="reference external" href="https://github.com/raspberrypi/debugprobe">debugprobe software</a> on it. (Could be the RP2040-Decoder itself)</p>
|
<p>2.1. Using another RP2040/RP2350-based board with <a class="reference external" href="https://github.com/raspberrypi/debugprobe">debugprobe software</a> on it. (Could be the RP2040-Decoder itself)</p>
|
||||||
<p>2.2. Using any other supported SWD debug interface</p>
|
<p>2.2. Using any other supported SWD debug interface</p>
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
Search.setIndex({"alltitles": {"1. Where to get the board?": [[4, "where-to-get-the-board"]], "2. Production files?": [[4, "production-files"]], "3. Building the software": [[4, "building-the-software"]], "4. Flashing the software": [[4, "flashing-the-software"]], "4.1. Flashing the software via .uf2 file": [[4, "flashing-the-software-via-uf2-file"]], "4.2. Flashing the software via SWD": [[4, "flashing-the-software-via-swd"]], "5. Wiring": [[4, "wiring"]], "6. Resolving issues": [[4, "resolving-issues"]], "Auxiliary Outputs": [[1, "auxiliary-outputs"], [2, "auxiliary-outputs"]], "BOM & Alternative Parts": [[1, "bom-alternative-parts"], [2, "bom-alternative-parts"]], "Back-EMF voltage measurement": [[8, "back-emf-voltage-measurement"]], "CV.h": [[6, "cv-h"]], "Complete Schematic": [[1, "complete-schematic"], [2, "complete-schematic"]], "Contents:": [[3, null], [7, null]], "Control Loop & Digital Controller": [[8, "control-loop-digital-controller"]], "DCC signal decoding": [[8, "dcc-signal-decoding"]], "Electrical Characteristics": [[1, "electrical-characteristics"], [2, "electrical-characteristics"]], "Electrical Characteristics & Absolute Maximum Ratings": [[1, "id2"], [2, "id2"]], "Feed-forward": [[8, "id2"]], "GPIO": [[1, "gpio"], [2, "gpio"]], "Gain Scheduling": [[8, "gain-scheduling"]], "Getting started": [[4, null]], "Hardware": [[0, null]], "Input Stage": [[1, "input-stage"], [2, "input-stage"]], "Microcontroller": [[1, "microcontroller"], [2, "microcontroller"]], "Motor Driver": [[1, "motor-driver"], [2, "motor-driver"]], "Other": [[5, null]], "Overview": [[1, null], [2, null], [8, "overview"]], "PID Controller": [[8, "pid-controller"]], "RP2040-Decoder Documentation": [[3, null]], "Revision 0.3": [[0, "revision-0-3"]], "Revision 1.0": [[0, "revision-1-0"]], "Software": [[7, null]], "Software Description": [[8, null]], "Startup Controller": [[8, "startup-controller"]], "Wiring the Decoder": [[1, "wiring-the-decoder"], [2, "wiring-the-decoder"]], "core0.h": [[6, null]], "core1.h": [[6, "core1-h"]], "shared.h": [[6, "shared-h"]]}, "docnames": ["hardware/index", "hardware/rev_0_3/hw_description", "hardware/rev_1_0/hw_description", "index", "other/getting_started", "other/index", "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": ["hardware/index.rst", "hardware/rev_0_3/hw_description.rst", "hardware/rev_1_0/hw_description.rst", "index.rst", "other/getting_started.rst", "other/index.rst", "software/header_files.rst", "software/index.rst", "software/sw_description.rst"], "indexentries": {"_125m (c macro)": [[6, "c._125M", false]], "absolute_val (c++ function)": [[6, "_CPPv412absolute_vali", false]], "acknowledge (c++ function)": [[6, "_CPPv411acknowledgev", false]], "adc_calibration_iterations (c macro)": [[6, "c.ADC_CALIBRATION_ITERATIONS", false]], "adc_offset_adjustment (c++ function)": [[6, "_CPPv421adc_offset_adjustment8uint32_t", false]], "address_evaluation (c++ function)": [[6, "_CPPv418address_evaluation6size_tA_K7uint8_t", false]], "adjust_pwm_level (c++ function)": [[6, "_CPPv416adjust_pwm_level8uint16_t", false]], "base_pwm_arr_len (c macro)": [[6, "c.BASE_PWM_ARR_LEN", false]], "bits_to_dcc_packet_data (c++ function)": [[6, "_CPPv423bits_to_dcc_packet_dataP12dcc_packet_t", false]], "call_flash_do_cmd (c++ function)": [[6, "_CPPv417call_flash_do_cmdPv", false]], "call_flash_range_erase (c++ function)": [[6, "_CPPv422call_flash_range_erasePv", false]], "call_flash_range_program (c++ function)": [[6, "_CPPv424call_flash_range_programPv", false]], "clear_all_errors (c++ function)": [[6, "_CPPv416clear_all_errorsv", false]], "clear_error (c++ function)": [[6, "_CPPv411clear_error7error_t", false]], "clr_bit_arr (c++ member)": [[6, "_CPPv411clr_bit_arr", false]], "controller_general (c++ function)": [[6, "_CPPv418controller_generalP22controller_parameter_t", false]], "controller_mode_t (c++ enum)": [[6, "_CPPv417controller_mode_t", false]], "controller_mode_t::pid_mode (c++ enumerator)": [[6, "_CPPv4N17controller_mode_t8PID_MODEE", false]], "controller_mode_t::startup_mode (c++ enumerator)": [[6, "_CPPv4N17controller_mode_t12STARTUP_MODEE", false]], "controller_parameter_t (c++ struct)": [[6, "_CPPv422controller_parameter_t", false]], "controller_parameter_t (c++ type)": [[6, "_CPPv422controller_parameter_t", false]], "controller_parameter_t::adc_offset (c++ member)": [[6, "_CPPv4N22controller_parameter_t10adc_offsetE", false]], "controller_parameter_t::feed_fwd (c++ member)": [[6, "_CPPv4N22controller_parameter_t8feed_fwdE", false]], "controller_parameter_t::l_side_arr_cutoff (c++ member)": [[6, "_CPPv4N22controller_parameter_t17l_side_arr_cutoffE", false]], "controlLine truncated
|
Search.setIndex({"alltitles": {"1. Where to get the board?": [[4, "where-to-get-the-board"]], "2. Production files?": [[4, "production-files"]], "3. Building the software": [[4, "building-the-software"]], "4. Flashing the software": [[4, "flashing-the-software"]], "4.1. Flashing the software via .uf2 file": [[4, "flashing-the-software-via-uf2-file"]], "4.2. Flashing the software via SWD": [[4, "flashing-the-software-via-swd"]], "5. Wiring": [[4, "wiring"]], "6. Resolving issues": [[4, "resolving-issues"]], "Auxiliary Outputs": [[1, "auxiliary-outputs"], [2, "auxiliary-outputs"]], "BOM & Alternative Parts": [[1, "bom-alternative-parts"], [2, "bom-alternative-parts"]], "Back-EMF voltage measurement": [[8, "back-emf-voltage-measurement"]], "CV.h": [[6, "cv-h"]], "Complete Schematic": [[1, "complete-schematic"], [2, "complete-schematic"]], "Contents:": [[3, null], [7, null]], "Control Loop & Digital Controller": [[8, "control-loop-digital-controller"]], "DCC signal decoding": [[8, "dcc-signal-decoding"]], "Electrical Characteristics": [[1, "electrical-characteristics"], [2, "electrical-characteristics"]], "Electrical Characteristics & Absolute Maximum Ratings": [[1, "id2"], [2, "id2"]], "Feed-forward": [[8, "id2"]], "GPIO": [[1, "gpio"], [2, "gpio"]], "Gain Scheduling": [[8, "gain-scheduling"]], "Getting started": [[4, null]], "Hardware": [[0, null]], "Input Stage": [[1, "input-stage"], [2, "input-stage"]], "Microcontroller": [[1, "microcontroller"], [2, "microcontroller"]], "Motor Driver": [[1, "motor-driver"], [2, "motor-driver"]], "Other": [[5, null]], "Overview": [[1, null], [2, null], [8, "overview"]], "PID Controller": [[8, "pid-controller"]], "RP2040-Decoder Documentation": [[3, null]], "Revision 0.3": [[0, "revision-0-3"]], "Revision 1.0": [[0, "revision-1-0"]], "Software": [[7, null]], "Software Description": [[8, null]], "Startup Controller": [[8, "startup-controller"]], "Wiring the Decoder": [[1, "wiring-the-decoder"], [2, "wiring-the-decoder"]], "core0.h": [[6, null]], "core1.h": [[6, "core1-h"]], "shared.h": [[6, "shared-h"]]}, "docnames": ["hardware/index", "hardware/rev_0_3/hw_description", "hardware/rev_1_0/hw_description", "index", "other/getting_started", "other/index", "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": ["hardware/index.rst", "hardware/rev_0_3/hw_description.rst", "hardware/rev_1_0/hw_description.rst", "index.rst", "other/getting_started.rst", "other/index.rst", "software/header_files.rst", "software/index.rst", "software/sw_description.rst"], "indexentries": {"_125m (c macro)": [[6, "c._125M", false]], "absolute_val (c++ function)": [[6, "_CPPv412absolute_vali", false]], "acknowledge (c++ function)": [[6, "_CPPv411acknowledgev", false]], "adc_calibration_iterations (c macro)": [[6, "c.ADC_CALIBRATION_ITERATIONS", false]], "adc_offset_adjustment (c++ function)": [[6, "_CPPv421adc_offset_adjustment8uint32_t", false]], "address_evaluation (c++ function)": [[6, "_CPPv418address_evaluation6size_tA_K7uint8_t", false]], "adjust_pwm_level (c++ function)": [[6, "_CPPv416adjust_pwm_level8uint16_t", false]], "base_pwm_arr_len (c macro)": [[6, "c.BASE_PWM_ARR_LEN", false]], "bits_to_dcc_packet_data (c++ function)": [[6, "_CPPv423bits_to_dcc_packet_dataP12dcc_packet_t", false]], "call_flash_do_cmd (c++ function)": [[6, "_CPPv417call_flash_do_cmdPv", false]], "call_flash_range_erase (c++ function)": [[6, "_CPPv422call_flash_range_erasePv", false]], "call_flash_range_program (c++ function)": [[6, "_CPPv424call_flash_range_programPv", false]], "clear_all_errors (c++ function)": [[6, "_CPPv416clear_all_errorsv", false]], "clear_error (c++ function)": [[6, "_CPPv411clear_error7error_t", false]], "clr_bit_arr (c++ member)": [[6, "_CPPv411clr_bit_arr", false]], "controller_general (c++ function)": [[6, "_CPPv418controller_generalP22controller_parameter_t", false]], "controller_mode_t (c++ enum)": [[6, "_CPPv417controller_mode_t", false]], "controller_mode_t::pid_mode (c++ enumerator)": [[6, "_CPPv4N17controller_mode_t8PID_MODEE", false]], "controller_mode_t::startup_mode (c++ enumerator)": [[6, "_CPPv4N17controller_mode_t12STARTUP_MODEE", false]], "controller_parameter_t (c++ struct)": [[6, "_CPPv422controller_parameter_t", false]], "controller_parameter_t (c++ type)": [[6, "_CPPv422controller_parameter_t", false]], "controller_parameter_t::adc_offset (c++ member)": [[6, "_CPPv4N22controller_parameter_t10adc_offsetE", false]], "controller_parameter_t::feed_fwd (c++ member)": [[6, "_CPPv4N22controller_parameter_t8feed_fwdE", false]], "controller_parameter_t::l_side_arr_cutoff (c++ member)": [[6, "_CPPv4N22controller_parameter_t17l_side_arr_cutoffE", false]], "controlLine truncated
|
||||||
@@ -118,11 +118,21 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</div></blockquote>
|
</div></blockquote>
|
||||||
</li>
|
</li>
|
||||||
<li><p><strong>shared.c / shared.h</strong> (used by both cores)</p></li>
|
<li><p><strong>shared.c / shared.h</strong> (used by both cores)</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><ul class="simple">
|
||||||
<li><p>Error handling</p></li>
|
<li><p>Error handling</p></li>
|
||||||
<li><p>Helper functions for retrieving CV’s</p></li>
|
<li><p>Helper functions for retrieving CV’s</p></li>
|
||||||
<li><p><strong>CV.h</strong></p></li>
|
</ul>
|
||||||
|
</div></blockquote>
|
||||||
|
</li>
|
||||||
|
<li><p><strong>CV.h</strong></p>
|
||||||
|
<blockquote>
|
||||||
|
<div><ul class="simple">
|
||||||
<li><p>Default configuration variables</p></li>
|
<li><p>Default configuration variables</p></li>
|
||||||
|
</ul>
|
||||||
|
</div></blockquote>
|
||||||
|
</li>
|
||||||
<li><p><strong>CMakeLists.txt</strong></p>
|
<li><p><strong>CMakeLists.txt</strong></p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<div><ul class="simple">
|
<div><ul class="simple">
|
||||||
@@ -135,7 +145,7 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</div></blockquote>
|
</div></blockquote>
|
||||||
</li>
|
</li>
|
||||||
<li><p><strong>RP2040-Decoder-board.h or RP2040-Decoder-board-legacy.h</strong></p>
|
<li><p><strong>RP2040-Decoder-board-Rev-X_Y.h</strong></p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<div><ul>
|
<div><ul>
|
||||||
<li><p>Flash Size</p></li>
|
<li><p>Flash Size</p></li>
|
||||||
|
|||||||
Reference in new issue
Block a user