diff --git a/firmware/console/binary/tunerstudio_outputs.h b/firmware/console/binary/tunerstudio_outputs.h index f1df359082..0f71d3f0e3 100644 --- a/firmware/console/binary/tunerstudio_outputs.h +++ b/firmware/console/binary/tunerstudio_outputs.h @@ -19,11 +19,11 @@ * todo https://github.com/rusefi/rusefi/issues/197 * three locations have to be changed manually * 1) we inherit from generated ts_outputs_s based on output_channels.txt - * 2) '[OutputChannels]' block in rusefi.input + * 2) '[OutputChannels]' block in tunerstudio.template.ini * 3) com.rusefi.core.Sensor enum in rusEFI console source code * 4) static constexpr LogField fields[] SD card logging * - * see also [OutputChannels] in rusefi.input + * see also [OutputChannels] in tunerstudio.template.ini * see also TS_OUTPUT_SIZE in rusefi_config.txt */ struct TunerStudioOutputChannels : output_channels_s { }; diff --git a/firmware/controllers/actuators/electronic_throttle.cpp b/firmware/controllers/actuators/electronic_throttle.cpp index ddfacf4f5f..83bd81eb9f 100644 --- a/firmware/controllers/actuators/electronic_throttle.cpp +++ b/firmware/controllers/actuators/electronic_throttle.cpp @@ -932,7 +932,7 @@ void doInitElectronicThrottle() { printf("doInitElectronicThrottle %s\n", boolToString(hasPedal)); #endif // EFI_UNIT_TEST - // these status flags are consumed by TS see rusefi.input TODO should those be outputs/live data not configuration?! + // these status flags are consumed by TS see tunerstudio.template.ini TODO should those be outputs/live data not configuration?! engineConfiguration->etb1configured = engineConfiguration->etb2configured = false; // todo: technical debt: we still have DC motor code initialization in ETB-specific file while DC motors are used not just as ETB diff --git a/firmware/controllers/limp_manager.h b/firmware/controllers/limp_manager.h index 78fefadb43..6b2852e713 100644 --- a/firmware/controllers/limp_manager.h +++ b/firmware/controllers/limp_manager.h @@ -4,7 +4,7 @@ #include -// Keep this list in sync with fuelIgnCutCodeList in rusefi.input! +// Keep this list in sync with fuelIgnCutCodeList in tunerstudio.template.ini! enum class ClearReason : uint8_t { None, // 0 Fatal, @@ -25,8 +25,8 @@ enum class ClearReason : uint8_t { ACR, // 16 - Harley Automatic Compression Release LambdaProtection, // 17 - // Keep this list in sync with fuelIgnCutCodeList in rusefi.input! - // todo: add a code generator between ClearReason and fuelIgnCutCodeList in rusefi.input + // Keep this list in sync with fuelIgnCutCodeList in tunerstudio.template.ini! + // todo: add a code generator between ClearReason and fuelIgnCutCodeList in tunerstudio.template.ini }; enum class TpsState : uint8_t { @@ -41,7 +41,7 @@ enum class TpsState : uint8_t { NotConfigured, Redundancy, // 9 IntermittentPps, - // keep this list in sync with etbCutCodeList in rusefi.input! + // keep this list in sync with etbCutCodeList in tunerstudio.template.ini! }; // Only allows clearing the value, but never resetting it. diff --git a/firmware/gen_config_board.sh b/firmware/gen_config_board.sh index 4a96698fed..55ac8a19db 100755 --- a/firmware/gen_config_board.sh +++ b/firmware/gen_config_board.sh @@ -51,7 +51,7 @@ java \ -initialize_to_zero false \ -signature tunerstudio/generated/signature_${SHORT_BOARDNAME}.txt \ -signature_destination generated/signature_${SHORT_BOARDNAME}.h \ - -ts_template ./tunerstudio/rusefi.input \ + -ts_template ./tunerstudio/tunerstudio.template.ini \ -ts_output_name ./tunerstudio/generated/${INI} \ -board ${BOARD_DIR} \ -prepend generated/total_live_data_generated.h \ diff --git a/firmware/integration/rusefi_config.txt b/firmware/integration/rusefi_config.txt index 61480622f2..a3e9d16cf1 100644 --- a/firmware/integration/rusefi_config.txt +++ b/firmware/integration/rusefi_config.txt @@ -4,8 +4,8 @@ ! ! The format is unique to rusEFI but there is a guide to the format available in java_tools/config_definition/RusefiConfigGrammar.g4 ! -! This file is used in combination with tunerstudio/rusefi.input to generate the .ini files used by turner TunerStudio. -! The easiest way to find a specific variable within this config is to search within rusefi.input for the on screen text from tuner studio +! This file is used in combination with tunerstudio/tunerstudio.template.ini to generate the .ini files used by turner TunerStudio. +! The easiest way to find a specific variable within this config is to search within tunerstudio.template.ini for the on screen text from tuner studio ! this should provide the actual variable name, for example searching for "Number of Cylinders" will provide the variable "cylindersCount". ! Then you can search for "cylindersCount" in this file to find the definition. ! diff --git a/firmware/rusefi.cpp b/firmware/rusefi.cpp index 9bac0bd244..7837df6037 100644 --- a/firmware/rusefi.cpp +++ b/firmware/rusefi.cpp @@ -92,7 +92,7 @@ * [Changing gauge limits](http://www.tunerstudio.com/index.php/manuals/63-changing-gauge-limits) * * Definition of the Tunerstudio configuration interface, gauges, and indicators - * tunerstudio/rusefi.input + * tunerstudio/tunerstudio.template.ini * * @section config Persistent Configuration * diff --git a/firmware/tunerstudio/readme.md b/firmware/tunerstudio/readme.md index 8ab869657e..8d2180520b 100644 --- a/firmware/tunerstudio/readme.md +++ b/firmware/tunerstudio/readme.md @@ -3,11 +3,11 @@ This directory contains the initialization and configuration files for the rusEFI interface to TunerStudio. -The primary contents are a set ```rusefi*.ini``` initialization files, used to +The primary contents are a set `rusefi*.ini` initialization files, used to configure TunerStudio to setup and monitor a specific ECU board. These are the only files a typical end user needs. -The ```translations``` directory contains non-English-language translations +The `translations` directory contains non-English-language translations for TunerStudio. In TunerStudio some fields have little question mark on the left of the name for additional field tips. @@ -17,18 +17,18 @@ The initialization files are automatically generated from a combination of input files located both in this directory and in the board-specific directories . -```rusefi*.ini``` files are generated based on the following four inputs: -1) ```rusefi_config.txt``` contains configuration region definition in proprietary text format. -2) ```rusefi.input``` contains the UI - all the menus and dialogs. UI definition starts at ```menuDialog = main``` +`rusefi*.ini` files are generated based on the following four inputs: +1) `rusefi_config.txt` contains configuration region definition in proprietary text format. +2) `tunerstudio.template.ini` contains the UI - all the menus and dialogs. UI definition starts at `menuDialog = main` line - here you will see all top level menus defined with internal IDs and visible text labels. -3) ```mapping.yaml``` is a minor detail related to how pins are named in drop downs -4) ```prepend.txt``` is a minor detail which allows you to hide elements of the UI using ```@@if_XXX``` syntax. +3) `mapping.yaml` is a minor detail related to how pins are named in drop downs +4) `prepend.txt` is a minor detail which allows you to hide elements of the UI using `@@if_XXX` syntax. The combined file is generated by ConfigDefinition.jar tool. -On Windows this may be run with ```gen_config.bat```. +On Windows this may be run with `gen_config.bat`. Q: how do I offer my changes to TS project? -A: please PR only source files (rusefi.input & rusefi_config.txt). Once merged, gen_config.bat would be executed automatically and results would be pushed by automation. +A: please PR only source files (tunerstudio.template.ini & rusefi_config.txt). Once merged, gen_config.bat would be executed automatically and results would be pushed by automation. diff --git a/firmware/tunerstudio/rusefi.input b/firmware/tunerstudio/tunerstudio.template.ini similarity index 99% rename from firmware/tunerstudio/rusefi.input rename to firmware/tunerstudio/tunerstudio.template.ini index be9b677455..00cf1f4d1a 100644 --- a/firmware/tunerstudio/rusefi.input +++ b/firmware/tunerstudio/tunerstudio.template.ini @@ -2,7 +2,7 @@ ; ; This file has been generated by invoking gen_config.bat. ; The input files are -; rusefi.input the common template +; tunerstudio.template.ini the common template ; rusefi_config.txt the project specific file ; ; In TunerStudio some fields have little question mark on the left of the name for additional field tips. diff --git a/java_tools/configuration_definition/src/main/java/com/rusefi/output/TSProjectConsumer.java b/java_tools/configuration_definition/src/main/java/com/rusefi/output/TSProjectConsumer.java index d2249cdf0b..fd65de6172 100644 --- a/java_tools/configuration_definition/src/main/java/com/rusefi/output/TSProjectConsumer.java +++ b/java_tools/configuration_definition/src/main/java/com/rusefi/output/TSProjectConsumer.java @@ -63,7 +63,7 @@ public class TSProjectConsumer implements ConfigurationConsumer { } /** - * rusefi.input has all the content of the future .ini file with the exception of data page + * tunerstudio.template.ini has all the content of the future .ini file with the exception of data page * TODO: start generating [outputs] section as well */ private TsFileContent readTsTemplateInputFile(String fileName) throws IOException { diff --git a/java_tools/configuration_definition/src/main/java/com/rusefi/trigger/TriggerWheelTSLogic.java b/java_tools/configuration_definition/src/main/java/com/rusefi/trigger/TriggerWheelTSLogic.java index a3618fb4d0..e58cedcfc8 100644 --- a/java_tools/configuration_definition/src/main/java/com/rusefi/trigger/TriggerWheelTSLogic.java +++ b/java_tools/configuration_definition/src/main/java/com/rusefi/trigger/TriggerWheelTSLogic.java @@ -47,8 +47,8 @@ public class TriggerWheelTSLogic { }); /* - * these are templated into rusefi.input file - * note that TT_TOOTHED_WHEEL is not mentioned in the meta file, we handle it manually right in rusefi.input file + * these are templated into tunerstudio.template.ini file + * note that TT_TOOTHED_WHEEL is not mentioned in the meta file, we handle it manually right in tunerstudio.template.ini file */ variableRegistry.register(TRIGGER_TYPE_WITHOUT_KNOWN_LOCATION, triggerTypesWithoutKnownLocation.toString()); variableRegistry.register(TRIGGER_TYPE_WITH_SECOND_WHEEL, triggerTypesWithSecondWheel.toString());