This commit is contained in:
gab-k committed 2025-04-14 23:19:32 +00:00
1 parent 96c655ca70
commit 898b5aa298
20 files changed
+93 -93

No files matched your search

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -30,7 +30,7 @@ The easiest way to do this is to just use `Visual Studio Code <https://code.visu
The `official documentation <https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#vscode-extension>`_ of the Pi Pico does a great job of explaining this in detail.
.. note::
- Make sure to choose the correct board definition file in your CMakeLists.txt file for example ``RP2040-Decoder-board-Rev-1_0`` for Hardware Rev 1.0.
- Make sure to choose the correct board definition file in your CMakeLists.txt file ``RP2040-Decoder-board-USB`` for the USB Hardware or ``RP2040-Decoder-board-Legacy`` for the old legacy version without usb.
- In VSCode open the "Software" subdirectory for the extension to detect you project automatically.
.. _flashing_the_software:
@@ -70,8 +70,8 @@ The most relevant sections in the book are `Chapter 4.3. Debug <https://datashee
----------------------------------
| Please refer to the hardware section for your board:
| :ref:`Wiring Rev 1.0 <wiring_rev_1_0>`
| :ref:`Wiring Rev 0.3 <wiring_rev_0_3>`
| :ref:`Wiring USB Hardware Revision <wiring_USB>`
| :ref:`Wiring Legacy Hardware Revision <wiring_Legacy>`
6. Resolving issues
----------------------------------
@@ -1,7 +1,7 @@
Overview
==============================
.. figure:: ../../../../svg/hw/rev_0_3/Block_Diagram_Hardware.svg
.. figure:: ../../../../svg/hw/Legacy/Block_Diagram_Hardware.svg
:alt: Block Diagram
:align: center
@@ -51,7 +51,7 @@ Electrical Characteristics
Input Stage
==============================
.. figure:: ../../../../svg/hw/rev_0_3/Input_Stage.svg
.. figure:: ../../../../svg/hw/Legacy/Input_Stage.svg
:alt: Input Stage
:align: center
@@ -64,7 +64,7 @@ The MOSFET on the right effectively translates the rather high DCC voltage to a
Motor Driver
==============================
.. figure:: ../../../../svg/hw/rev_0_3/Motor_Driver.svg
.. figure:: ../../../../svg/hw/Legacy/Motor_Driver.svg
:alt: Motor Driver
:align: center
@@ -75,7 +75,7 @@ The Motor Driver is a special H-Bridge IC that is made for DC motors. To control
Auxiliary Outputs
==============================
.. figure:: ../../../../svg/hw/rev_0_3/Aux_Outputs.svg
.. figure:: ../../../../svg/hw/Legacy/Aux_Outputs.svg
:alt: Auxiliary Outputs
:align: center
@@ -93,7 +93,7 @@ To switch lighter loads, six GPIO soldering pads are connected to GPIO0 to GPIO5
Microcontroller
==============================
.. figure:: ../../../../svg/hw/rev_0_3/Microcontroller.svg
.. figure:: ../../../../svg/hw/Legacy/Microcontroller.svg
:alt: Microcontroller
:align: center
@@ -104,19 +104,19 @@ The Microcontroller needs a crystal oscillator for its clock. External flash mem
Complete Schematic
==============================
.. figure:: ../../../../svg/hw/rev_0_3/RP2040-Decoder.svg
.. figure:: ../../../../svg/hw/Legacy/RP2040-Decoder.svg
:alt: Complete Schematic
:align: center
Complete Schematic
.. _wiring_rev_0_3:
.. _wiring_Legacy:
Wiring the Decoder
==============================
.. figure:: ../../../../svg/hw/rev_0_3/Wiring_diagram.svg
.. figure:: ../../../../svg/hw/Legacy/Wiring_diagram.svg
:align: center
:width: 700
:alt: Wiring Diagram
@@ -1,7 +1,7 @@
Overview
==============================
.. figure:: ../../../../svg/hw/rev_1_0/Block_Diagram_Hardware.svg
.. figure:: ../../../../svg/hw/USB/Block_Diagram_Hardware.svg
:align: center
:alt: Block Diagram
@@ -55,7 +55,7 @@ Electrical Characteristics
Input Stage
==============================
.. figure:: ../../../../svg/hw/rev_1_0/Input_Stage.svg
.. figure:: ../../../../svg/hw/USB/Input_Stage.svg
:align: center
:alt: Input Stage
@@ -68,7 +68,7 @@ The MOSFET on the right effectively translates the rather high DCC voltage to a
Motor Driver
==============================
.. figure:: ../../../../svg/hw/rev_1_0/Motor_Driver.svg
.. figure:: ../../../../svg/hw/USB/Motor_Driver.svg
:align: center
:alt: Motor Driver
@@ -79,7 +79,7 @@ The Motor Driver is a special H-Bridge IC that is made for DC motors. To control
Auxiliary Outputs
==============================
.. figure:: ../../../../svg/hw/rev_1_0/Aux_Outputs.svg
.. figure:: ../../../../svg/hw/USB/Aux_Outputs.svg
:align: center
:alt: Auxiliary Outputs
@@ -95,7 +95,7 @@ To switch lighter loads, six GPIO soldering pads are connected to GPIO0 to GPIO5
Microcontroller
==============================
.. figure:: ../../../../svg/hw/rev_1_0/Microcontroller.svg
.. figure:: ../../../../svg/hw/USB/Microcontroller.svg
:align: center
:alt: Microcontroller
@@ -106,19 +106,19 @@ The Microcontroller needs a crystal oscillator for its clock. External flash mem
Complete Schematic
==============================
.. figure:: ../../../../svg/hw/rev_1_0/RP2040-Decoder.svg
.. figure:: ../../../../svg/hw/USB/RP2040-Decoder.svg
:align: center
:alt: Complete Schematic
Complete Schematic
.. _wiring_rev_1_0:
.. _wiring_USB:
Wiring the Decoder
==============================
.. figure:: ../../../../svg/hw/rev_1_0/Wiring_diagram.svg
.. figure:: ../../../../svg/hw/USB/Wiring_diagram.svg
:width: 700
:alt: Wiring Diagram
:align: center
+2 -2
View File
@@ -7,7 +7,7 @@ Revision 1.0
.. toctree::
:maxdepth: 1
rev_1_0/hw_description
USB/hw_description
Revision 0.3
------------
@@ -15,4 +15,4 @@ Revision 0.3
.. toctree::
:maxdepth: 1
rev_0_3/hw_description
Legacy/hw_description
@@ -35,7 +35,7 @@ Software files high level overview:
- Debug logging configuration (via stdio using UART/USB)
- Linked libraries
- **RP2040-Decoder-board-Rev-X_Y.h**
- **RP2040-Decoder-board-USB.h / RP2040-Decoder-board-Legacy.h**
- Flash Size
- Pin definitions
+3 -3
View File
@@ -113,7 +113,7 @@ The <a class="reference external" href="https://datasheets.raspberrypi.com/pico/
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul class="simple">
<li><p>Make sure to choose the correct board definition file in your CMakeLists.txt file for example <code class="docutils literal notranslate"><span class="pre">RP2040-Decoder-board-Rev-1_0</span></code> for Hardware Rev 1.0.</p></li>
<li><p>Make sure to choose the correct board definition file in your CMakeLists.txt file <code class="docutils literal notranslate"><span class="pre">RP2040-Decoder-board-USB</span></code> for the USB Hardware or <code class="docutils literal notranslate"><span class="pre">RP2040-Decoder-board-Legacy</span></code> for the old legacy version without usb.</p></li>
<li><p>In VSCode open the “Software” subdirectory for the extension to detect you project automatically.</p></li>
</ul>
</div>
@@ -148,8 +148,8 @@ The most relevant sections in the book are <a class="reference external" href="h
<h2>5. Wiring<a class="headerlink" href="#wiring" title="Link to this heading"></a></h2>
<div class="line-block">
<div class="line">Please refer to the hardware section for your board:</div>
<div class="line"><a class="reference internal" href="../hardware/rev_1_0/hw_description.html#wiring-rev-1-0"><span class="std std-ref">Wiring Rev 1.0</span></a></div>
<div class="line"><a class="reference internal" href="../hardware/rev_0_3/hw_description.html#wiring-rev-0-3"><span class="std std-ref">Wiring Rev 0.3</span></a></div>
<div class="line"><a class="reference internal" href="../hardware/USB/hw_description.html#wiring-usb"><span class="std std-ref">Wiring USB Hardware Revision</span></a></div>
<div class="line"><a class="reference internal" href="../hardware/Legacy/hw_description.html#wiring-legacy"><span class="std std-ref">Wiring Legacy Hardware Revision</span></a></div>
</div>
</section>
<section id="resolving-issues">
@@ -20,7 +20,7 @@
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Software" href="../../software/index.html" />
<link rel="prev" title="Overview" href="../rev_1_0/hw_description.html" />
<link rel="prev" title="Overview" href="../USB/hw_description.html" />
</head>
<body class="wy-body-for-nav">
@@ -82,7 +82,7 @@
<li class="breadcrumb-item"><a href="../index.html">Hardware</a></li>
<li class="breadcrumb-item active">Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/hardware/rev_0_3/hw_description.rst.txt" rel="nofollow"> View page source</a>
<a href="../../_sources/hardware/Legacy/hw_description.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
@@ -254,7 +254,7 @@
</figure>
</section>
<section id="wiring-the-decoder">
<span id="wiring-rev-0-3"></span><h1>Wiring the Decoder<a class="headerlink" href="#wiring-the-decoder" title="Link to this heading"></a></h1>
<span id="wiring-legacy"></span><h1>Wiring the Decoder<a class="headerlink" href="#wiring-the-decoder" title="Link to this heading"></a></h1>
<figure class="align-center" id="id8">
<a class="reference internal image-reference" href="../../_images/Wiring_diagram.svg"><img alt="Wiring Diagram" src="../../_images/Wiring_diagram.svg" style="width: 700px;" />
</a>
@@ -271,7 +271,7 @@ When switching inductive loads, always include a free-wheeling diode to protect
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../rev_1_0/hw_description.html" class="btn btn-neutral float-left" title="Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../USB/hw_description.html" class="btn btn-neutral float-left" title="Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../../software/index.html" class="btn btn-neutral float-right" title="Software" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
@@ -19,7 +19,7 @@
<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="Overview" href="../rev_0_3/hw_description.html" />
<link rel="next" title="Overview" href="../Legacy/hw_description.html" />
<link rel="prev" title="Hardware" href="../index.html" />
</head>
@@ -82,7 +82,7 @@
<li class="breadcrumb-item"><a href="../index.html">Hardware</a></li>
<li class="breadcrumb-item active">Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/hardware/rev_1_0/hw_description.rst.txt" rel="nofollow"> View page source</a>
<a href="../../_sources/hardware/USB/hw_description.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
@@ -256,7 +256,7 @@
</figure>
</section>
<section id="wiring-the-decoder">
<span id="wiring-rev-1-0"></span><h1>Wiring the Decoder<a class="headerlink" href="#wiring-the-decoder" title="Link to this heading"></a></h1>
<span id="wiring-usb"></span><h1>Wiring the Decoder<a class="headerlink" href="#wiring-the-decoder" title="Link to this heading"></a></h1>
<figure class="align-center" id="id8">
<a class="reference internal image-reference" href="../../_images/Wiring_diagram1.svg"><img alt="Wiring Diagram" src="../../_images/Wiring_diagram1.svg" style="width: 700px;" />
</a>
@@ -274,7 +274,7 @@ When switching inductive loads, always include a free-wheeling diode to protect
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../index.html" class="btn btn-neutral float-left" title="Hardware" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../rev_0_3/hw_description.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../Legacy/hw_description.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
+38 -38
View File
@@ -19,7 +19,7 @@
<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="Overview" href="rev_1_0/hw_description.html" />
<link rel="next" title="Overview" href="USB/hw_description.html" />
<link rel="prev" title="Getting started" href="../gs/getting_started.html" />
</head>
@@ -47,27 +47,27 @@
<li class="toctree-l1"><a class="reference internal" href="../gs/getting_started.html">Getting started</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Hardware</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#revision-1-0">Revision 1.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rev_1_0/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_1_0/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_1_0/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_1_0/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_1_0/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_1_0/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_1_0/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_1_0/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_1_0/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l3"><a class="reference internal" href="USB/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#revision-0-3">Revision 0.3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rev_0_3/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_0_3/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_0_3/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_0_3/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_0_3/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_0_3/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_0_3/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_0_3/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l3"><a class="reference internal" href="rev_0_3/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l3"><a class="reference internal" href="Legacy/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
</ul>
</li>
</ul>
@@ -106,15 +106,15 @@
<h2>Revision 1.0<a class="headerlink" href="#revision-1-0" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="rev_1_0/hw_description.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_1_0/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_1_0/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_1_0/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_1_0/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_1_0/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_1_0/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_1_0/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_1_0/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
<li class="toctree-l1"><a class="reference internal" href="USB/hw_description.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="USB/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l1"><a class="reference internal" href="USB/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l1"><a class="reference internal" href="USB/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l1"><a class="reference internal" href="USB/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l1"><a class="reference internal" href="USB/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l1"><a class="reference internal" href="USB/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l1"><a class="reference internal" href="USB/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l1"><a class="reference internal" href="USB/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
</ul>
</div>
</section>
@@ -122,15 +122,15 @@
<h2>Revision 0.3<a class="headerlink" href="#revision-0-3" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="rev_0_3/hw_description.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_0_3/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_0_3/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_0_3/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_0_3/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_0_3/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_0_3/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_0_3/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l1"><a class="reference internal" href="rev_0_3/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
<li class="toctree-l1"><a class="reference internal" href="Legacy/hw_description.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Legacy/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l1"><a class="reference internal" href="Legacy/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Legacy/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l1"><a class="reference internal" href="Legacy/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l1"><a class="reference internal" href="Legacy/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l1"><a class="reference internal" href="Legacy/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l1"><a class="reference internal" href="Legacy/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l1"><a class="reference internal" href="Legacy/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
</ul>
</div>
</section>
@@ -141,7 +141,7 @@
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../gs/getting_started.html" class="btn btn-neutral float-left" title="Getting started" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="rev_1_0/hw_description.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="USB/hw_description.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
+18 -18
View File
@@ -93,27 +93,27 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="hardware/index.html">Hardware</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hardware/index.html#revision-1-0">Revision 1.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_1_0/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_1_0/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_1_0/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_1_0/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_1_0/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_1_0/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_1_0/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_1_0/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_1_0/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/USB/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="hardware/index.html#revision-0-3">Revision 0.3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_0_3/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_0_3/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_0_3/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_0_3/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_0_3/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_0_3/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_0_3/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_0_3/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/rev_0_3/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html#electrical-characteristics">Electrical Characteristics</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html#input-stage">Input Stage</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html#motor-driver">Motor Driver</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html#auxiliary-outputs">Auxiliary Outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html#gpio">GPIO</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html#microcontroller">Microcontroller</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html#complete-schematic">Complete Schematic</a></li>
<li class="toctree-l3"><a class="reference internal" href="hardware/Legacy/hw_description.html#wiring-the-decoder">Wiring the Decoder</a></li>
</ul>
</li>
</ul>
Binary file not shown.
+1 -1
View File
@@ -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":65,"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]],"adjust_pwm_level (c++ function)":[[9,"_CPPv416adjust_pwm_level8uint16_t",false]],"base_pwm_arr_len (c macro)":[[9,"c.BASE_PWM_ARR_LEN",false]],"bits_to_dcc_packet_data (c++ function)":[[9,"_CPPv423bits_to_dcc_packet_dataP12dcc_packet_t",false]],"call_flash_do_cmd (c++ function)":[[9,"_CPPv41Line 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":[[1,"auxiliary-outputs"],[2,"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":[[1,"complete-schematic"],[2,"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":[[1,"electrical-characteristics"],[2,"electrical-characteristics"]],"Electrical Characteristics & Absolute Maximum Ratings":[[1,"id2"],[2,"id2"]],"Enable logging and or debug via SWD":[[8,"enable-logging-and-or-debug-via-swd"]],"Feed-forward":[[11,"id2"]],"GPIO":[[1,"gpio"],[2,"gpio"]],"Gain Scheduling":[[11,"gain-scheduling"]],"Getting started":[[0,null]],"Hardware":[[3,null]],"Input Stage":[[1,"input-stage"],[2,"input-stage"]],"Logging":[[6,"logging"]],"Microcontroller":[[1,"microcontroller"],[2,"microcontroller"]],"Motor Driver":[[1,"motor-driver"],[2,"motor-driver"]],"Other":[[7,null]],"Overview":[[1,null],[2,null],[11,"overview"]],"PID Controller":[[11,"pid-controller"]],"RP2040-Decoder Documentation":[[4,null]],"Reset all CVs":[[5,"reset-all-cvs"]],"Revision 0.3":[[3,"revision-0-3"]],"Revision 1.0":[[3,"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":[[1,"wiring-the-decoder"],[2,"wiring-the-decoder"]],"core0.h":[[9,null]],"core1.h":[[9,"core1-h"]],"shared.h":[[9,"shared-h"]]},"docnames":["gs/getting_started","hardware/Legacy/hw_description","hardware/USB/hw_description","hardware/index","index","other/CV_list","other/debug_logging","other/index","other/troubleshooting","software/header_files","software/index","software/sw_description"],"envversion":{"sphinx":65,"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/Legacy/hw_description.rst","hardware/USB/hw_description.rst","hardware/index.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]],"adjust_pwm_level (c++ function)":[[9,"_CPPv416adjust_pwm_level8uint16_t",false]],"base_pwm_arr_len (c macro)":[[9,"c.BASE_PWM_ARR_LEN",false]],"bits_to_dcc_packet_data (c++ function)":[[9,"_CPPv423bits_to_dcc_packet_dataP12dcc_packet_t",false]],"call_flash_do_cmd (c++ function)":[[9,"_CPPv417call_flasLine truncated
+2 -2
View File
@@ -20,7 +20,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Software Description" href="sw_description.html" />
<link rel="prev" title="Overview" href="../hardware/rev_0_3/hw_description.html" />
<link rel="prev" title="Overview" href="../hardware/Legacy/hw_description.html" />
</head>
<body class="wy-body-for-nav">
@@ -519,7 +519,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../hardware/rev_0_3/hw_description.html" class="btn btn-neutral float-left" title="Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../hardware/Legacy/hw_description.html" class="btn btn-neutral float-left" title="Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="sw_description.html" class="btn btn-neutral float-right" title="Software Description" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
+1 -1
View File
@@ -143,7 +143,7 @@
</ul>
</div></blockquote>
</li>
<li><p><strong>RP2040-Decoder-board-Rev-X_Y.h</strong></p>
<li><p><strong>RP2040-Decoder-board-USB.h / RP2040-Decoder-board-Legacy.h</strong></p>
<blockquote>
<div><ul>
<li><p>Flash Size</p></li>