diff --git a/Software/CMakeLists.txt b/Software/CMakeLists.txt index ad88443..26940b9 100644 --- a/Software/CMakeLists.txt +++ b/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}) diff --git a/Software/CV.h b/Software/CV.h index eedf2f1..3f5f7c2 100644 --- a/Software/CV.h +++ b/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 - diff --git a/Software/core1.c b/Software/core1.c index 163b107..c6d3094 100644 --- a/Software/core1.c +++ b/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 diff --git a/docs/sphinx/source/other/getting_started.rst b/docs/sphinx/source/gs/getting_started.rst similarity index 75% rename from docs/sphinx/source/other/getting_started.rst rename to docs/sphinx/source/gs/getting_started.rst index c21a635..4ef9afb 100644 --- a/docs/sphinx/source/other/getting_started.rst +++ b/docs/sphinx/source/gs/getting_started.rst @@ -8,8 +8,9 @@ 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 `_. -In order to export the production files (Gerber/BOM/Pick and Place), you need `KiCad `_ which is open source. +In order to manually export the production files (Gerber/BOM/Pick and Place), you need `KiCad `_ which is open source. In case you are ordering from JLCPCB it is recommended to use the `Fabrication-Toolkit KiCad plugin by bennymeg `_ .. _building_the_software: @@ -17,7 +18,7 @@ In case you are ordering from JLCPCB it is recommended to use the `Fabrication-T 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 `_ 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 `_ and the Raspberry Pi Pico extension. @@ -25,6 +26,8 @@ The `official documentation `_ +.. _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 `_ does a great job of explaining how debugging works. -As already suggested in :ref:`3. ` it is recommended to use the `Visual Studio Code Extension `_. -Most relevant in the book are `Chapter 4.3. Debug `_ and `Appendix A: Debugprobe `_ +As already suggested in :ref:`building_the_software` it is recommended to use the `Visual Studio Code Extension `_. +The most relevant sections in the book are `Chapter 4.3. Debug `_ and `Appendix A: Debugprobe `_ + 5. Wiring ---------------------------------- diff --git a/docs/sphinx/source/hardware/rev_0_3/hw_description.rst b/docs/sphinx/source/hardware/rev_0_3/hw_description.rst index 7602360..3fc164f 100644 --- a/docs/sphinx/source/hardware/rev_0_3/hw_description.rst +++ b/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: diff --git a/docs/sphinx/source/hardware/rev_1_0/hw_description.rst b/docs/sphinx/source/hardware/rev_1_0/hw_description.rst index 02ac344..c92c0dd 100644 --- a/docs/sphinx/source/hardware/rev_1_0/hw_description.rst +++ b/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: diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 67b8374..151cca1 100644 --- a/docs/sphinx/source/index.rst +++ b/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 \ No newline at end of file diff --git a/docs/sphinx/source/other/CV_list.md b/docs/sphinx/source/other/CV_list.md deleted file mode 100644 index 0e05c75..0000000 --- a/docs/sphinx/source/other/CV_list.md +++ /dev/null @@ -1,202 +0,0 @@ -# Configuration Variables (CV) - -## Note -CV.h contains default values for every CV. When your board is still "factory new" these values are automatically written into flash. CV_65 == 255 indicates a factory condition and resets all CVs to default. Alternatively to reset all CVs to default a value of 8 can be written to CV8. Also note that index 0 in the CV array corresponds with CV_1, index 1 corresponds with CV_2 and so forth. This list only contains CVs that are in use. - -## Speed step configuration -![Speed Table](https://github.com/gab-k/RP2040-Decoder/blob/main/docs/svg/speed_table.svg) -* V_min = CV_2 -* V_mid = CV_6 * 16 -* V_max = CV_5 * 16 - -The illustration above shows how the speed steps can be configured using the corresponding CVs. The red * represents V_min which is always at speed step 1, the green * shows V_mid at speed step 64 and the blue * shows V_max at speed step 126. - -## CV List - -### CV_1 - Basic address -Short DCC address - - -### CV_2 - V_min -Min motor voltage/speed - - -### CV_3 - Acceleration rate -CV_3*CV_175 = Time for one discrete speed step change in ms - - -### CV_4 - Deceleration rate -CV_4*CV_175 = Time for one discrete speed step change in ms - - -### CV_5 - V_max -Max motor voltage/speed - V_max = CV_5 * 16 - - -### CV_6 - V_mid -Mid motor voltage/speed - V_max = CV_6 * 16 - - -### CV_7 - Version No. (Read-Only) -Rev 0.3 = 1 - -Writing a value of 7 triggers am ADC offset adjustment. - -### CV_8 - Manufacturer (Read-Only) -Default = "13" = Public Domain & Do-It-Yourself Decoders - - -Writing a value of 8 resets all CV values to the default values in CV.h. -This will also happen if CV_65 == "255" == "0xFF". - - -### CV_9 - Motor PWM Frequency -f in Hz = CV_9 * 100 + 10000 - - -### CV_11 - Packet timeout -If no package is received for x seconds (x = CV_11) the decoder will automatically stop the motor (Emergency Stop). - - -### CV_12 - Permitted operating modes -Currently DCC Digital mode is the only supported mode. - - -### CV_17 & CV_18 - 14-Bit extended/long address -Address is only used if bit5 has a value of "1" in CV_29. - -![Long Address](https://github.com/gab-k/RP2040-Decoder/blob/main/docs/svg/Long_address.svg) - -Bit15 and bit14 which correspond to bit7 and bit6 of CV_17 are always "1". CV_17 = "192" & CV_18 = "0" is also not a valid address. Otherwise the valid value range of CV_17 ranges from "192" to "231" and "0" to "255" for CV_18 respectively. - - - -### CV_29 - Decoder Configuration - -Bit0 is used to reverse direction i.e. "0" = normal, "1" = reverse. -Bit5 switches between basic and extended addressing modes i.e. "0" = basic address, "1" = extended address. -The other 6 bits are currently not in use and therefore irrelevant. - - -### CV_31 & CV_32 - Extended CV pointer (Read-Only) -Not in use. - -### CV_47 - Feed-forward gain k_ff -k_ff defines the correction behavior with regard to the y2 variable. High values for k_ff lead to a faster change in the variable. Values for k_ff that are too high can lead to oscillations. -k_ff = CV_47/10000 - - -### CV_48 - Filter time constant (tau) in ms -The time constant tau characterizes the low-pass filter which is connected downstream in the D component of the PID controller - - -### CV_49 - PID Control sampling time t in ms -Every t seconds the pid_control() function gets called to compute the new control output - - -### CV_50 - PID Control I Factor -Integral gain factor of the PID-Controller - - -### CV_51 - PID Control D Factor -Derivative gain factor of the PID-Controller - - -### CV_52 & CV_53 - PID Integral Limits -Maximum and minimum integral part values - - -### CV_54 & CV_55 - Gain scheduling config k_p @ x0 -CV_54 - High Byte -- CV_55 - Low Byte - - -### CV_56 & CV_57 - Gain scheduling config k_p @ x1 -CV_56 - High Byte -- CV_57 - Low Byte - - -### CV_58 & CV_59 - Gain scheduling config k_p @ x2 -CV_58 - High Byte -- CV_59 - Low Byte - - -### CV_60 - Gain scheduling config x1 shift percentage -Determines position of x1 in percent -> x1 shift in % ≙ CV_60/255 - - -### CV_61 - Measurement Iterations -Total amount of BEMF-Voltage measurement iterations - - -### CV_62 - Measurement Delay -BEMF-Voltage measurement delay - - -### CV_63 & CV_64 - Measurement array cutoffs -CV_63 determines how many elements from the left side (beginning with index 0) of the array will be discarded while CV_64 determines how many elements from the right side (beginning from highest index) will be discarded. - - -### CV_65 - New flash variable -Each Byte of the factory new flash chip should have a inital state of "0xFF". This will be checked for in the beginning of core0.c (see cv_setup_check()). When CV_65 == "255" == "0xFF" the default config (CV.h) will be written to flash. Alternatively a reset to default can be done by either writing "8" to CV_8 or writing "255" to CV_65 which then triggers a reset on startup. - - -### CV_112, CV_113, CV_114, CV_115 - GPIO PWM Configuration -PWM enabled "1" - PWM disabled "0" - - -### CV_116 to CV_171 - PWM Slice configuration -![GPIO Slices](https://github.com/gab-k/RP2040-Decoder/blob/main/docs/svg/GPIO_slices.svg) - - -Every slice controls two independent output channels, duty cycle from 0% to 100% inclusive and can be configured with several parameters: - - -* Wrap (16Bit): Sets the slice time period of x cycles - effectively determining the frequency -* Clock Divider: Additional clock divider -* Level Channel A / Level Channel B - (16Bit each): Determining how many of the x cycles the signal is at a high level - effectively determining the duty cycle - -To see which CVs correspond to which slice and channel, it is advisable to use CV.h as a reference - -The PWM-frequency is calculated as follows: fPWM = 125 MHz / [ (CVclk_div + 1) * (CVwrap + 1) ] - -The duty-cycle can be calculated as follows: D = CVLevel / CVwrap + 1 - -**Example configuration - (AUX2: PWM-Frequency fPWM = 10kHz; Duty-cycle D = 20%):** - -AUX1 => GPIO25 => Slice 4 / Channel B => Wrap: CV_144 & CV_145; Clock-divider: CV_146; Level(B): CV_149 & CV_150 - -=> fPWM = 10kHz = 125 MHz / [ (0 + 1) * (12499 + 1) ]; - -=> CV_144 = 110000, CV_145 = 11010011, CV_146 = 0; --- (Note: "12499dec" = "11000011010011bin") - -=> CVLevel = CV_149 & CV_150 = D * (CVwrap + 1) = 0.2 * 12500 = 2500 - -=> CV_149 = 1001, CV_150 = 11000100; --- (Note: "2500dec" = "100111000100bin") - -Another configuration which also achieves 10kHz and D = 20% would be CVclk_div = 10, CVwrap = 1249, CVLevel = 250. - - -A more detailed explanation regarding PWM can be found in the [RP2040-Datasheet - Chapter 4.5](https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf). - -### CV_172 - ADC Offset -If CV_172 = "0xFF" = "255" there will be a measurement procedure on startup - - -### CV_173 - ADC offset measurement cycles -Determines how many ADC offset measurement iterations are done. - - -### CV_174 - Additional motor-PWM clock divider. -Additional Clock Divider - works the same as any GPIO clock divider - - -### CV_175 - speed_helper timer delay -This timer delay can be used to change the time between two speed steps. So basically an additional option to adjust the deceleration and acceleration rate. - - -### CV_176, CV_177, CV_178, CV_179 - Base PWM Level used in feed-forward control -CV_176 - High Byte forward -- CV_177 - Low Byte forward -- CV_178 - High Byte reverse -- CV_179 - Low Byte reverse - -These values are equivalent to y1(forward) and y1(reverse) mentioned [here](https://github.com/gab-k/RP2040-Decoder/wiki/Software-description#feed-forward). Writing "0" to all four CVs schedules a new calibration on startup. - - -### CV_257 to CV_512 - Function Mapping CVs -The switching status of the outputs depends both on the function instruction received and on the current direction of travel. That means you can, for example, use a function to switch two or more outputs or, as is usual with headlights, switch them depending on the direction of travel. For configuration, 32 bits (corresponding to the GPIOs) are available for each function in each direction of travel. diff --git a/docs/sphinx/source/other/CV_list.rst b/docs/sphinx/source/other/CV_list.rst new file mode 100644 index 0000000..b84491a --- /dev/null +++ b/docs/sphinx/source/other/CV_list.rst @@ -0,0 +1,126 @@ +Configuration Variables (CV) +============================ + + +.. note:: + + - ``CV.h`` contains default values for every CV. When your board is still "factory new" these values are automatically written into flash. ``CV_65 == 255`` indicates a factory condition and resets all CVs to default. + + - Index 0 in the CV array corresponds with ``CV_1``, index 1 corresponds with ``CV_2`` and so forth. + +Reset all CVs +------------------------ + +To reset all CVs to default, a value of ``8`` can be written to ``CV8``. Alternatively write a value of ``255`` to ``CV_65`` this will also reset all CVs to default, but only after power cycling the decoder. + +Speed step configuration +------------------------ + +.. figure:: ../../../svg/sw/speed_table.svg + :alt: Speed Table + :align: center + + Speed Table + +* :math:`v_{min} = CV_{2}` +* :math:`v_{mid} = 16 \cdot CV_{6}` +* :math:`v_{max} = 16 \cdot CV_{5}` + +The figure above shows how the speed steps can be configured using the corresponding CVs. The red * represents :math:`v_{min}` which is always at speed step 1, the green * shows :math:`v_{mid}` at speed step 63, and the blue * shows :math:`v_{max}` at speed step 126. + +CV List +------- + +:math:`CV_{1}` - Basic address +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Short DCC address + +:math:`CV_{2}` - :math:`v_{min}` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Min motor voltage/speed is: :math:`v_{min} = CV_{2}` + +:math:`CV_{3}` - Acceleration rate +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The time for one discrete acceleration time step can be calculated as :math:`CV_{3} \cdot CV_{175}`. + +.. note:: Base speed steps are always 128/126 steps. + +:math:`CV_{4}` - Deceleration rate +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The time for one discrete deceleration time step can be calculated as :math:`CV_{4} \cdot CV_{175}`. + +.. note:: Base speed steps are always 128/126 steps. + +:math:`CV_{5}` - :math:`v_{max}` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Max motor voltage/speed is calculated as: :math:`v_{max} = 16 \cdot CV_{5}` + +:math:`CV_{6}` - :math:`v_{mid}` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Mid motor voltage/speed is calculated as: :math:`v_{mid} = 16 \cdot CV_{6}` + +:math:`CV_{7}` - Version No. (Read-Only) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Writing a value of ``7`` triggers an ADC offset adjustment. + +:math:`CV_{8}` - Manufacturer (Read-Only) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Default = ``13`` = Public Domain & Do-It-Yourself Decoders + +Even though :math:`CV_{8}` is defined as a Read-only CV, writing a value of ``8`` resets all CV values to the default values in ``CV.h``. + +:math:`CV_{9}` - Motor PWM Frequency +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +:math:`f_{PWM_{MOTOR}} = (CV_9 \cdot 100 + 10000) \, Hz` + +:math:`CV_{11}` - Packet timeout +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +If no package is received for :math:`x = CV_{11}` seconds the decoder will automatically stop the motor (Emergency Stop). + +:math:`CV_{12}` - Permitted operating modes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Currently, DCC Digital mode is the only supported mode. + +:math:`CV_{17}` & :math:`CV_{18}` - 14-Bit extended/long address +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Address is only used if bit5 of :math:`CV_{29}` has a value of ``1``. + +.. image:: ../../../svg/sw/Long_address.svg + :alt: Long Address + :align: center + +Bit15 and bit14 which correspond to bit7 and bit6 of :math:`CV_{17}` are always ``1``. :math:`CV_{17} = 192` & :math:`CV_{18} = 0` is also not a valid address. +Otherwise, the valid value range of :math:`CV_{17}` ranges from ``192`` to ``231`` and ``0`` to ``255`` for :math:`CV_{18}` respectively. + +:math:`CV_{29}` - Decoder Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Bit0 is can be used to reverse motor direction, i.e., ``0`` = normal, ``1`` = reverse. +Bit5 switches between basic and extended addressing modes, i.e., ``0`` = basic address, ``1`` = extended address. +The other 6 bits are currently not in use and therefore irrelevant. + +:math:`CV_{31}` & :math:`CV_{32}` - Extended CV pointer (Read-Only) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Not in use. + + +:math:`CV_{116}` to :math:`CV_{171}` - PWM Slice configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. image:: ../../../svg/sw/GPIO_slices.svg + :alt: GPIO Slices + :align: center + +Every slice controls two independent output channels, duty cycle from 0% to 100% inclusive, and can be configured with several parameters: + +* Wrap (16Bit): Sets the slice time period of x cycles - effectively determining the frequency +* Clock Divider: Additional clock divider +* Level Channel A / Level Channel B (16Bit each): Determining how many of the x cycles the signal is at a high level - effectively determining the duty cycle + +To see which CVs correspond to which slice and channel, it is advisable to use ``CV.h`` as a reference. + +The PWM frequency is calculated as follows: :math:`f_{PWM} = \frac{125 \, \text{MHz}}{(CV_{\text{clk_div}} + 1) \cdot (CV_{\text{wrap}} + 1)}` + +The duty-cycle can be calculated as follows: :math:`D = \frac{CV_{\text{Level}}}{CV_{\text{wrap}} + 1}` + + +A more detailed explanation regarding PWM can be found in the `RP2040-Datasheet - Chapter 4.5 `_. + diff --git a/docs/sphinx/source/other/debug_logging.rst b/docs/sphinx/source/other/debug_logging.rst new file mode 100644 index 0000000..7b3f6e0 --- /dev/null +++ b/docs/sphinx/source/other/debug_logging.rst @@ -0,0 +1,23 @@ +Debugging and Logging +================================== + +For logging and debugging you have to build the software yourself. This is explained here: :ref:`building_the_software` + +.. _debugging_via_swd: + +Debugging via SWD +---------------------------------- +Please refer to :ref:`flashing_the_software_swd`. + + +.. _logging: + +Logging +---------------------------------- + +Logging can be enabled in ``CMakeLists.txt``, and is available with two interfaces: + + - Logging via UART RX/TX pins (GPIO0/GPIO1 by default) + - Logging via USB CDC/ACM + +Additionally you can make the decoder wait for input via serial port by setting LOG_WAIT to 1. For more details please see comments inside ``CMakeLists.txt``. diff --git a/docs/sphinx/source/other/index.rst b/docs/sphinx/source/other/index.rst index f775542..8e1aa68 100644 --- a/docs/sphinx/source/other/index.rst +++ b/docs/sphinx/source/other/index.rst @@ -5,5 +5,6 @@ Other :maxdepth: 2 :caption: Contents: - CV_list - troubleshooting \ No newline at end of file + troubleshooting + debug_logging + CV_list \ No newline at end of file diff --git a/docs/sphinx/source/other/troubleshooting.md b/docs/sphinx/source/other/troubleshooting.md deleted file mode 100644 index 0a53c06..0000000 --- a/docs/sphinx/source/other/troubleshooting.md +++ /dev/null @@ -1,14 +0,0 @@ -# Troubleshooting - -To narrow down the issue when your decoder is not working as expected, you can do the following: - -Check the power supply of the decoder: -* +3V3 to GND should be 3.3V -* +V to GND should be somewhere in the range of around +10V to +20V -* If you dont measure the correct voltages, try to [measure Track Voltage](https://dccwiki.com/Measuring_Track_Voltage) - -Check your motor: -* Desolder your motor and try the motor with a analog power supply 0...+-16V to check if the motor is working or not (desolder the wires because the decoder doesn't like voltage on these pins!) - -Reset: -* Try to reset the decoder by writing a value of 8 to CV8 (beware, this will reset the complete CV memory!) \ No newline at end of file diff --git a/docs/sphinx/source/other/troubleshooting.rst b/docs/sphinx/source/other/troubleshooting.rst new file mode 100644 index 0000000..771778a --- /dev/null +++ b/docs/sphinx/source/other/troubleshooting.rst @@ -0,0 +1,27 @@ +Troubleshooting +================ + +To narrow down the issue when your decoder is not working as expected, you can do the following (in no particular order): + +Enable logging and or debug via SWD +------------------------------------ +Log messages can be enabled and output via either UART or USB please see :ref:`logging` for details. +For more advanced users it might also be beneficial to :ref:`debug with SWD ` + +Checking the power supply: +-------------------------------------- + +* **+3V3 to GND** should be 3.3V ± 1% +* **VDC/+V to GND** should be somewhere in the range of at least 6V to 23V depending on your track voltage. + +If you don't measure the correct voltages, try to `measure your track voltage `_ + +Check your motor: +----------------- + +Desolder your motor and try the motor with an appropriate power supply and DC voltage, to check if the motor is working or not. + +CV Reset: +------------ + +Try to reset the decoder by writing a value of ``8`` to ``CV8`` (beware, this will reset the complete CV memory!) diff --git a/docs/sphinx/source/software/sw_description.rst b/docs/sphinx/source/software/sw_description.rst index 4892bb0..7e88fdf 100644 --- a/docs/sphinx/source/software/sw_description.rst +++ b/docs/sphinx/source/software/sw_description.rst @@ -65,14 +65,14 @@ Control Loop & Digital Controller Control Loop - Block diagram -The block diagram above shows the complete control loop. The actual digital controller block is explained below. +The block diagram above shows the (simplified) control loop. The actual digital controller block is explained below. -The Speed Helper block effectively sets the setpoint of the controller according to the CV configured acceleration and deceleration rates and actual target speedstep. +The *Speed Helper* block effectively sets the setpoint of the controller according to the CV configured acceleration and deceleration rates and actual target speedstep. -For feedback the back EMF voltage V_EMF is measured via voltage divider and ADC. V_EMF is proportional to the motor speed in RPM. +For feedback the back EMF voltage *V_EMF* is measured via voltage divider and ADC. *V_EMF* is proportional to the motor speed. -TODO: rewrite this: While the central component is the PID controller, there is an additional block called `Feed-forward `_ that has an impact on the control output variable. The Feed-forward block adds an additional offset to the output depending on the setpoint; this is done to achieve better control. A more detailed explanation regarding Feed-forward can be found below. The speed helper block corresponds to the ``speed_helper()`` function, which delays changing the setpoint according to the configured deceleration/acceleration rates. +While the central component is the PID controller, there is an additional block called `Feed-forward `_ that has an impact on the control output variable. The Feed-forward block adds an additional offset to the output depending on the setpoint; this is done to achieve better control. A more detailed explanation regarding Feed-forward can be found below. The speed helper block corresponds to the ``speed_helper()`` function, which delays changing the setpoint according to the configured deceleration/acceleration rates. .. figure:: ../../../svg/sw/Block_Diagram_Digital_Controller.svg :alt: Block Diagram - Digital Controller @@ -80,12 +80,27 @@ TODO: rewrite this: While the central component is the PID controller, there is Digital Controller - Block diagram -The controller is divided into two parts, depending on whether the motor is stationary or in motion. The startup controller handles overcoming friction of the motor, and finding base PWM level for overcoming friction. The base PWM level is saved and added to the output of the PID controller which handles motor control when the motor is in motion. +The controller is divided into two parts, depending on whether the motor is stationary or in motion. +At all times either the startup controller or the PID controller is active. + +The startup controller handles overcoming friction of the motor, and finding a base PWM level for overcoming friction. +The base PWM level is equivalent to a certain PWM duty cycle. +The base level gets saved and added to the output of the PID controller which handles motor control when the motor is in motion. +This means the actual output of the PID controller is the sum of the PID output and the base PWM level. This is referred to as the :ref:`feed forward ` block. +The benefit of doing this is that the PID controller does not have to work in the non linear friction region of the motor, improving control performance. Startup Controller ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Used on startup, meaning when the motor is not moving. The startup controller sets a PWM duty cycle level of :math:`\frac{2}{3} \cdot \text{base_pwm}` and then ramps up the duty cycle/PWM level until the motor starts moving. This is done in order to overcome the friction of the drive train and motor. :math:`\text{base_pwm}` is the average value of the 16 previous startup PWM levels. When no previous startup PWM levels are saved the startup controller begins ramping up from 0. The actual value at which the motor started moving is used as a reference for the :ref:`feed forward ` block. + +Used on startup, meaning when the motor is not moving. First the startup controller retrieves the last `BASE_PWM_ARR_LEN` base PWM levels. +The base pwm levels are not retained on a power cycle. That means when there is no previous base PWM level saved, the startup controller will start ramping up from 0. +When there is less than `BASE_PWM_ARR_LEN` base PWM levels saved, the startup controller will ramp up from the average of the saved base PWM levels. + +After the startup controller retrieved the average of the last base pwm levels :math:`\bar{b}` it sets a PWM duty cycle level of :math:`\frac{2}{3} \cdot \bar{b}` and then ramps up the duty cycle/PWM level until the motor starts moving. +When no previous startup PWM levels are saved the startup controller begins ramping up from 0. +The actual value at which the motor started moving is multiplied by `K_FF` and used as a reference for the :ref:`feed forward ` block. + PID Controller @@ -131,7 +146,7 @@ This results in the following difference equations which are then implemented in Gain Scheduling -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^ .. figure:: ../../../svg/sw/adaptive_kp.svg :alt: Gain Scheduling figure @@ -145,19 +160,12 @@ Another aspect to consider is the implementation of `gain scheduling `_ is used. +In essence this means that the output of the PID controller is not only the sum of the proportional, integral, and derivative parts, but also the base PWM level. +The base PWM level is set by the startup controller and is the PWM level at which the motor starts moving. -.. figure:: ../../../svg/sw/feed_forward.svg - :alt: Feed forward figure - :align: center - - Feed-forward - - -TODO: Update this part: - -To achieve better control, `Feed-forward `_ is used. On startup, the decoder will check for a configuration regarding Feed-forward control. When no configuration is found, the decoder automatically runs a calibration to establish a base PWM level (y\ :sub:`1`) for both directions. The base PWM level (y\ :sub:`1`) will vary depending on load, motor, and voltage on the tracks and can be configured with CV_176 - CV_179. If the setpoint is greater than the threshold, y\ :sub:`2` is corrected automatically when i\ :sub:`n` reaches 0.5i\ :sub:`min` or 0.5i\ :sub:`max`. CV_47 can be used to set how sensitive this correction is. Back-EMF voltage measurement ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/svg/hw/rev_1_0/Wiring_diagram.svg b/docs/svg/hw/rev_1_0/Wiring_diagram.svg new file mode 100644 index 0000000..a2242a4 --- /dev/null +++ b/docs/svg/hw/rev_1_0/Wiring_diagram.svg @@ -0,0 +1,4 @@ + + + +
Motor0
Motor1
Track0
Track1
Load1
Load0
\ No newline at end of file diff --git a/docs/svg/sw/Block_Diagram_Digital_Controller.svg b/docs/svg/sw/Block_Diagram_Digital_Controller.svg new file mode 100644 index 0000000..5e5e20f --- /dev/null +++ b/docs/svg/sw/Block_Diagram_Digital_Controller.svg @@ -0,0 +1,4 @@ + + + +
STARTUP_MODE
K_FF*startup.level
MEASUREMENT & ERROR
MODE?
STARTUP
CONTROLLER
PID
CONTROLLER
PID_MODE
FEED_FWD
LEVEL
+

+
OUTPUT (PID_MODE)
OUTPUT (STARTUP_MODE)
MEASUREMENT & ERROR
\ No newline at end of file