From 651101e6bca79cb176d76a3a61c93fb727b0ac20 Mon Sep 17 00:00:00 2001 From: rusefillc Date: Tue, 1 Nov 2022 16:51:51 -0400 Subject: [PATCH] Too long field comment becomes log field name #4716 --- firmware/controllers/actuators/idle_state.txt | 8 ++++---- firmware/controllers/algo/engine_state.txt | 8 ++++---- firmware/controllers/algo/fuel/fuel_computer.txt | 2 +- firmware/controllers/algo/wall_fuel_state.txt | 4 ++-- firmware/controllers/engine_cycle/knock_controller.txt | 2 +- firmware/integration/rusefi_config.txt | 4 ++-- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/firmware/controllers/actuators/idle_state.txt b/firmware/controllers/actuators/idle_state.txt index 5428304fe9..72408c1ca1 100644 --- a/firmware/controllers/actuators/idle_state.txt +++ b/firmware/controllers/actuators/idle_state.txt @@ -7,10 +7,10 @@ custom idle_state_e 4 bits, S32, @OFFSET@, [0:2], "not important" percent_t currentIdlePosition;"idle: current position\nthat's current position with CLT and IAT corrections" percent_t baseIdlePosition;"idle: base value\ncurrent position without adjustments (iacByTpsTaper, afterCrankingIACtaperDuration)" - percent_t iacByTpsTaper;idle: iacByTpsTaper portion of idle - int throttlePedalUpState;true in IDLE throttle pedal state, false if driver is touching the pedal\ntodo: better name for this field? + percent_t iacByTpsTaper;idle: iacByTpsTaper portion + int throttlePedalUpState;idle: throttlePedalUpState\ntrue in IDLE throttle pedal state, false if driver is touching the pedal\ntodo: better name for this field? -bit mightResetPid;The idea of 'mightResetPid' is to reset PID only once - each time when TPS > idlePidDeactivationTpsThreshold.\nThe throttle pedal can be pressed for a long time, making the PID data obsolete (thus the reset is required).\nWe set 'mightResetPid' to true only if PID was actually used (i.e. idlePid.getOutput() was called) to save some CPU resources.\nSee automaticIdleController(). +bit mightResetPid;idle: mightResetPid\nThe idea of 'mightResetPid' is to reset PID only once - each time when TPS > idlePidDeactivationTpsThreshold.\nThe throttle pedal can be pressed for a long time, making the PID data obsolete (thus the reset is required).\nWe set 'mightResetPid' to true only if PID was actually used (i.e. idlePid.getOutput() was called) to save some CPU resources.\nSee automaticIdleController(). bit shouldResetPid;idle: shouldResetPid bit wasResetPid;idle: wasResetPid\nThis is needed to slowly turn on the PID back after it was reset. @@ -32,7 +32,7 @@ bit isIdleCoasting;idle: coasting int targetRpmByClt;idle: target by CLT int targetRpmAcBump;idle: A/C bump -percent_t iacByRpmTaper;idle: iacByRpmTaper portion of idle +percent_t iacByRpmTaper;idle: iacByRpmTaper portion percent_t luaAdd;idle: Lua Adder diff --git a/firmware/controllers/algo/engine_state.txt b/firmware/controllers/algo/engine_state.txt index b9feed55c6..9bc9fa0211 100644 --- a/firmware/controllers/algo/engine_state.txt +++ b/firmware/controllers/algo/engine_state.txt @@ -46,11 +46,11 @@ float baroCorrection;@@GAUGE_NAME_FUEL_BARO_CORR@@ struct cranking_fuel_s -floatms_t baseFuel;Duration of injection, in ms. During cranking we do not account for injector flow, so if you change injectors you would need to change settings.\nDeprecated. Please use '1'.\nTODO: maybe account for injector flow? +floatms_t baseFuel;Fuel: base duration\nDuration of injection, in ms. During cranking we do not account for injector flow, so if you change injectors you would need to change settings.\nDeprecated. Please use '1'.\nTODO: maybe account for injector flow? float coolantTemperatureCoefficient; float tpsCoefficient float durationCoefficient -floatms_t fuel;Actual injection duration based on all above coefficients. +floatms_t fuel;Fuel: Actual injection\nduration based on all coefficients. ! end of cranking_s structure definition end_struct @@ -67,7 +67,7 @@ float postCrankingFuelCorrection float timeSinceCrankingInSecs floatms_t baseFuel; - floatms_t fuel;Actual injection duration with CLT, IAT and TPS acceleration corrections per cycle, as squirt duration.\nWithout injector lag.\n@see baseFuel\n@see actualLastInjection + floatms_t fuel;Fuel: actual\nActual injection duration with CLT, IAT and TPS acceleration corrections per cycle, as squirt duration.\nWithout injector lag.\n@see baseFuel\n@see actualLastInjection ! end of running_fuel_s structure definition end_struct @@ -78,7 +78,7 @@ running_fuel_s running ! spark-related floatms_t sparkDwell;ignition dwell duration in ms\nSee also dwellAngle - angle_t dwellAngle;ignition dwell duration as crankshaft angle\nNAN if engine is stopped\nSee also sparkDwell + angle_t dwellAngle;ignition dwell duration\nas crankshaft angle\nNAN if engine is stopped\nSee also sparkDwell int16_t autoscale cltTimingCorrection;;"deg",{1/@@PACK_MULT_PERCENT@@}, 0, -20, 20, 2 int16_t autoscale timingIatCorrection;;"deg",{1/@@PACK_MULT_PERCENT@@}, 0, -20, 20, 2 int16_t autoscale timingPidCorrection;;"deg",{1/@@PACK_MULT_PERCENT@@}, 0, -20, 20, 2 diff --git a/firmware/controllers/algo/fuel/fuel_computer.txt b/firmware/controllers/algo/fuel/fuel_computer.txt index 846f27a2b2..d8b6d953eb 100644 --- a/firmware/controllers/algo/fuel/fuel_computer.txt +++ b/firmware/controllers/algo/fuel/fuel_computer.txt @@ -7,7 +7,7 @@ struct_no_prefix fuel_computer_s ! c'mon, not the whole LiveData spaghetti for SD class? float sdTcharge_coff -float sdAirMassInOneCylinder;Speed-density logic: calculated air mass in one cylinder, in grams +float sdAirMassInOneCylinder;SD cylinder mass\nSpeed-density logic: calculated air mass in one cylinder, in grams bit sdIsTChargeAirModel diff --git a/firmware/controllers/algo/wall_fuel_state.txt b/firmware/controllers/algo/wall_fuel_state.txt index 27989c646d..5bd77f18fa 100644 --- a/firmware/controllers/algo/wall_fuel_state.txt +++ b/firmware/controllers/algo/wall_fuel_state.txt @@ -1,6 +1,6 @@ struct_no_prefix wall_fuel_state_s -float wallFuelCorrection;fuel injection time correction to account for wall wetting effect for current cycle -floatms_t wallFuel;Amount of fuel on the wall, in ms of injector open time for each injector. +float wallFuelCorrection;fuel wallwetting injection time\n correction to account for wall wetting effect for current cycle +floatms_t wallFuel;Fuel on the wall\nin ms of injector open time for each injector. ! wall_fuel_state end_struct diff --git a/firmware/controllers/engine_cycle/knock_controller.txt b/firmware/controllers/engine_cycle/knock_controller.txt index d8127b2559..607ea9e866 100644 --- a/firmware/controllers/engine_cycle/knock_controller.txt +++ b/firmware/controllers/engine_cycle/knock_controller.txt @@ -1,5 +1,5 @@ struct_no_prefix knock_controller_s - angle_t m_knockRetard;Degrees retarded: larger number = more retard + angle_t m_knockRetard;Knock Degrees retarded\nlarger number = more retard float m_knockThreshold uint32_t m_knockCount float m_maximumRetard diff --git a/firmware/integration/rusefi_config.txt b/firmware/integration/rusefi_config.txt index a7679fbb98..b53640dbc6 100644 --- a/firmware/integration/rusefi_config.txt +++ b/firmware/integration/rusefi_config.txt @@ -1875,12 +1875,12 @@ end_struct #define GAUGE_NAME_KNOCK_11 "knock 11" #define GAUGE_NAME_KNOCK_12 "knock 12" -#define GAUGE_NAME_FUEL_BARO_CORR "fuel: Barometric pressure correction" +#define GAUGE_NAME_FUEL_BARO_CORR "fuel: Barometric pressure mult" #define GAUGE_NAME_THROTTLE_PEDAL "Throttle pedal position" #define GAUGE_NAME_INJECTOR_LAG "fuel: injector lag" #define GAUGE_NAME_FUEL_TPS_ROC "fuel: TPS change" #define GAUGE_NAME_FUEL_CHARGE_TEMP "fuel: Estimated charge temperature" -#define GAUGE_NAME_FUEL_TPS_EXTRA "fuel: TPS acceleration extra fuel ms" +#define GAUGE_NAME_FUEL_TPS_EXTRA "fuel: TPS acceleration add fuel ms" #define GAUGE_NAME_FUEL_EL_EXTRA "fuel: engine load acceleration extra fuel" #define GAUGE_NAME_FUEL_CLT_CORR "fuel: CLT correction" #define GAUGE_NAME_FUEL_IAT_CORR "fuel: IAT correction"