Updated Configuration Variables (CV) List (markdown)

Gabriel Koppenstein committed 2022-08-02 21:12:30 +02:00
1 parent d547a5760e
commit 194eb44327
1 file changed
+35
+35
@@ -14,39 +14,51 @@ The illustration above shows how the speed steps can be configured using the cor
#### CV_1 - Basic address #### CV_1 - Basic address
Short DCC address Short DCC address
#### CV_2 - V_min #### CV_2 - V_min
Min motor voltage/speed Min motor voltage/speed
#### CV_3 - Acceleration rate #### CV_3 - Acceleration rate
CV_3*CV_175 = Time for one discrete speed step change in ms CV_3*CV_175 = Time for one discrete speed step change in ms
#### CV_4 - Deceleration rate #### CV_4 - Deceleration rate
CV_4*CV_175 = Time for one discrete speed step change in ms CV_4*CV_175 = Time for one discrete speed step change in ms
#### CV_5 - V_max #### CV_5 - V_max
Max motor voltage/speed - V_max = CV_5 * 16 Max motor voltage/speed - V_max = CV_5 * 16
#### CV_6 - V_mid #### CV_6 - V_mid
Mid motor voltage/speed - V_max = CV_6 * 16 Mid motor voltage/speed - V_max = CV_6 * 16
#### CV_7 - Version No. (Read-Only) #### CV_7 - Version No. (Read-Only)
Rev 0.3 = 1 Rev 0.3 = 1
#### CV_8 - Manufacturer (Read-Only) #### CV_8 - Manufacturer (Read-Only)
Default = "13" = Public Domain & Do-It-Yourself Decoders Default = "13" = Public Domain & Do-It-Yourself Decoders
Writing a value of 8 resets all CV values to the default values in CV.h. 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". This will also happen if CV_65 == "255" == "0xFF".
#### CV_9 - Motor PWM Frequency #### CV_9 - Motor PWM Frequency
f in Hz = CV_9 * 100 + 10000 f in Hz = CV_9 * 100 + 10000
#### CV_11 - Packet timeout #### CV_11 - Packet timeout
If no package is received for x seconds (x = CV_11) the decoder will automatically stop the motor (Emergency Stop). 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 #### CV_12 - Permitted operating modes
Currently DCC Digital mode is the only supported mode. Currently DCC Digital mode is the only supported mode.
#### CV_17 & CV_18 - 14-Bit extended/long address #### CV_17 & CV_18 - 14-Bit extended/long address
Address is only used if bit5 has a value of "1" in CV_29. Address is only used if bit5 has a value of "1" in CV_29.
@@ -55,12 +67,14 @@ Address is only used if bit5 has a value of "1" in CV_29.
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. 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 #### CV_29 - Decoder Configuration
Bit0 is used to reverse direction i.e. "0" = normal, "1" = reverse. 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. 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. The other 6 bits are currently not in use and therefore irrelevant.
#### CV_31 & CV_32 - Extended CV pointer (Read-Only) #### CV_31 & CV_32 - Extended CV pointer (Read-Only)
Not in use. Not in use.
@@ -68,56 +82,77 @@ Not in use.
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 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 k_ff = CV_47/10000
#### CV_48 - Filter time constant (tau) in ms #### 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 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 #### CV_49 - PID Control sampling time t in ms
Every t seconds the pid_control() function gets called to compute the new control output Every t seconds the pid_control() function gets called to compute the new control output
#### CV_50 - PID Control I Factor #### CV_50 - PID Control I Factor
Integral gain factor of the PID-Controller Integral gain factor of the PID-Controller
#### CV_51 - PID Control D Factor #### CV_51 - PID Control D Factor
Derivative gain factor of the PID-Controller Derivative gain factor of the PID-Controller
#### CV_52 & CV_53 - PID Integral Limits #### CV_52 & CV_53 - PID Integral Limits
Maximum and minimum integral part values Maximum and minimum integral part values
#### CV_54 & CV_55 - Gain scheduling config k_p @ x0 #### CV_54 & CV_55 - Gain scheduling config k_p @ x0
CV_54 - High Byte -- CV_55 - Low Byte CV_54 - High Byte -- CV_55 - Low Byte
#### CV_56 & CV_57 - Gain scheduling config k_p @ x1 #### CV_56 & CV_57 - Gain scheduling config k_p @ x1
CV_56 - High Byte -- CV_57 - Low Byte CV_56 - High Byte -- CV_57 - Low Byte
#### CV_58 & CV_59 - Gain scheduling config k_p @ x2 #### CV_58 & CV_59 - Gain scheduling config k_p @ x2
CV_58 - High Byte -- CV_59 - Low Byte CV_58 - High Byte -- CV_59 - Low Byte
#### CV_60 - Gain scheduling config x1 shift percentage #### CV_60 - Gain scheduling config x1 shift percentage
Determines position of x1 in percent -> x1 shift in % ≙ CV_60/255 Determines position of x1 in percent -> x1 shift in % ≙ CV_60/255
#### CV_61 - Measurement Iterations #### CV_61 - Measurement Iterations
Total amount of BEMF-Voltage measurement iterations Total amount of BEMF-Voltage measurement iterations
#### CV_62 - Measurement Delay #### CV_62 - Measurement Delay
BEMF-Voltage measurement delay BEMF-Voltage measurement delay
#### CV_63 & CV_64 - Measurement array cutoffs #### 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_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 #### 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 restart. 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 restart.
#### CV_112, CV_113, CV_114, CV_115 - GPIO PWM Configuration #### CV_112, CV_113, CV_114, CV_115 - GPIO PWM Configuration
PWM enabled "1" - PWM disabled "0" PWM enabled "1" - PWM disabled "0"
#### CV_116 to CV_171 - PWM Slice configuration #### 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 outputs (Two independent output channels, duty cycle from 0% to 100% inclusive) and can be configured with several parameters: Every slice controls two outputs (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 deciding the frequency * Wrap (16Bit): Sets the slice time period of x cycles - effectively deciding the frequency
* Clock Divider: Additional clock divider * Clock Divider: Additional clock divider
* Level Channel A/Channel B (16Bit): Determining how many of the x cycles the signal is at a high level - effectively deciding the duty cycle * Level Channel A/Channel B (16Bit): Determining how many of the x cycles the signal is at a high level - effectively deciding the duty cycle
A more detailed explanation can be found in the [RP2040-Datasheet](https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf) in Chapter 4.5. A more detailed explanation can be found in the [RP2040-Datasheet](https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf) in Chapter 4.5.
#### CV_175 - speed_helper timer delay #### 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. 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.