FOME-Tech
/
fome-fw
mirror of https://github.com/FOME-Tech/fome-fw.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
fome-fw/firmware/tunerstudio
History
GitHub gen-configs Action bd1999632b Auto-generated configs and docs 2024-04-12 09:10:27 +00:00
..
generated Auto-generated configs and docs 2024-04-12 09:10:27 +00:00
.gitignore
…
readme.md cherry pick rename rusefi.input #391 2024-03-24 22:49:36 -07:00
tunerstudio.template.ini make TS a little happier 2024-04-02 14:31:55 -07:00
upload_ini.sh rusefi online does not have .ini for f407 discovery previously known as all or default #5091 2023-02-16 18:46:54 -05:00

readme.md

TunerStudio (TS)

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.

In TunerStudio some fields have little question mark on the left of the name for additional field tips. Those tips are defined in ../integration/rusefi_config.txt

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 source files (tunerstudio.template.ini & rusefi_config.txt). Once merged, gen_config.bat would be executed automatically and results would be pushed by automation.