rusefi/firmware/tunerstudio
GitHub gen-configs Action b984c5e350 Auto-generated configs and docs 2024-05-02 13:36:49 +00:00
..
generated Auto-generated configs and docs 2024-05-02 13:36:49 +00:00
.gitignore
empty_board_options.ini default empty board_options.ini https://github.com/rusefi/rusefi/issues/6352 2024-04-17 23:07:13 -04:00
readme.md better file name to actually reflect what the content is about 2024-03-25 23:31:49 -04:00
tunerstudio.template.ini only: if_ts_show_top_level_can_menu 2024-05-02 09:27:13 -04:00
upload_ini.sh how about using sftp without ssh? 2024-04-19 10:22:34 -04:00

readme.md

TunerStudio

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.