diff --git a/sphinx/doctrees/environment.pickle b/sphinx/doctrees/environment.pickle index b0df97d..2ad2c5d 100644 Binary files a/sphinx/doctrees/environment.pickle and b/sphinx/doctrees/environment.pickle differ diff --git a/sphinx/doctrees/gs/getting_started.doctree b/sphinx/doctrees/gs/getting_started.doctree index 4d68165..1854b5c 100644 Binary files a/sphinx/doctrees/gs/getting_started.doctree and b/sphinx/doctrees/gs/getting_started.doctree differ diff --git a/sphinx/doctrees/hardware/rev_0_3/hw_description.doctree b/sphinx/doctrees/hardware/Legacy/hw_description.doctree similarity index 73% rename from sphinx/doctrees/hardware/rev_0_3/hw_description.doctree rename to sphinx/doctrees/hardware/Legacy/hw_description.doctree index f36c0bf..8bc5aa6 100644 Binary files a/sphinx/doctrees/hardware/rev_0_3/hw_description.doctree and b/sphinx/doctrees/hardware/Legacy/hw_description.doctree differ diff --git a/sphinx/doctrees/hardware/rev_1_0/hw_description.doctree b/sphinx/doctrees/hardware/USB/hw_description.doctree similarity index 75% rename from sphinx/doctrees/hardware/rev_1_0/hw_description.doctree rename to sphinx/doctrees/hardware/USB/hw_description.doctree index 8eb93b1..5c483cd 100644 Binary files a/sphinx/doctrees/hardware/rev_1_0/hw_description.doctree and b/sphinx/doctrees/hardware/USB/hw_description.doctree differ diff --git a/sphinx/doctrees/hardware/index.doctree b/sphinx/doctrees/hardware/index.doctree index 3aac801..5148422 100644 Binary files a/sphinx/doctrees/hardware/index.doctree and b/sphinx/doctrees/hardware/index.doctree differ diff --git a/sphinx/doctrees/software/sw_description.doctree b/sphinx/doctrees/software/sw_description.doctree index 0c5d486..f0e74e5 100644 Binary files a/sphinx/doctrees/software/sw_description.doctree and b/sphinx/doctrees/software/sw_description.doctree differ diff --git a/sphinx/html/_sources/gs/getting_started.rst.txt b/sphinx/html/_sources/gs/getting_started.rst.txt index b24c943..d625e75 100644 --- a/sphinx/html/_sources/gs/getting_started.rst.txt +++ b/sphinx/html/_sources/gs/getting_started.rst.txt @@ -30,7 +30,7 @@ The easiest way to do this is to just use `Visual Studio Code `_ 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 ` -| :ref:`Wiring Rev 0.3 ` +| :ref:`Wiring USB Hardware Revision ` +| :ref:`Wiring Legacy Hardware Revision ` 6. Resolving issues ---------------------------------- diff --git a/sphinx/html/_sources/hardware/rev_0_3/hw_description.rst.txt b/sphinx/html/_sources/hardware/Legacy/hw_description.rst.txt similarity index 92% rename from sphinx/html/_sources/hardware/rev_0_3/hw_description.rst.txt rename to sphinx/html/_sources/hardware/Legacy/hw_description.rst.txt index 3fc164f..4334a78 100644 --- a/sphinx/html/_sources/hardware/rev_0_3/hw_description.rst.txt +++ b/sphinx/html/_sources/hardware/Legacy/hw_description.rst.txt @@ -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 diff --git a/sphinx/html/_sources/hardware/rev_1_0/hw_description.rst.txt b/sphinx/html/_sources/hardware/USB/hw_description.rst.txt similarity index 93% rename from sphinx/html/_sources/hardware/rev_1_0/hw_description.rst.txt rename to sphinx/html/_sources/hardware/USB/hw_description.rst.txt index c92c0dd..4d1d16b 100644 --- a/sphinx/html/_sources/hardware/rev_1_0/hw_description.rst.txt +++ b/sphinx/html/_sources/hardware/USB/hw_description.rst.txt @@ -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 diff --git a/sphinx/html/_sources/hardware/index.rst.txt b/sphinx/html/_sources/hardware/index.rst.txt index 521d70b..8f84458 100644 --- a/sphinx/html/_sources/hardware/index.rst.txt +++ b/sphinx/html/_sources/hardware/index.rst.txt @@ -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 diff --git a/sphinx/html/_sources/software/sw_description.rst.txt b/sphinx/html/_sources/software/sw_description.rst.txt index 7e88fdf..e389535 100644 --- a/sphinx/html/_sources/software/sw_description.rst.txt +++ b/sphinx/html/_sources/software/sw_description.rst.txt @@ -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 diff --git a/sphinx/html/gs/getting_started.html b/sphinx/html/gs/getting_started.html index f07098c..90505d9 100644 --- a/sphinx/html/gs/getting_started.html +++ b/sphinx/html/gs/getting_started.html @@ -113,7 +113,7 @@ The

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.

@@ -148,8 +148,8 @@ The most relevant sections in the book are
Please refer to the hardware section for your board:
- - + +
diff --git a/sphinx/html/hardware/rev_0_3/hw_description.html b/sphinx/html/hardware/Legacy/hw_description.html similarity index 96% rename from sphinx/html/hardware/rev_0_3/hw_description.html rename to sphinx/html/hardware/Legacy/hw_description.html index 8d9506f..71cf28f 100644 --- a/sphinx/html/hardware/rev_0_3/hw_description.html +++ b/sphinx/html/hardware/Legacy/hw_description.html @@ -20,7 +20,7 @@ - + @@ -82,7 +82,7 @@
  • - View page source + View page source

  • @@ -254,7 +254,7 @@
    -

    Wiring the Decoder

    +

    Wiring the Decoder

    Wiring Diagram @@ -271,7 +271,7 @@ When switching inductive loads, always include a free-wheeling diode to protect
    diff --git a/sphinx/html/hardware/rev_1_0/hw_description.html b/sphinx/html/hardware/USB/hw_description.html similarity index 96% rename from sphinx/html/hardware/rev_1_0/hw_description.html rename to sphinx/html/hardware/USB/hw_description.html index faee1c5..67340eb 100644 --- a/sphinx/html/hardware/rev_1_0/hw_description.html +++ b/sphinx/html/hardware/USB/hw_description.html @@ -19,7 +19,7 @@ - + @@ -82,7 +82,7 @@
  • - View page source + View page source

  • @@ -256,7 +256,7 @@
    -

    Wiring the Decoder

    +

    Wiring the Decoder

    Wiring Diagram @@ -274,7 +274,7 @@ When switching inductive loads, always include a free-wheeling diode to protect
    @@ -122,15 +122,15 @@

    Revision 0.3

    @@ -141,7 +141,7 @@