cherry pick rename rusefi.input #391

This commit is contained in:
Matthew Kennedy 2024-03-24 22:49:36 -07:00
parent 7cd7798e7b
commit ebe78cbb4b
10 changed files with 24 additions and 24 deletions

View File

@ -19,11 +19,11 @@
* todo https://github.com/rusefi/rusefi/issues/197 * todo https://github.com/rusefi/rusefi/issues/197
* three locations have to be changed manually * three locations have to be changed manually
* 1) we inherit from generated ts_outputs_s based on output_channels.txt * 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 * 3) com.rusefi.core.Sensor enum in rusEFI console source code
* 4) static constexpr LogField fields[] SD card logging * 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 * see also TS_OUTPUT_SIZE in rusefi_config.txt
*/ */
struct TunerStudioOutputChannels : output_channels_s { }; struct TunerStudioOutputChannels : output_channels_s { };

View File

@ -932,7 +932,7 @@ void doInitElectronicThrottle() {
printf("doInitElectronicThrottle %s\n", boolToString(hasPedal)); printf("doInitElectronicThrottle %s\n", boolToString(hasPedal));
#endif // EFI_UNIT_TEST #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; 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 // todo: technical debt: we still have DC motor code initialization in ETB-specific file while DC motors are used not just as ETB

View File

@ -4,7 +4,7 @@
#include <cstdint> #include <cstdint>
// 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 { enum class ClearReason : uint8_t {
None, // 0 None, // 0
Fatal, Fatal,
@ -25,8 +25,8 @@ enum class ClearReason : uint8_t {
ACR, // 16 - Harley Automatic Compression Release ACR, // 16 - Harley Automatic Compression Release
LambdaProtection, // 17 LambdaProtection, // 17
// Keep this list in sync with 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 rusefi.input // todo: add a code generator between ClearReason and fuelIgnCutCodeList in tunerstudio.template.ini
}; };
enum class TpsState : uint8_t { enum class TpsState : uint8_t {
@ -41,7 +41,7 @@ enum class TpsState : uint8_t {
NotConfigured, NotConfigured,
Redundancy, // 9 Redundancy, // 9
IntermittentPps, 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. // Only allows clearing the value, but never resetting it.

View File

@ -51,7 +51,7 @@ java \
-initialize_to_zero false \ -initialize_to_zero false \
-signature tunerstudio/generated/signature_${SHORT_BOARDNAME}.txt \ -signature tunerstudio/generated/signature_${SHORT_BOARDNAME}.txt \
-signature_destination generated/signature_${SHORT_BOARDNAME}.h \ -signature_destination generated/signature_${SHORT_BOARDNAME}.h \
-ts_template ./tunerstudio/rusefi.input \ -ts_template ./tunerstudio/tunerstudio.template.ini \
-ts_output_name ./tunerstudio/generated/${INI} \ -ts_output_name ./tunerstudio/generated/${INI} \
-board ${BOARD_DIR} \ -board ${BOARD_DIR} \
-prepend generated/total_live_data_generated.h \ -prepend generated/total_live_data_generated.h \

View File

@ -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 ! 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. ! 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 rusefi.input for the on screen text from tuner studio ! 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". ! 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. ! Then you can search for "cylindersCount" in this file to find the definition.
! !

View File

@ -92,7 +92,7 @@
* [Changing gauge limits](http://www.tunerstudio.com/index.php/manuals/63-changing-gauge-limits) * [Changing gauge limits](http://www.tunerstudio.com/index.php/manuals/63-changing-gauge-limits)
* *
* Definition of the Tunerstudio configuration interface, gauges, and indicators * Definition of the Tunerstudio configuration interface, gauges, and indicators
* tunerstudio/rusefi.input * tunerstudio/tunerstudio.template.ini
* *
* @section config Persistent Configuration * @section config Persistent Configuration
* *

View File

@ -3,11 +3,11 @@
This directory contains the initialization and configuration files for the This directory contains the initialization and configuration files for the
rusEFI interface to TunerStudio. 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 configure TunerStudio to setup and monitor a specific ECU board. These are
the only files a typical end user needs. 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. for TunerStudio.
In TunerStudio some fields have little question mark on the left of the name for additional field tips. 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 of input files located both in this directory and in the board-specific
directories . directories .
```rusefi*.ini``` files are generated based on the following four inputs: `rusefi*.ini` files are generated based on the following four inputs:
1) ```rusefi_config.txt``` contains configuration region definition in proprietary text format. 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``` 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. 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 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. 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. 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? 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.

View File

@ -2,7 +2,7 @@
; ;
; This file has been generated by invoking gen_config.bat. ; This file has been generated by invoking gen_config.bat.
; The input files are ; The input files are
; rusefi.input the common template ; tunerstudio.template.ini the common template
; rusefi_config.txt the project specific file ; 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. ; In TunerStudio some fields have little question mark on the left of the name for additional field tips.

View File

@ -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 * TODO: start generating [outputs] section as well
*/ */
private TsFileContent readTsTemplateInputFile(String fileName) throws IOException { private TsFileContent readTsTemplateInputFile(String fileName) throws IOException {

View File

@ -47,8 +47,8 @@ public class TriggerWheelTSLogic {
}); });
/* /*
* these are templated into 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 rusefi.input 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_WITHOUT_KNOWN_LOCATION, triggerTypesWithoutKnownLocation.toString());
variableRegistry.register(TRIGGER_TYPE_WITH_SECOND_WHEEL, triggerTypesWithSecondWheel.toString()); variableRegistry.register(TRIGGER_TYPE_WITH_SECOND_WHEEL, triggerTypesWithSecondWheel.toString());