From 1fffc8b740a6b59c28cd0f7e31b1e28001944720 Mon Sep 17 00:00:00 2001 From: rusefi Date: Thu, 22 Nov 2018 23:15:05 -0500 Subject: [PATCH] docs --- .../algo/engine_configuration_generated_structures.h | 6 ++++-- firmware/controllers/math/pid_auto_tune.cpp | 1 + firmware/controllers/math/pid_auto_tune.h | 1 + firmware/integration/rusefi_config.txt | 4 ++-- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/firmware/controllers/algo/engine_configuration_generated_structures.h b/firmware/controllers/algo/engine_configuration_generated_structures.h index 958178e3ea..e1bf60470e 100644 --- a/firmware/controllers/algo/engine_configuration_generated_structures.h +++ b/firmware/controllers/algo/engine_configuration_generated_structures.h @@ -1,4 +1,4 @@ -// this section was generated automatically by ConfigDefinition.jar based on rusefi_config.txt Tue Sep 25 15:46:46 EDT 2018 +// this section was generated automatically by ConfigDefinition.jar based on rusefi_config.txt Thu Nov 22 23:13:59 EST 2018 // begin #ifndef ENGINE_CONFIGURATION_GENERATED_H_ #define ENGINE_CONFIGURATION_GENERATED_H_ @@ -27,10 +27,12 @@ typedef struct { */ int16_t period; /** + * Output min value * offset 16 */ int16_t minValue; /** + * Output max value * offset 18 */ int16_t maxValue; @@ -2422,4 +2424,4 @@ typedef struct { #endif // end -// this section was generated automatically by ConfigDefinition.jar based on rusefi_config.txt Tue Sep 25 15:46:46 EDT 2018 +// this section was generated automatically by ConfigDefinition.jar based on rusefi_config.txt Thu Nov 22 23:13:59 EST 2018 diff --git a/firmware/controllers/math/pid_auto_tune.cpp b/firmware/controllers/math/pid_auto_tune.cpp index 745fa73fbe..897a986b2f 100644 --- a/firmware/controllers/math/pid_auto_tune.cpp +++ b/firmware/controllers/math/pid_auto_tune.cpp @@ -27,6 +27,7 @@ #include "efilib.h" #include "efitime.h" +// see https://en.wikipedia.org/wiki/Ziegler%E2%80%93Nichols_method // order must be match enumerated type for auto tune methods Tuning tuningRule[PID_AutoTune::NO_OVERSHOOT_PID + 1] = { diff --git a/firmware/controllers/math/pid_auto_tune.h b/firmware/controllers/math/pid_auto_tune.h index 093906cf49..a55b5a1f48 100644 --- a/firmware/controllers/math/pid_auto_tune.h +++ b/firmware/controllers/math/pid_auto_tune.h @@ -130,6 +130,7 @@ public: byte peakCount; float input; + // suggested P coefficient while auto-tuning float output; void setOutput(float output); diff --git a/firmware/integration/rusefi_config.txt b/firmware/integration/rusefi_config.txt index a49654d3df..e7e1d6962e 100644 --- a/firmware/integration/rusefi_config.txt +++ b/firmware/integration/rusefi_config.txt @@ -144,8 +144,8 @@ struct pid_s float dFactor;;"", 1, 0, -10000, 10000, 7 int16_t offset;Linear addition to PID logic;"", 1, 0, 0, 1000, 0 int16_t period;PID dTime;"ms", 1, 0, 0, 3000, 0 - int16_t minValue;;"", 1, 0, -3000, 3000.0, 3 - int16_t maxValue;;"", 1, 0, -3000, 3000.0, 3 + int16_t minValue;Output min value;"", 1, 0, -3000, 3000.0, 3 + int16_t maxValue;Output max value;"", 1, 0, -3000, 3000.0, 3 end_struct struct cranking_parameters_s