rusefi/firmware/tunerstudio
GitHub gen-configs Action 3053edf5a7 Auto-generated configs and docs 2024-11-18 15:22:03 +00:00
..
generated Auto-generated configs and docs 2024-11-18 15:22:03 +00:00
.gitignore
empty_board_options.ini
readme.md only:docs 2024-08-28 21:06:03 -04:00
tunerstudio.template.ini Implement `Secondary injector flow compensation mode` and `Secondary injector reference pressure` settings #6972 (#7079) 2024-11-18 10:11:57 -05:00
upload_ini.sh only:INI_DESTINATION_FOLDER 2024-05-31 14:46:26 -04:00

readme.md

TunerStudio

For TS Protocol details see https://www.tunerstudio.com/index.php/support/manuals/tsdevmanuals/137-ecu-definition-specification-aka-the-ini-document

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 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 for TunerStudio.

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. 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.

The combined file is generated by ConfigDefinition.jar tool. On Windows this may be run with gen_config.bat.

Q: how do I offer my changes to TS project?

A: please PR only tunerstudio.template.ini. Once merged, gen_config.bat would be executed automatically and results would be pushed by automation.