Rename Rev_1_0 to USB HW Rev and Rev_0_3 to Legacy HW Rev in workflows and documentation also rename corresponding folders
This commit is contained in:
1 parent
18c5c5837a
commit
e091fc96d3
28 files changed
+139
-139
No files matched your search
@@ -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
|
||||
----------------------------------
|
||||
|
||||
+8
-8
@@ -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
|
||||
+8
-8
@@ -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
|
||||
@@ -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
|
||||
|
||||
Reference in new issue
Block a user