Port DIAGNOSTICS_JOBS - OBD 🛈¶
Stimulation¶
This port has no stimulus capabilities.
Properties 🛈¶
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
OBD address |
string |
OBD control unit address, e.g. 33 |
|||
Repetition on error |
0 |
int |
Number of retries upon errors during job execution. |
||
Waiting time for repetition |
0 |
int |
Waiting time (in seconds) between retries upon error during the job execution. |
Jobs 🛈¶
CheckOBDCommunication¶
Checks the connection establishment to the control unit.
ClearOBDFaultMemory¶
Deletes the fault memory.
GetOBDCalibrationInfo¶
Requests the vehicle information (SAE J1979 service/mode 09) for the InfoTypes 02 (VIN), 04 (CALID), 06 (CVN) and 0A (ECUNAME).
To read the InfoType 08 (IUMPR) the GetOBDIUMPR job can be used. For all other InfoTypes the more generic GetOBDSingleVehicleInfoData job can be used. To determine which InfoTypes are supported for service/mode 9, the GetOBDSupportedPIDs job can be used.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
ciType |
‘VIN’ |
[‘VIN’, ‘CALID’, ‘CVN’, ‘ECUNAME’] |
string |
CiType |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of dictionaries. Each dictionary contains the address of the control unit under the ‘ECU’ key and the value of the infotype read out under the ‘CalibrationInfo’ key. |
GetOBDCommunicationStatus¶
Reads OBD state of control unit.
GetOBDCurrentData¶
Requests the current powertrain diagnostic data (SAE J1979 service/mode 01) as a whole.
The GetOBDSingleCurrentData job can be used to read out the data for a single PID.
Further supported protocols: J1939, WWH-OBD
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
signalList |
string |
List of IDs to be requested, e.g. [‘01’, 02’] |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of dictionaries. Each dictionary contains the address of the control unit under the ‘ECU’ key and a list with the Current Powertrain Diagnostic data read out under the ‘CurData’ key. Elements of this list are dictionaries with the keys ‘PID’, ‘Value’, ‘Unit’ and ‘Description’. |
GetOBDFaultMemory¶
Requests the emission-related diagnostic trouble codes in state ‘confirmed’ (SAE J1979 service/mode 03), state ‘pending’ (SAE J1979 service/mode 07) and in state ‘permanent’ (SAE J1979 service/mode 0A).
Further supported protocols: WWH-OBD
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
Mode |
‘confirmed’ |
[‘confirmed’, ‘pending’, ‘permanent’] |
string |
Mode for failure memory |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of dictionaries. Each dictionary contains the ECU Id under the ‘ECU’ key and a list of DTCs under the ‘DTCs’ key. |
GetOBDFreezeFrameData¶
Requests the powertrain freeze frame data (SAE J1979 service/mode 02).
To determine which PIDs are supported for service/mode 02, the GetOBDSupportedPIDs job can be used.
Further supported protocols: J1939, WWH-OBD
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
signal |
string |
PID to be requested, e.g. 0A |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of dictionaries. Each dictionary contains the ECU Id under the ‘ECU’ key, the DTC that caused required freeze frame data storage under the ‘SAE’ key and list of freeze frame data under the ‘FreezeFrame’ key. If there are is freeze frame data stored, this list contains for each freeze frame data a dictionary containing the keys ‘PID’, ‘Value’ and ‘Unit’ otherwise the list is empty. |
GetOBDIUMPR¶
Requests the vehicle information (SAE J1979 service/mode 09) for the InfoType 08 (IUMPR) and returns its value in an interpreted manner.
Further supported protocols: WWH-OBD
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of dictionaries. Each dictionary contains the address of the ECU under the key ‘ECU’ and a list of all in-use performance tracking data read out under the key ‘UIMPR’. Elements of this list are in turn dictionaries with the keys ‘Name’, ‘Value’ and ‘Description’. |
GetOBDReadiness¶
Reads out the readiness of WWH-OBD or J1939.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
signals |
object |
Array with the values to be read (e.g. “DM05” for J1939) - list[str]. If this parameter is empty, the readiness currently selected in DiagRA is returned. |
GetOBDSingleCurrentData¶
Requests the current powertrain diagnostic data (SAE J1979 service/mode 01) for a single PID.
The GetOBDCurrentData job can be used to read out the data for all PIDs as a whole.
Further supported protocols: J1939, WWH-OBD
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
signal |
string |
PID to be requested, e.g. 0A |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of dictionaries. Each dictionary contains the address of the control unit under the ‘ECU’ key and a single-element list with the Current Powertrain Diagnostic data read out under the ‘CurData’ key. Element of this list is a dictionary with the keys ‘PID’, ‘Value’, ‘Unit’ and ‘Description’. |
GetOBDSingleTestResult¶
Requests On-Board monitoring test results for specific monitored systems (SAE J1979 service/mode 06) for a single monitor Id (MID).
The GetOBDTestResults job can be used to read out the data for all MIDs as a whole.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
signal |
string |
MID to be requested, e.g. 01 |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of dictionaries. Each dictionary contains the ECU Id under the ‘ECU’ key and the test results under the ‘TestResult’ key. The test result is a list of dictionaries where each dictionary represents a single test result containing the keys ‘MID’, ‘TestID’, ‘UnitID’, ‘Value’, ‘ValueMin’, ‘ValueMax’, ‘ValueUnit’ and ‘Description’. |
GetOBDSingleVehicleInfoData¶
Requests the vehicle information (SAE J1979 service/mode 09).
To receive the InfoType 08 (IUMPR) in an interpreted form, the GetOBDIUMPR job can be used. For the InfoTypes 02 (VIN), 04 (CALID), 06 (CVN) and 0A (ECUNAME) the GetOBDCalibrationInfo job is also available.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
signal |
string |
InfoType, which is read in service/mode 09. If the parameter is empty, currently selected values are returned. Support PID (00, 20, …) may also be used here. |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of dictionaries. Each dictionary contains the ECU Id under the ‘Ecu’ key, the requested vehicle info under the key ‘CurData’ and a textual representation of the vehicle info under the key ‘CurDataText’. The value of ‘CurData’ is a list containing dictionaries, where each dictionary represents a vehicle info with the keys ‘Name’, ‘Value’, ‘ValueUnit’ and ‘Description’. |
GetOBDSupportedPIDs¶
Provides information about the supported PIDs of a mode.
Further supported protocols: WWH-OBD
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
modeNo |
‘1’ |
[‘1’, ‘2’, ‘3’, ‘4’, ‘5’, ‘6’, ‘7’, ‘8’, ‘9’] |
string |
Service/mode for which the supported PIDs are to be determined |
|
modulName |
string |
Module name for ECU name (e.g. ‘E8’) |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of dictionaries. Each dictionary represents a supported PID. It contains the PID number under the ‘PID’ key and it`s description under the ‘Value’ key. |
GetOBDTestResults¶
Requests On-Board monitoring test results for specific monitored systems (SAE J1979 service/mode 06) for multiple monitor Ids.
The GetOBDSingleTestResult job can be used to read out the data for a single monitor Id (MID).
Further supported protocols: J1939
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
signalList |
string |
List of IDs to be requested, e.g. [‘01’, 02’] |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
List of dictionaries. Each dictionary contains the ECU Id under the ‘ECU’ key and the test results under the ‘TestResult’ key. The test result is a list of dictionaries where each dictionary represents a single test result containing the keys ‘MID’, ‘TestID’, ‘UnitID’, ‘Value’, ‘ValueMin’, ‘ValueMax’, ‘ValueUnit’ and ‘Description’. |
GetOBDTracking¶
Returns Engine Run Time Tracking for WWH-OBD or J1939.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
signals |
object |
Array with the desired values - list[str]. If the parameter is empty, currently selected values are returned. |
GetOBDVehicleInfo¶
Reads out vehicle information using WWH-OBD or J1939.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
signals |
object |
Array with the identifiers to be read. - list[str]. |
GetWWHOBDFaultMemory¶
This function is used to read fault memory under ISO 27145. Signals is a list with the short names of the desired error types as found in DiagRA D on page J1939/ISO27145 under error codes.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
signals |
[] |
object |
Array with data to be read - list[str] |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
Liste von Fehlern aus den Steuergeräten. |
SendOBDHexServiceT¶
Sends an OBD Hex Service and returns the response of the ECUs, only supported for J1979.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
sendData |
object |
SendData as ByteStream, hex string or byte list. Consists of service number (SID) and parameter(s). |
StartOBDCommunication¶
Manual start of communication with the control unit.
StopOBDCommunication¶
Manual stop of communication with the control unit.