diff --git a/.github/workflows/build_sw.yml b/.github/workflows/build_sw.yml index 00213e6..aa4d902 100644 --- a/.github/workflows/build_sw.yml +++ b/.github/workflows/build_sw.yml @@ -29,14 +29,14 @@ jobs: - name: Init submodules to get tinyUSB stack run: ls && cd pico-sdk && git submodule update --init && cd .. - - name: Configure and run CMake for Hardware Rev 0.3 - run: cmake -B ${{github.workspace}}/Software/build-Rev-0_3 -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Rev-0_3 + - name: Configure and run CMake for Legacy Hardware Revision + run: cmake -B ${{github.workspace}}/Software/build-Legacy -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Legacy - - name: Build for Hardware Rev 0.3 - run: cmake --build ${{github.workspace}}/Software/build-Rev-0_3 --config ${{env.BUILD_TYPE}} + - name: Build for Legacy Hardware Revision + run: cmake --build ${{github.workspace}}/Software/build-Legacy --config ${{env.BUILD_TYPE}} - - name: Configure and run CMake for Hardware Rev 1.0 - run: cmake -B ${{github.workspace}}/Software/build-Rev-1_0 -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Rev-1_0 + - name: Configure and run CMake for USB Hardware Revision + run: cmake -B ${{github.workspace}}/Software/build-USB -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-USB - - name: Build for Hardware Rev 1.0 - run: cmake --build ${{github.workspace}}/Software/build-Rev-1_0 --config ${{env.BUILD_TYPE}} \ No newline at end of file + - name: Build for USB Hardware Revision + run: cmake --build ${{github.workspace}}/Software/build-USB --config ${{env.BUILD_TYPE}} \ No newline at end of file diff --git a/.github/workflows/pcb_render.yml b/.github/workflows/pcb_render.yml index 30b3793..1f8c8bc 100644 --- a/.github/workflows/pcb_render.yml +++ b/.github/workflows/pcb_render.yml @@ -16,31 +16,31 @@ jobs: - name: Check out the repo uses: actions/checkout@v4 - - name: Render PCB image and .mp4 (Rev 1.0) + - name: Render PCB image and .mp4 (USB Hardware Revision) uses: linalinn/kicad-render@main with: - pcb_file: KiCad/Rev_1_0/RP2040-Decoder.kicad_pcb - output_path: ${{ github.workspace }}/images_rev_1_0 + pcb_file: KiCad/USB/RP2040-Decoder.kicad_pcb + output_path: ${{ github.workspace }}/images_USB animation: mp4 - - name: Render PCB image and .mp4 (Rev 0.3) + - name: Render PCB image and .mp4 (Legacy Hardware Revision) uses: linalinn/kicad-render@main with: - pcb_file: KiCad/Rev_0_3/RP2040-Decoder.kicad_pcb - output_path: ${{ github.workspace }}/images_rev_0_3 + pcb_file: KiCad/Legacy/RP2040-Decoder.kicad_pcb + output_path: ${{ github.workspace }}/images_Legacy animation: mp4 - - name: Upload images and mp4 as artifact (Rev 1.0) + - name: Upload images and mp4 as artifact (USB Hardware Revision) uses: actions/upload-artifact@v4 with: - name: pcb-images_rev_1_0 - path: images_rev_1_0/ + name: pcb-images_USB + path: images_USB/ - - name: Upload images and mp4 as artifact (Rev 0.3) + - name: Upload images and mp4 as artifact (Legacy Hardware Revision) uses: actions/upload-artifact@v4 with: - name: pcb-images_rev_0_3 - path: images_rev_0_3/ + name: pcb-images_Legacy + path: images_Legacy/ deploy-pages-main: if: github.ref == 'refs/heads/main' # Only deploy on 'main' branch @@ -48,33 +48,33 @@ jobs: needs: render-images steps: - - name: Download pcb-images_rev_1_0 artifact + - name: Download pcb-images_USB artifact uses: actions/download-artifact@v4 with: - name: pcb-images_rev_1_0 - path: images_rev_1_0/ + name: pcb-images_USB + path: images_USB/ - - name: Download pcb-images_rev_0_3 artifact + - name: Download pcb-images_Legacy artifact uses: actions/download-artifact@v4 with: - name: pcb-images_rev_0_3 - path: images_rev_0_3/ + name: pcb-images_Legacy + path: images_Legacy/ - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./images_rev_1_0 + publish_dir: ./images_USB publish_branch: gh-pages # Specify the target branch (gh-pages in this case) - destination_dir: img_rev_1_0 + destination_dir: img_USB - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./images_rev_0_3 + publish_dir: ./images_Legacy publish_branch: gh-pages # Specify the target branch (gh-pages in this case) - destination_dir: img_rev_0_3 + destination_dir: img_Legacy deploy-pages-dev: if: github.ref == 'refs/heads/dev' # Only deploy on 'dev' branch @@ -82,30 +82,30 @@ jobs: needs: render-images steps: - - name: Download pcb-images_rev_1_0 artifact + - name: Download pcb-images_USB artifact uses: actions/download-artifact@v4 with: - name: pcb-images_rev_1_0 - path: images_rev_1_0/ + name: pcb-images_USB + path: images_USB/ - - name: Download pcb-images_rev_0_3 artifact + - name: Download pcb-images_Legacy artifact uses: actions/download-artifact@v4 with: - name: pcb-images_rev_0_3 - path: images_rev_0_3/ + name: pcb-images_Legacy + path: images_Legacy/ - - name: Deploy Rev 1.0 + - name: Deploy USB Hardware Revision uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./images_rev_1_0 + publish_dir: ./images_USB publish_branch: gh-pages-dev # Specify the target branch (gh-pages-dev in this case) - destination_dir: img_rev_1_0 + destination_dir: img_USB - - name: Deploy Rev 0.3 + - name: Deploy Legacy Hardware Revision uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./images_rev_0_3 + publish_dir: ./images_Legacy publish_branch: gh-pages-dev # Specify the target branch (gh-pages-dev in this case) - destination_dir: img_rev_0_3 \ No newline at end of file + destination_dir: img_Legacy \ No newline at end of file diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml index 5ae4b02..f14859a 100644 --- a/.github/workflows/prerelease.yml +++ b/.github/workflows/prerelease.yml @@ -24,35 +24,35 @@ jobs: - name: Init submodules to get tinyUSB stack run: ls && cd pico-sdk && git submodule update --init && cd .. - - name: Configure and run CMake for Hardware Rev 0.3 + - name: Configure and run CMake for Legacy Hardware Revision # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make. # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type - run: cmake -B ${{github.workspace}}/Software/build-Rev-0_3 -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Rev-0_3 + run: cmake -B ${{github.workspace}}/Software/build-Legacy -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Legacy - - name: Build for Hardware Rev 0.3 + - name: Build for Legacy Hardware Revision # Build your program with the given configuration - run: cmake --build ${{github.workspace}}/Software/build-Rev-0_3 --config ${{env.BUILD_TYPE}} + run: cmake --build ${{github.workspace}}/Software/build-Legacy --config ${{env.BUILD_TYPE}} - - name: Configure and run CMake for Hardware Rev 1.0 + - name: Configure and run CMake for USB Hardware Revision # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make. # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type - run: cmake -B ${{github.workspace}}/Software/build-Rev-1_0 -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Rev-1_0 + run: cmake -B ${{github.workspace}}/Software/build-USB -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-USB - - name: Build for Hardware Rev 1.0 + - name: Build for Hardware for USB Hardware Revision # Build your program with the given configuration - run: cmake --build ${{github.workspace}}/Software/build-Rev-1_0 --config ${{env.BUILD_TYPE}} + run: cmake --build ${{github.workspace}}/Software/build-USB --config ${{env.BUILD_TYPE}} - - name: Upload build files as artifact Rev 0.3 + - name: Upload build files as artifact for Legacy Hardware Revision uses: actions/upload-artifact@v4 with: - name: build_files_Rev-0_3 - path: ${{github.workspace}}/Software/build-Rev-0_3 + name: build_files_Legacy + path: ${{github.workspace}}/Software/build-Legacy - - name: Upload build files as artifact Rev 1.0 + - name: Upload build files as artifact for USB Hardware Revision uses: actions/upload-artifact@v4 with: - name: build_files_Rev-1_0 - path: ${{github.workspace}}/Software/build-Rev-1_0 + name: build_files_USB + path: ${{github.workspace}}/Software/build-USB generate-fabrication-files: runs-on: ubuntu-latest @@ -74,14 +74,14 @@ jobs: - name: Run fab toolkit CLI run: | cd Fabrication-Toolkit - python3 -m plugins.cli -p ../KiCad/Rev_1_0/RP2040-Decoder.kicad_pcb --autoTranslate --autoFill + python3 -m plugins.cli -p ../KiCad/USB/RP2040-Decoder.kicad_pcb --autoTranslate --autoFill cd .. - name: Upload Artifact uses: actions/upload-artifact@v4 with: - name: fab_outputs_rev_1_0 - path: ./KiCad/Rev_1_0/production + name: fab_outputs_USB + path: ./KiCad/USB/production prerelease: runs-on: ubuntu-latest @@ -93,32 +93,32 @@ jobs: - name: Download fabrication outputs artifact uses: actions/download-artifact@v4 with: - name: fab_outputs_rev_1_0 - path: fab_outputs_rev_1_0 + name: fab_outputs_USB + path: fab_outputs_USB - - name: Download build files artifact for Rev 0.3 + - name: Download build files artifact for Legacy Hardware Revision uses: actions/download-artifact@v4 with: - name: build_files_Rev-0_3 - path: build_files_Rev-0_3 + name: build_files_Legacy + path: build_files_Legacy - - name: Download build files artifact for Rev 1.0 + - name: Download build files artifact for USB Hardware Revision uses: actions/download-artifact@v4 with: - name: build_files_Rev-1_0 - path: build_files_Rev-1_0 + name: build_files_USB + path: build_files_USB - name: ls run: ls - name: Zip fabrication outputs - run: zip -r FABRICATION_OUTPUTS-REV-1_0.zip fab_outputs_rev_1_0 + run: zip -r FABRICATION_OUTPUTS-USB.zip fab_outputs_USB - - name: Zip Rev 0.3 build files - run: zip -r SW_BUILD-REV-0_3.zip build_files_Rev-0_3 + - name: Zip SW_BUILD-Legacy files + run: zip -r SW_BUILD-Legacy.zip build_files_Legacy - - name: Zip Rev 1.0 build files - run: zip -r SW_BUILD-REV-1_0.zip build_files_Rev-1_0 + - name: Zip SW_BUILD-USB files + run: zip -r SW_BUILD-USB.zip build_files_USB - name: Release uses: softprops/action-gh-release@v2 @@ -126,6 +126,6 @@ jobs: with: prerelease: true files: | - SW_BUILD-REV-0_3.zip - SW_BUILD-REV-1_0.zip - FABRICATION_OUTPUTS-REV-1_0.zip \ No newline at end of file + SW_BUILD-Legacy.zip + SW_BUILD-USB.zip + FABRICATION_OUTPUTS-USB.zip \ No newline at end of file diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index aacb377..617d759 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -25,35 +25,35 @@ jobs: - name: Init submodules to get tinyUSB stack run: ls && cd pico-sdk && git submodule update --init && cd .. - - name: Configure and run CMake for Hardware Rev 0.3 + - name: Configure and run CMake for Legacy Hardware Revision # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make. # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type - run: cmake -B ${{github.workspace}}/Software/build-Rev-0_3 -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Rev-0_3 + run: cmake -B ${{github.workspace}}/Software/build-Legacy -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Legacy - - name: Build for Hardware Rev 0.3 + - name: Build for Legacy Hardware Revision # Build your program with the given configuration - run: cmake --build ${{github.workspace}}/Software/build-Rev-0_3 --config ${{env.BUILD_TYPE}} + run: cmake --build ${{github.workspace}}/Software/build-Legacy --config ${{env.BUILD_TYPE}} - - name: Configure and run CMake for Hardware Rev 1.0 + - name: Configure and run CMake for USB Hardware Revision # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make. # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type - run: cmake -B ${{github.workspace}}/Software/build-Rev-1_0 -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-Rev-1_0 + run: cmake -B ${{github.workspace}}/Software/build-USB -S ${{github.workspace}}/Software -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPICO_BOARD=RP2040-Decoder-board-USB - - name: Build for Hardware Rev 1.0 + - name: Build for USB Hardware Revision # Build your program with the given configuration - run: cmake --build ${{github.workspace}}/Software/build-Rev-1_0 --config ${{env.BUILD_TYPE}} + run: cmake --build ${{github.workspace}}/Software/build-USB --config ${{env.BUILD_TYPE}} - - name: Upload build files as artifact Rev 0.3 + - name: Upload build files as artifact for Legacy Hardware Revision uses: actions/upload-artifact@v4 with: - name: build_files_Rev-0_3 - path: ${{github.workspace}}/Software/build-Rev-0_3 + name: build_files_Legacy + path: ${{github.workspace}}/Software/build-Legacy - - name: Upload build files as artifact Rev 1.0 + - name: Upload build files as artifact for USB Hardware Revision uses: actions/upload-artifact@v4 with: - name: build_files_Rev-1_0 - path: ${{github.workspace}}/Software/build-Rev-1_0 + name: build_files_USB + path: ${{github.workspace}}/Software/build-USB generate-fabrication-files: runs-on: ubuntu-latest @@ -75,14 +75,14 @@ jobs: - name: Run fab toolkit CLI run: | cd Fabrication-Toolkit - python3 -m plugins.cli -p ../KiCad/Rev_1_0/RP2040-Decoder.kicad_pcb --autoTranslate --autoFill + python3 -m plugins.cli -p ../KiCad/USB/RP2040-Decoder.kicad_pcb --autoTranslate --autoFill cd .. - name: Upload Artifact uses: actions/upload-artifact@v4 with: - name: fab_outputs_rev_1_0 - path: ./KiCad/Rev_1_0/production + name: fab_outputs_USB + path: ./KiCad/USB/production release: runs-on: ubuntu-latest @@ -94,38 +94,38 @@ jobs: - name: Download fabrication outputs artifact uses: actions/download-artifact@v4 with: - name: fab_outputs_rev_1_0 - path: fab_outputs_rev_1_0 + name: fab_outputs_USB + path: fab_outputs_USB - - name: Download build files artifact for Rev 0.3 + - name: Download build files artifact for Legacy Hardware Revision uses: actions/download-artifact@v4 with: - name: build_files_Rev-0_3 - path: build_files_Rev-0_3 + name: build_files_Legacy + path: build_files_Legacy - - name: Download build files artifact for Rev 1.0 + - name: Download build files artifact for USB Hardware Revision uses: actions/download-artifact@v4 with: - name: build_files_Rev-1_0 - path: build_files_Rev-1_0 + name: build_files_USB + path: build_files_USB - name: ls run: ls - name: Zip fabrication outputs - run: zip -r FABRICATION_OUTPUTS-REV-1_0.zip fab_outputs_rev_1_0 + run: zip -r FABRICATION_OUTPUTS-USB.zip fab_outputs_USB - - name: Zip Rev 0.3 build files - run: zip -r SW_BUILD-REV-0_3.zip build_files_Rev-0_3 + - name: Zip SW_BUILD-Legacy files + run: zip -r SW_BUILD-Legacy.zip build_files_Legacy - - name: Zip Rev 1.0 build files - run: zip -r SW_BUILD-REV-1_0.zip build_files_Rev-1_0 + - name: Zip SW_BUILD-USB files + run: zip -r SW_BUILD-USB.zip build_files_USB - name: Release uses: softprops/action-gh-release@v2 if: startsWith(github.ref, 'refs/tags/') with: files: | - SW_BUILD-REV-0_3.zip - SW_BUILD-REV-1_0.zip - FABRICATION_OUTPUTS-REV-1_0.zip \ No newline at end of file + SW_BUILD-Legacy.zip + SW_BUILD-USB.zip + FABRICATION_OUTPUTS-USB.zip \ No newline at end of file diff --git a/README.md b/README.md index f5a169f..090d5f1 100644 --- a/README.md +++ b/README.md @@ -30,15 +30,15 @@ License ------------ -Rev 1.0 +USB hardware version
- Image 1 - Image 2 + Image 1 + Image 2
-Rev 0.3 +Legacy hardware version
- Image 1 - Image 2 + Image 1 + Image 2
diff --git a/Software/CMakeLists.txt b/Software/CMakeLists.txt index 26940b9..5e854a0 100644 --- a/Software/CMakeLists.txt +++ b/Software/CMakeLists.txt @@ -26,9 +26,9 @@ endif() set(PICO_BOARD_HEADER_DIRS ${CMAKE_SOURCE_DIR}) # Board type selection: # -# Please select RP2040-Decoder-board-Rev-1_0 for Rev >= 1.0 or RP2040-Decoder-board-Rev-0_3 for Rev <= 0.3 -# running cmake with -DPICO_BOARD=RP2040-Decoder-board-Rev-X_Y explicitly from command line overrides this setting -set(PICO_BOARD RP2040-Decoder-board-Rev-1_0 CACHE STRING "Board type") +# Please select RP2040-Decoder-board-USB for Rev >= 1.0 or RP2040-Decoder-board-Legacy for Rev <= 0.3 +# running cmake with -DPICO_BOARD=RP2040-Decoder-board-*** explicitly from command line overrides this setting +set(PICO_BOARD RP2040-Decoder-board-USB CACHE STRING "Board type") # Pull in Raspberry Pi Pico SDK (must be before project) include(pico_sdk_import.cmake) diff --git a/Software/RP2040-Decoder-board-Rev-0_3.h b/Software/RP2040-Decoder-board-Legacy.h similarity index 100% rename from Software/RP2040-Decoder-board-Rev-0_3.h rename to Software/RP2040-Decoder-board-Legacy.h diff --git a/Software/RP2040-Decoder-board-Rev-1_0.h b/Software/RP2040-Decoder-board-USB.h similarity index 100% rename from Software/RP2040-Decoder-board-Rev-1_0.h rename to Software/RP2040-Decoder-board-USB.h diff --git a/docs/sphinx/source/gs/getting_started.rst b/docs/sphinx/source/gs/getting_started.rst index b24c943..d625e75 100644 --- a/docs/sphinx/source/gs/getting_started.rst +++ b/docs/sphinx/source/gs/getting_started.rst @@ -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/docs/sphinx/source/hardware/rev_0_3/hw_description.rst b/docs/sphinx/source/hardware/Legacy/hw_description.rst similarity index 92% rename from docs/sphinx/source/hardware/rev_0_3/hw_description.rst rename to docs/sphinx/source/hardware/Legacy/hw_description.rst index 3fc164f..4334a78 100644 --- a/docs/sphinx/source/hardware/rev_0_3/hw_description.rst +++ b/docs/sphinx/source/hardware/Legacy/hw_description.rst @@ -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/docs/sphinx/source/hardware/rev_1_0/hw_description.rst b/docs/sphinx/source/hardware/USB/hw_description.rst similarity index 93% rename from docs/sphinx/source/hardware/rev_1_0/hw_description.rst rename to docs/sphinx/source/hardware/USB/hw_description.rst index c92c0dd..4d1d16b 100644 --- a/docs/sphinx/source/hardware/rev_1_0/hw_description.rst +++ b/docs/sphinx/source/hardware/USB/hw_description.rst @@ -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/docs/sphinx/source/hardware/index.rst b/docs/sphinx/source/hardware/index.rst index 521d70b..8f84458 100644 --- a/docs/sphinx/source/hardware/index.rst +++ b/docs/sphinx/source/hardware/index.rst @@ -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/docs/sphinx/source/software/sw_description.rst b/docs/sphinx/source/software/sw_description.rst index 7e88fdf..e389535 100644 --- a/docs/sphinx/source/software/sw_description.rst +++ b/docs/sphinx/source/software/sw_description.rst @@ -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/docs/svg/hw/rev_0_3/Aux_Outputs.svg b/docs/svg/hw/Legacy/Aux_Outputs.svg similarity index 100% rename from docs/svg/hw/rev_0_3/Aux_Outputs.svg rename to docs/svg/hw/Legacy/Aux_Outputs.svg diff --git a/docs/svg/hw/rev_0_3/Block_Diagram_Hardware.svg b/docs/svg/hw/Legacy/Block_Diagram_Hardware.svg similarity index 100% rename from docs/svg/hw/rev_0_3/Block_Diagram_Hardware.svg rename to docs/svg/hw/Legacy/Block_Diagram_Hardware.svg diff --git a/docs/svg/hw/rev_0_3/Debug_Connections.svg b/docs/svg/hw/Legacy/Debug_Connections.svg similarity index 100% rename from docs/svg/hw/rev_0_3/Debug_Connections.svg rename to docs/svg/hw/Legacy/Debug_Connections.svg diff --git a/docs/svg/hw/rev_0_3/Input_Stage.svg b/docs/svg/hw/Legacy/Input_Stage.svg similarity index 100% rename from docs/svg/hw/rev_0_3/Input_Stage.svg rename to docs/svg/hw/Legacy/Input_Stage.svg diff --git a/docs/svg/hw/rev_0_3/Microcontroller.svg b/docs/svg/hw/Legacy/Microcontroller.svg similarity index 100% rename from docs/svg/hw/rev_0_3/Microcontroller.svg rename to docs/svg/hw/Legacy/Microcontroller.svg diff --git a/docs/svg/hw/rev_0_3/Motor_Driver.svg b/docs/svg/hw/Legacy/Motor_Driver.svg similarity index 100% rename from docs/svg/hw/rev_0_3/Motor_Driver.svg rename to docs/svg/hw/Legacy/Motor_Driver.svg diff --git a/docs/svg/hw/rev_0_3/RP2040-Decoder.svg b/docs/svg/hw/Legacy/RP2040-Decoder.svg similarity index 100% rename from docs/svg/hw/rev_0_3/RP2040-Decoder.svg rename to docs/svg/hw/Legacy/RP2040-Decoder.svg diff --git a/docs/svg/hw/rev_0_3/Wiring_diagram.svg b/docs/svg/hw/Legacy/Wiring_diagram.svg similarity index 100% rename from docs/svg/hw/rev_0_3/Wiring_diagram.svg rename to docs/svg/hw/Legacy/Wiring_diagram.svg diff --git a/docs/svg/hw/rev_1_0/Aux_Outputs.svg b/docs/svg/hw/USB/Aux_Outputs.svg similarity index 100% rename from docs/svg/hw/rev_1_0/Aux_Outputs.svg rename to docs/svg/hw/USB/Aux_Outputs.svg diff --git a/docs/svg/hw/rev_1_0/Block_Diagram_Hardware.svg b/docs/svg/hw/USB/Block_Diagram_Hardware.svg similarity index 100% rename from docs/svg/hw/rev_1_0/Block_Diagram_Hardware.svg rename to docs/svg/hw/USB/Block_Diagram_Hardware.svg diff --git a/docs/svg/hw/rev_1_0/Input_Stage.svg b/docs/svg/hw/USB/Input_Stage.svg similarity index 100% rename from docs/svg/hw/rev_1_0/Input_Stage.svg rename to docs/svg/hw/USB/Input_Stage.svg diff --git a/docs/svg/hw/rev_1_0/Microcontroller.svg b/docs/svg/hw/USB/Microcontroller.svg similarity index 100% rename from docs/svg/hw/rev_1_0/Microcontroller.svg rename to docs/svg/hw/USB/Microcontroller.svg diff --git a/docs/svg/hw/rev_1_0/Motor_Driver.svg b/docs/svg/hw/USB/Motor_Driver.svg similarity index 100% rename from docs/svg/hw/rev_1_0/Motor_Driver.svg rename to docs/svg/hw/USB/Motor_Driver.svg diff --git a/docs/svg/hw/rev_1_0/RP2040-Decoder.svg b/docs/svg/hw/USB/RP2040-Decoder.svg similarity index 100% rename from docs/svg/hw/rev_1_0/RP2040-Decoder.svg rename to docs/svg/hw/USB/RP2040-Decoder.svg diff --git a/docs/svg/hw/rev_1_0/Wiring_diagram.svg b/docs/svg/hw/USB/Wiring_diagram.svg similarity index 100% rename from docs/svg/hw/rev_1_0/Wiring_diagram.svg rename to docs/svg/hw/USB/Wiring_diagram.svg