Update Sphinx documentation

Author: gab-k

Software/CMakeLists.txt

@@ -79,13 +79,13 @@ endif()
 #   limit the frequency of log outputs—such as logging only every 100th iteration.
 # - Note that with UART logging enabled, PICO_DEFAULT_UART_TX_PIN and PICO_DEFAULT_UART_RX_PIN are disabled for decoder functions.
 #   These pins are used for UART communication. Disabling is done automatically in RP2040-Decoder-board.h or RP2040-Decoder-board-legacy.h respectively.
-set(LOGLEVEL 1)
+set(LOGLEVEL 0)
 # Additionally, the LOG_WAIT parameter can be configured to make the controller wait for user input via stdio before continuing.
 # This is useful for ensuring that all stdio logging outputs are captured.
 # If disabled, there may not be enough time to connect the serial terminal before most of the logging has already been completed.
 set(LOG_WAIT 0)
 # Modify the below lines to enable/disable output over UART and/or USB
-set(STDIO_USB_ENABLED 1)
+set(STDIO_USB_ENABLED 0)
 set(STDIO_UART_ENABLED 0)
 # Leave those two unmodified
 pico_enable_stdio_uart(RP2040-Decoder ${STDIO_UART_ENABLED})

Software/CV.h

@@ -62,7 +62,7 @@ uint8_t CV_ARRAY_DEFAULT [CV_ARRAY_SIZE] = {
    0b00000000,         //CV_44  -
    0b00000000,         //CV_45  -
    0b00000000,         //CV_46  -
-   // TODO: Update controller CVs
+   // TODO: Update controller CVs and implement/redefine k_ff  in the speed controller initialization
    // Speed controller - Configuration /////////////////////////////////////////////////////////////////////////////////
    0b00110010,         //CV_47  -   Feed-forward gain k_ff      =   CV_47/10000     Default = 50 -> 0.005             //
    0b00001010,         //CV_48  -   PID Control low pass filter time constant (tau) in ms                             //
@@ -213,10 +213,10 @@ uint8_t CV_ARRAY_DEFAULT [CV_ARRAY_SIZE] = {
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
    0b00000001,         //CV_174  -  Additional motor-PWM clock divider.
    0b00000111,         //CV_175  -  speed_helper timer delay -  can be used to adjust accel/decel rate
-   0b00000000,         //CV_176  -  Base-PWM forward bits 8-15
-   0b00000000,         //CV_177  -  Base-PWM forward bits 0-7
-   0b00000000,         //CV_178  -  Base-PWM reverse bits 15-8
-   0b00000000,         //CV_179  -  Base-PWM reverse bits 0-7
+   0b00000000,         //CV_176  -  
+   0b00000000,         //CV_177  -  
+   0b00000000,         //CV_178  -  
+   0b00000000,         //CV_179  -  
    0b00000000,         //CV_180  -
    0b00000000,         //CV_181  -
    0b00000000,         //CV_182  -

Software/core1.c

@@ -147,7 +147,7 @@ float get_kp(const controller_parameter_t *const ctrl_par) {
 uint16_t get_initial_level(controller_parameter_t *const ctrl_par){
     uint32_t sum = 0;
     uint32_t i = 0;
-    while (i < 16) {
+    while (i < BASE_PWM_ARR_LEN) {
         if (ctrl_par->startup.base_pwm_arr[i] > 0) {
             sum += ctrl_par->startup.base_pwm_arr[i];
             i++;
@@ -177,7 +177,7 @@ void controller_startup_mode(controller_parameter_t *const ctrl_par) {
         // Save level value in array
         ctrl_par->startup.base_pwm_arr[ctrl_par->startup.base_pwm_arr_i] = ctrl_par->startup.level;
         // Update index
-        ctrl_par->startup.base_pwm_arr_i = (ctrl_par->startup.base_pwm_arr_i+1)%16;
+        ctrl_par->startup.base_pwm_arr_i = (ctrl_par->startup.base_pwm_arr_i+1)%BASE_PWM_ARR_LEN;
         // Set ramp_up_mode flag to true
         ctrl_par->mode = PID_MODE;
         // multiply with constant value of 0.9 and set as current feed forward value for pid mode

…/sphinx/source/other/getting_started.rst docs/sphinx/source/gs/getting_started.rstdocs/sphinx/source/other/getting_started.rst renamed to docs/sphinx/source/gs/getting_started.rst docs/sphinx/source/other/getting_started.rst renamed to docs/sphinx/source/gs/getting_started.rst

@@ -8,23 +8,26 @@ You can choose any PCB manufacturer you like. The PCB is designed to fit with JL
 
 2. Production files?
 ----------------------------------
+The latest release includes the production files for JLCPCB, which includes the Gerber files, BOM, and Pick and Place files. You can find the latest release `here <https://github.com/gab-k/RP2040-Decoder/releases>`_.
 
-In order to export the production files (Gerber/BOM/Pick and Place), you need `KiCad <https://www.kicad.org/download/>`_ which is open source.
+In order to manually export the production files (Gerber/BOM/Pick and Place), you need `KiCad <https://www.kicad.org/download/>`_ which is open source.
 In case you are ordering from JLCPCB it is recommended to use the `Fabrication-Toolkit KiCad plugin by bennymeg <https://github.com/bennymeg/Fabrication-Toolkit>`_
 
 .. _building_the_software:
 
 3. Building the software
 ----------------------------------
 
-If you got a RP2040-Decoder with USB the easiest way to get the RP2040-Decoder up and running is to just use the precompiled .uf2 file and ignore the rest of this section.
+If you got a RP2040-Decoder with USB the easiest way to get the RP2040-Decoder up and running is to just use the precompiled .uf2 file in the latest `release <https://github.com/gab-k/RP2040-Decoder/releases>`_ and skip to :ref:`flashing_the_software`.
 
 However sometimes you might want to build by yourself, be it for debugging or to make your own modifications to the source code.
 The easiest way to do this is to just use `Visual Studio Code <https://code.visualstudio.com/>`_ and the Raspberry Pi Pico extension. 
 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: If you are building for Hardware Rev 0.3 or below change the board defintion in your CMakeLists.txt file to: "RP2040-Decoder-board-legacy.h"
 
+.. _flashing_the_software:
+
 4. Flashing the software
 ----------------------------------
 
@@ -43,15 +46,18 @@ For RP2040-Decoders without USB the only way of flashing the software is via SWD
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 When first plugged in the RP2040 boots into Mass Storage Device mode. To flash the software, you need to drag the '.uf2' file onto the disk using any file explorer.
 This will write the file to the Flash and restart the RP2040.
-In case you want to repeat the flasing process, temporarily connect the solder bridge called JP1 on the back side of the board and power cycle the device.
+In case you want to repeat the flashing process, hold the button SW1 while re-plugging the decoder into your computer. The decoder should now show as a Mass Storage Device again.
 This procedure is also described in the `Raspberry Pi Pico Datasheet Chapter 4.1 <https://datasheets.raspberrypi.com/pico/pico-datasheet.pdf#_programming_the_flash>`_
 
+.. _flashing_the_software_swd:
+
 4.2. Flashing the software via SWD
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Flashing via SWD is a little more complicated but also comes with great advantages in terms of debugging.
 The book on `Getting started with Raspberry Pi Pico-series <https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf>`_ does a great job of explaining how debugging works.
-As already suggested in :ref:`3. <building_the_software>` it is recommended to use the `Visual Studio Code Extension <https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#vscode-extension>`_.
-Most relevant in the book are `Chapter 4.3. Debug <https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#_debug>`_ and `Appendix A: Debugprobe <https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#debugprobe_section>`_
+As already suggested in :ref:`building_the_software` it is recommended to use the `Visual Studio Code Extension <https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#vscode-extension>`_.
+The most relevant sections in the book are `Chapter 4.3. Debug <https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#_debug>`_ and `Appendix A: Debugprobe <https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf#debugprobe_section>`_
+
 
 5. Wiring
 ----------------------------------

docs/sphinx/source/hardware/rev_0_3/hw_description.rst

@@ -110,10 +110,6 @@ Complete Schematic
 
    Complete Schematic
 
-BOM & Alternative Parts
-==============================
-please see **PLACEHOLDER-AUTOGENERATED-BOM** for the complete BOM.
-
 
 .. _wiring_rev_0_3:
 

docs/sphinx/source/hardware/rev_1_0/hw_description.rst

@@ -112,10 +112,6 @@ Complete Schematic
 
    Complete Schematic
 
-BOM & Alternative Parts
-==============================
-please see **PLACEHOLDER-AUTOGENERATED-BOM** for the complete BOM.
-
 
 .. _wiring_rev_1_0:
 

docs/sphinx/source/index.rst

@@ -10,8 +10,7 @@ RP2040-Decoder Documentation
    :maxdepth: 3
    :caption: Contents:
 
-   other/getting_started
+   gs/getting_started
    hardware/index
    software/index
-   other/index
-   other/troubleshooting
+   other/index