Search RomRaider

RomRaider

Documentation

Community

Developers



  • View Page
  • Page History/Versions
  • Print Page

Logger XML Reference Guide

The Logger definition is described by a Document Type Definition (DTD) which defines the structure and the legal elements and attributes of the Logger XML document.

The layout of the Logger definition XML provides support for multiple protocols, each defining the protocol transport options and target modules which can be logged.

To log any particular parameter of a module (ECU/TCU etc.) the parameter must be defined in one of the sections <parameters>, <switches> or <ecuparams>.

Parameters

The <parameter> element describes a well known parameter (PID) as described by the vehicle manufacturer. It is similar to an OBD-II PID definition.

A <parameter> has these attributes:

  • id
  • name
  • desc
  • ecubyteindex
  • ecubit
  • target

id = defines a unique value within the parameters group for each parameter. This value is used within a saved logging profile to identify whether the value is logged or not when loading the profile.

name = a descriptive name for the parameter. This name appears in the logging parameter list within the Logger application. It is how the parameter list is sorted and is the column name in the recorded log file when “Logging to a File”.

desc = a description of the parameter if the name is not sufficient to describe the parameter. This value along with the id form the ToolTip text seen when hovering the mouse cursor over the parameter item in the Logger parameter listing.

ecubyteindex = this byte value is the index into the Capability Bits sequence that is provide by the module or formed after initializing communications with a module to log. It is similar to the Bitwise encoded PIDs of the OBD-II protocol. The Subaru Capability Bits index map is described here. The Nissan Capability Bits index map is described here

ecubit = the bit to check in the ecubyteindex. If set (1) then the parameter that maps to this bit is supported, if not set (0) then the parameter is not supported an the Logger will exclude the parameter from the Parameter listing in the Logger GUI.

target = is a value which indicates if this parameter is supported across multiple modules. A value of 1 (ECU), 2 (TCU) or 3 (both).

A <parameter> encapsulates these elements:

  • address
  • conversions

The <address> element contains the address of the parameter in a 3-byte hexadecimal notation. For example: 0×001A6D

The <conversions> group contains <conversion> elements which provide unit, expression, formatting and min/max/step values to convert the module raw parameter data to a human readable value. Multiple conversion elements provides for options to convert a value to different units such as temperature to F or C, pressure to PSI, kPa, bar, etc.

A <conversion> element has the attributes:

  • units
  • expr
  • format
  • gauge_min
  • gauge_max
  • gauge_step



Forum

RomRaider Forums

Join our forums, the best place to find help and answers!





Donate


RomRaider is developed and supported by volunteers working on their own time. To support their efforts please consider making a donation.





Page last modified on August 05, 2021, at 09:05 AM
Powered by PmWiki