fome-fw/firmware/integration/LiveData.yaml

#
# Here we facilitate monitoring by exposing model/transfer object of each individual controller. While some entries are only
# useful for monitoring the big idea is to bring calculation and monitoring as close to each other as possible by exposing
# many calculation fields directly
#
# here we have LiveData configuration file
# entry format, where 'key' is a unique ID:
# key: [NameOfJavaToGenerate.java, folder_where_key.txt_is located, (optional advanced options)]
# Naming convention: top level struct in .txt file should be called key_s
# at the moment new line would need to be added into StateDictionary.java manually todo: Add code generation of StateDictionary.java
#
# see gen_live_documentation.sh which is the main generation script
# todo: what is sequence of events in terms of 'live_data_e' code generation?
#
Usages:
#  output_channels always goes first at least because it has protocol version at well-known offset
  - name: output_channels
    java: TsOutputs.java
    folder: console/binary
    prepend: integration/rusefi_config_shared.txt
    constexpr: "engine->outputChannels"

  - name: fuel_computer
    folder: controllers/algo/fuel
    prepend: integration/rusefi_config_shared.txt
    constexpr: "engine->fuelComputer"

  - name: ignition_state
    folder: controllers/algo
    prepend: integration/rusefi_config_shared.txt
    constexpr: "engine->ignitionState"

  - name: knock_controller
    folder: controllers/engine_cycle
    prepend: integration/rusefi_config_shared.txt
    output_name: knock
    constexpr: "___engine.module<KnockController>()"
    isPtr: true

  - name: high_pressure_fuel_pump
    folder: controllers/engine_cycle
    output_name: hpfp

  - name: injector_model
    folder: controllers/algo/fuel
    prepend: integration/rusefi_config_shared.txt
    # constexpr: "___engine.module<InjectorModel>()"
    # isPtr: true

  - name: launch_control_state
    folder: controllers/algo

  - name: antilag_system_state
    folder: controllers/algo
    prepend: integration/rusefi_config_shared.txt
    output_name: als

  - name: boost_control
    folder: controllers/actuators
    prepend: integration/rusefi_config_shared.txt
    output_name: boost
    constexpr: "___engine.module<BoostController>()"
    isPtr: true
    conditional_compilation: "EFI_BOOST_CONTROL"

  - name: ac_control
    folder: controllers/actuators
    prepend: integration/rusefi_config_shared.txt
    output_name: ac

  - name: fan_control
    folder: controllers/actuators
    output_name: [ "fan1", "fan2" ]
    constexpr: "___engine.module<FanControl1>()"
    isPtr: true

  - name: fuel_pump_control
    folder: controllers/actuators
    output_name: fuelPump

  - name: main_relay
    folder: controllers/actuators
    output_name: mainRelay

  #todo: handle ETB pid and Idle pid which point at same pid_state.txt
  # - name: pid_state
  #   folder: util/math

  - name: engine_state
    folder: controllers/algo
    prepend: integration/rusefi_config_shared.txt
    constexpr: "engine->engineState"

  - name: tps_accel_state
    folder: controllers/algo
    prepend: integration/rusefi_config_shared.txt

  - name: trigger_central
    folder: controllers/trigger
    withCDefines: true
    constexpr: "engine->triggerCentral"
    conditional_compilation: "EFI_SHAFT_POSITION_INPUT"

  - name: trigger_state
    folder: controllers/trigger
    prepend: integration/rusefi_config_shared.txt
    output_name: [ "trg", "vvt1i", "vvt1e", "vvt2i", "vvt2e" ]

  - name: trigger_state_primary
    folder: controllers/trigger
    prepend: integration/rusefi_config_shared.txt

  - name: wall_fuel_state
    folder: controllers/algo

  - name: idle_state
    folder: controllers/actuators
    prepend: integration/rusefi_config_shared.txt
    output_name: idle

  - name: electronic_throttle
    folder: controllers/actuators
    prepend: integration/rusefi_config_shared.txt
    output_name: [ "etb1", "etb2" ]

  - name: wideband_state
    folder: controllers/sensors/
    output_name: [ "wb1", "wb2" ]

  - name: dc_motors
    folder: controllers/actuators
    prepend: integration/rusefi_config_shared.txt
    constexpr: "engine->dc_motors"

  - name: sent_state
    folder: controllers/sensors
    prepend: integration/rusefi_config_shared.txt

  - name: throttle_model
    folder: controllers/math
    output_name: throttle_model

  - name: vvt
    folder: controllers/actuators
    constexpr: "___engine.module<VvtController1>()"
    isPtr: true
    conditional_compilation: "EFI_VVT_PID"

  - name: lambda_monitor
    folder: controllers/math
    constexpr: "___engine.lambdaMonitor"
docs 2022-04-13 14:29:44 -07:00			`#`
docs 2022-04-23 06:29:58 -07:00			`# Here we facilitate monitoring by exposing model/transfer object of each individual controller. While some entries are only`
			`# useful for monitoring the big idea is to bring calculation and monitoring as close to each other as possible by exposing`
			`# many calculation fields directly`
			`#`
docs 2022-04-13 14:29:44 -07:00			`# here we have LiveData configuration file`
docs 2022-04-23 06:29:58 -07:00			`# entry format, where 'key' is a unique ID:`
docs 2022-04-22 19:48:07 -07:00			`# key: [NameOfJavaToGenerate.java, folder_where_key.txt_is located, (optional advanced options)]`
			`# Naming convention: top level struct in .txt file should be called key_s`
docs 2022-04-22 19:54:53 -07:00			`# at the moment new line would need to be added into StateDictionary.java manually todo: Add code generation of StateDictionary.java`
docs 2022-04-22 19:48:07 -07:00			`#`
			`# see gen_live_documentation.sh which is the main generation script`
			`# todo: what is sequence of events in terms of 'live_data_e' code generation?`
docs 2022-04-13 14:29:44 -07:00			`#`
LiveData source files list is now defined in yaml format 2019-08-31 19:54:45 -07:00			`Usages:`
totalFuel and totalIgnition correction gauges in Tunerstudio #4955 2023-01-15 03:26:22 -08:00			`# output_channels always goes first at least because it has protocol version at well-known offset`
			`- name: output_channels`
			`java: TsOutputs.java`
			`folder: console/binary`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
totalFuel and totalIgnition correction gauges in Tunerstudio #4955 2023-01-15 03:26:22 -08:00			`constexpr: "engine->outputChannels"`

totalFuel and totalIgnition correction gauges in Tunerstudio #4955 2023-01-14 20:00:28 -08:00			`- name: fuel_computer`
			`folder: controllers/algo/fuel`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
totalFuel and totalIgnition correction gauges in Tunerstudio #4955 2023-01-14 20:00:28 -08:00			`constexpr: "engine->fuelComputer"`

totalFuel and totalIgnition correction gauges in Tunerstudio #4955 2023-01-15 05:26:08 -08:00			`- name: ignition_state`
totalFuel and totalIgnition correction gauges in Tunerstudio #4955 2023-01-14 20:00:28 -08:00			`folder: controllers/algo`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
totalFuel and totalIgnition correction gauges in Tunerstudio #4955 2023-01-15 05:26:08 -08:00			`constexpr: "engine->ignitionState"`
totalFuel and totalIgnition correction gauges in Tunerstudio #4955 2023-01-14 20:00:28 -08:00
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00			`- name: knock_controller`
			`folder: controllers/engine_cycle`
knock live data (#261) * Move knock data to knock controller * appease tsConfigVersion * make reapply logic easier to read 2023-09-25 11:06:48 -07:00			`prepend: integration/rusefi_config_shared.txt`
Write output channels with new parser (#4219) * let the new parser run * s * support for output channels * usages reader uses new parser for output channels * better debugging configuration * bad merge * test it a bit too * more tests * copy/paste the same content from other file * s * fix bugs where even the existing logic tries to write as an enum (?) * jar * print stream always unix * print stream always unix * use typedefs correctly * jar * stub support for multiple of each type * s * s * name some more datas 2022-06-19 06:52:23 -07:00			`output_name: knock`
knock live data (#261) * Move knock data to knock controller * appease tsConfigVersion * make reapply logic easier to read 2023-09-25 11:06:48 -07:00			`constexpr: "___engine.module<KnockController>()"`
			`isPtr: true`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
			`- name: high_pressure_fuel_pump`
			`folder: controllers/engine_cycle`
Write output channels with new parser (#4219) * let the new parser run * s * support for output channels * usages reader uses new parser for output channels * better debugging configuration * bad merge * test it a bit too * more tests * copy/paste the same content from other file * s * fix bugs where even the existing logic tries to write as an enum (?) * jar * print stream always unix * print stream always unix * use typedefs correctly * jar * stub support for multiple of each type * s * s * name some more datas 2022-06-19 06:52:23 -07:00			`output_name: hpfp`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
			`- name: injector_model`
			`folder: controllers/algo/fuel`
live data injector model 2023-07-01 20:51:01 -07:00			`prepend: integration/rusefi_config_shared.txt`
not sure why injector model makes only sim unhappy 2023-07-01 23:01:53 -07:00			`# constexpr: "___engine.module<InjectorModel>()"`
			`# isPtr: true`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
			`- name: launch_control_state`
			`folder: controllers/algo`

TurboMarian is the ALS boss 2022-12-16 15:48:59 -08:00			`- name: antilag_system_state`
			`folder: controllers/algo`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
TurboMarian is the ALS boss 2022-12-16 15:48:59 -08:00			`output_name: als`

use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00			`- name: boost_control`
			`folder: controllers/actuators`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
Write output channels with new parser (#4219) * let the new parser run * s * support for output channels * usages reader uses new parser for output channels * better debugging configuration * bad merge * test it a bit too * more tests * copy/paste the same content from other file * s * fix bugs where even the existing logic tries to write as an enum (?) * jar * print stream always unix * print stream always unix * use typedefs correctly * jar * stub support for multiple of each type * s * s * name some more datas 2022-06-19 06:52:23 -07:00			`output_name: boost`
boost is engine module 2023-09-07 12:41:56 -07:00			`constexpr: "___engine.module<BoostController>()"`
			`isPtr: true`
helping kinetis 2023-01-16 13:39:08 -08:00			`conditional_compilation: "EFI_BOOST_CONTROL"`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
			`- name: ac_control`
			`folder: controllers/actuators`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
Write output channels with new parser (#4219) * let the new parser run * s * support for output channels * usages reader uses new parser for output channels * better debugging configuration * bad merge * test it a bit too * more tests * copy/paste the same content from other file * s * fix bugs where even the existing logic tries to write as an enum (?) * jar * print stream always unix * print stream always unix * use typedefs correctly * jar * stub support for multiple of each type * s * s * name some more datas 2022-06-19 06:52:23 -07:00			`output_name: ac`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
			`- name: fan_control`
			`folder: controllers/actuators`
Write output channels with new parser (#4219) * let the new parser run * s * support for output channels * usages reader uses new parser for output channels * better debugging configuration * bad merge * test it a bit too * more tests * copy/paste the same content from other file * s * fix bugs where even the existing logic tries to write as an enum (?) * jar * print stream always unix * print stream always unix * use typedefs correctly * jar * stub support for multiple of each type * s * s * name some more datas 2022-06-19 06:52:23 -07:00			`output_name: [ "fan1", "fan2" ]`
fan control is engine module (#203) * fan is engine module * mockable AC * mockable AC * mock AC controller in fan test * constexpr fan livedata * isPtr 2023-07-21 01:28:25 -07:00			`constexpr: "___engine.module<FanControl1>()"`
			`isPtr: true`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
			`- name: fuel_pump_control`
			`folder: controllers/actuators`
Write output channels with new parser (#4219) * let the new parser run * s * support for output channels * usages reader uses new parser for output channels * better debugging configuration * bad merge * test it a bit too * more tests * copy/paste the same content from other file * s * fix bugs where even the existing logic tries to write as an enum (?) * jar * print stream always unix * print stream always unix * use typedefs correctly * jar * stub support for multiple of each type * s * s * name some more datas 2022-06-19 06:52:23 -07:00			`output_name: fuelPump`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
			`- name: main_relay`
			`folder: controllers/actuators`
Write output channels with new parser (#4219) * let the new parser run * s * support for output channels * usages reader uses new parser for output channels * better debugging configuration * bad merge * test it a bit too * more tests * copy/paste the same content from other file * s * fix bugs where even the existing logic tries to write as an enum (?) * jar * print stream always unix * print stream always unix * use typedefs correctly * jar * stub support for multiple of each type * s * s * name some more datas 2022-06-19 06:52:23 -07:00			`output_name: mainRelay`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
Live Data progress 2022-01-06 12:20:58 -08:00			`#todo: handle ETB pid and Idle pid which point at same pid_state.txt`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00			`# - name: pid_state`
			`# folder: util/math`

			`- name: engine_state`
			`folder: controllers/algo`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
SD card log fields list should be auto-generated #3985 2022-10-26 19:07:24 -07:00			`constexpr: "engine->engineState"`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
			`- name: tps_accel_state`
			`folder: controllers/algo`
TPS AE log cleanup 2023-05-05 02:34:48 -07:00			`prepend: integration/rusefi_config_shared.txt`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
			`- name: trigger_central`
			`folder: controllers/trigger`
			`withCDefines: true`
SD card log fields list should be auto-generated #3985 2022-10-28 07:28:38 -07:00			`constexpr: "engine->triggerCentral"`
prep for small can board 2023-08-29 00:57:57 -07:00			`conditional_compilation: "EFI_SHAFT_POSITION_INPUT"`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00
			`- name: trigger_state`
			`folder: controllers/trigger`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00			`output_name: [ "trg", "vvt1i", "vvt1e", "vvt2i", "vvt2e" ]`

log the state of hasSynchronizedPhase() (#4478) * s * log whether we've synced phase * trigger_state_primary * need that file * engine state is not the right spot 2022-08-24 15:11:05 -07:00			`- name: trigger_state_primary`
			`folder: controllers/trigger`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
log the state of hasSynchronizedPhase() (#4478) * s * log whether we've synced phase * trigger_state_primary * need that file * engine state is not the right spot 2022-08-24 15:11:05 -07:00
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00			`- name: wall_fuel_state`
			`folder: controllers/algo`

			`- name: idle_state`
			`folder: controllers/actuators`
idle data 2023-05-05 12:48:38 -07:00			`prepend: integration/rusefi_config_shared.txt`
use yaml like you're supposed to (#4233) * use yaml like you're supposed to * parse output names (but don't use it yet) 2022-06-02 22:02:16 -07:00			`output_name: idle`

			`- name: electronic_throttle`
			`folder: controllers/actuators`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
Write output channels with new parser (#4219) * let the new parser run * s * support for output channels * usages reader uses new parser for output channels * better debugging configuration * bad merge * test it a bit too * more tests * copy/paste the same content from other file * s * fix bugs where even the existing logic tries to write as an enum (?) * jar * print stream always unix * print stream always unix * use typedefs correctly * jar * stub support for multiple of each type * s * s * name some more datas 2022-06-19 06:52:23 -07:00			`output_name: [ "etb1", "etb2" ]`
wideband live data (#4276) * wideband live data magic * test build happy * test even happier 2022-06-23 17:04:26 -07:00
			`- name: wideband_state`
			`folder: controllers/sensors/`
			`output_name: [ "wb1", "wb2" ]`
Nick wonders if DC wastegate is still FUBAR #5075 2023-02-13 15:01:54 -08:00
			`- name: dc_motors`
			`folder: controllers/actuators`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
Native SENT TPS input #5079 2023-02-14 16:54:22 -08:00			`constexpr: "engine->dc_motors"`

			`- name: sent_state`
stub vvt live data 2023-07-01 21:08:50 -07:00			`folder: controllers/sensors`
use shared txt instead of parsing full rusefi_config (#59) 2023-03-02 11:52:36 -08:00			`prepend: integration/rusefi_config_shared.txt`
stub vvt live data 2023-07-01 21:08:50 -07:00
happy java tests 2023-07-01 21:45:50 -07:00			`- name: throttle_model`
			`folder: controllers/math`
			`output_name: throttle_model`

stub vvt live data 2023-07-01 21:08:50 -07:00			`- name: vvt`
			`folder: controllers/actuators`
vvt is engine module (#202) * vvt refactoring * vvt constexpr livedata * format * fix null deref 2023-07-19 22:16:29 -07:00			`constexpr: "___engine.module<VvtController1>()"`
			`isPtr: true`
refactoring: vvt is not aux (#263) * refactoring: vvt is not aux (cherry picked from commit 6b4c4a583316a32d7723c2cfa16cda39fa9afb1b) * this repo has VVT conditional at small-can-board 2023-09-27 00:59:04 -07:00			`conditional_compilation: "EFI_VVT_PID"`
lambda monitor live data 2023-07-25 23:59:00 -07:00
			`- name: lambda_monitor`
			`folder: controllers/math`
			`constexpr: "___engine.lambdaMonitor"`