API Dokumentation
API Dokumentation
void
actuatorDiagnostics2Init(IConnectio
nHandle connectionHandle,
List<IDiagDescriptor2WithParametersA
ndMeasureme
nts> actuators, 62
List<IDiagMeasurementDescriptor>
measurements)
38
Opens a diagnostic connection to the control unit
specified by the address.
IDiagResultConnectEcu
connectToEcuAndOpenConnection(int
ecuAddress)
26
Conveniant method to check the availability of the
web service.
void
enableTransportMode()
84
Deactivation of a vehicle in order to minimize
energy consumption.
List<IDiagResultStatus>
engineGroupCheck()
12
Starts the engine group diagnosis check for 6
the setting specified in enginGroupInit.
List<IDiagResultStatus>
engineGroupStart()
12
Starts the engine group diagnosis for 6
the setting specified in enginGroupInit.
List<IDiagResultStatus>
engineGroupStop()
12
Stops the engine group diagnosis for: 7
the setting specified in enginGroupInit.
List<IDiagResultStatus>
engineGroupSwitch() 12
Switches the mode of operation for engine group.
6
void
enginGroupInit(String basicSettingName)
12
Initializes the engine diagnosis with the specified 5
settings.
boolean
executeMacro(String macroName)
12
Executes a macro.
8
void
exit()
28
Returns immediately and closes the application in
a separate thread.
String
exportDevEventMemorySnapshots(IConn
ectionHandle connectionHandle, List<String>
memorySelections, String targetFilePath)
34
Exportes the snapshot records of all developer dtc
event codes from the selected control unit into the
specified target file.
String
exportEventMemorySnapshots(IConnect
ionHandle connectionHandle, String
targetFilePath)
32
Exportes the snapshot records of all dtc event
codes from the selected control unit into the specified
target file.
IDiagResultFlashSession
flashProgramming(IConnectionHandle
connectionHandle, String containerFileName,
String sessionName, Boolean
checkSessionWithEcu)
86
11
Gets the default values of all communication
parameters for the specified logical link from the odx
7
database.
List<IDoIPVCI>
getDoIPVCIs() 12
Gets the current DoIP VCIs without refreshing.
1
String[]
getFlashSessions(IConnectionHandle
connectionHandle, String containerFileName,
Boolean checkSessionWithEcu)
89
Returns the names of all flash sessions contained
in the specified flash container.
List<IConnectionHandle>
getLockedConnections() 12
Returns currently locked connections.
0
Integer
getNumberOfDevEventMemorySnapshots(
IConnectionH
andle connectionHandle, List<String>
memorySelections, Integer eventCode) 34
Determines the number of existing snapshot
records for the specified developer dtc event code and
selected control unit.
Integer
getNumberOfEventMemorySnapshots(ICo
nnectionHand
le connectionHandle, Integer eventCode)
31
Determines the number of existing snapshot
records for the specified dtc event code and selected
control unit.
List<IDiagResultODXVersion>
getODXVersions()
82
Returns a list of all MCD projects with project
information of the current project path.
List<Integer>
getProjectEcuAddressList()
53
Retrieves a list holding the addresses of all control
units in the current project.
List<String>
getShortNamesOfAccessModes(IConnect
ionHandle connectionHandle)
53
Returns the ODX-ShortNames of all available
access modes for UDS control units.
List<String>
getShortNamesOfActuators(IConnectio
nHandle connectionHandle)
67
Returns the ODX short names of all available
actuators from the currently selected control unit.
List<String>
getShortNamesOfAdaptationChannels(I
ConnectionHa
ndle connectionHandle) 58
Returns the ODX short names of all available
adaptation channels for UDS control units.
List<String>
getShortNamesOfAdaptationValues(ICo
nnectionHand
le connectionHandle, String adaptationChannel) 59
81
Setting the API trace level for all diagnostic
functions.
void
setVehicleProject(String projectName)
52
Sets and loads the vehicle project for the
diagnostic interface.
String
setVehicleProjectAutomatic(IConnection
Interface
.PROJECT_MODE projectMode)
53
Determines the project for the current vin
automatically.
void
startProtocol() 12
Starts protocol.
7
void
stopProtocol() 12
Stops protocol.
7
IDiagResult
switchSession(IConnectionHandle
connectionHandle, String session)
Method Detail
echo
public String echo(String text)
Conveniant method to check the availability of the web service. The method writes the text into the trace
file. If the web service is running one can check the trace file for the written text.
Parameters:
Returns:
getAutomationApiVersion
public String getAutomationApiVersion()
Returns:
updateGatewayComponentList
public void updateGatewayComponentList()
throws DiagException
Updates the gateway component list of all busmasters (only for macro api).
Throws:
readEventMemories
public List<IDiagResultEventMemory> readEventMemories(List<Integer> controlUnitList,
List<String> adaptationPresets,
List<String> measurementPresets,
List<String> identificationPresets,
List<String> additionalPresets)
throws DiagException
Reads the event memory entries of the specified control unit list. If the unit list is null or empty, then all
available control units are read. In addition, measurements and adaptations can be defined for reading.
Parameters:
Returns:
Throws:
readAllEventMemories
public List<IDiagResultEventMemory> readAllEventMemories()
throws DiagException
Reads the event memories of all conrol units in the vehicle. Only control units which have events are part
of the result. Closes all connections after running.
Returns:
Throws:
exit
public void exit()
Returns immediately and closes the application in a separate thread. This might take some seconds. So
there is a period of time between the return of the exit method and the shutdown.
Reads the event memories from the selected control unit including all environmental conditions.
Parameters:
Returns:
Throws:
readEventMemoryWithMask
public IDiagResultEventMemory readEventMemoryWithMask(IConnectionHandle connectionHandle,
long dtcStatusMask,
Boolean readSnapshotRecords)
throws DiagException
Reads the event memories from the selected control unit including all environmental conditions. For UDS
control units only the event memories with the specified status mask will be read. The mask parameter
does not effect KWP control units. In addition, the reading of the snapshot records can be activated via the
parameter readSnapshotRecord.
Parameters:
dtcStatusMask - Specifies the status of the event memories which will be read.
Returns:
Throws:
readEventMemory
public IDiagResultEventMemory readEventMemory(IConnectionHandle connectionHandle,
long dtcStatusMask)
throws DiagException
Reads the event memories from the selected control unit including all environmental conditions. For UDS
control units only the event memories with the specified status mask will be read. The mask parameter
does not effect KWP control units.
Parameters:
dtcStatusMask - Specifies the status of the event memories which will be read.
Returns:
Throws:
readEventMemoryWithMask
public IDiagResultEventMemory readEventMemoryWithMask(IConnectionHandle connectionHandle,
long dtcStatusMask)
throws DiagException
Reads the event memories from the selected control unit including all environmental conditions. For UDS
control units only the event memories with the specified status mask will be read. The mask parameter
does not effect KWP control units.
Parameters:
dtcStatusMask - Specifies the status of the event memories which will be read.
Returns:
Throws:
readEventMemorySnapshots
public IDiagResultDtcSnapshotList readEventMemorySnapshots( IConnectionHandle connectionHandle
,
Integer eventCode)
throws DiagException
Reads all snapshot records for the specified dtc event code from the selected control unit.
Parameters:
Returns:
Throws:
readEventMemorySnapshot
public IDiagResultDtcSnapshot readEventMemorySnapshot(IConnectionHandle connectionHandle,
Integer eventCode,
Integer snapshotRecordNumber)
throws DiagException
Reads the specific snapshot record for the specified snapshot record number and dtc event code from the
selected control unit.
Parameters:
Returns:
Throws:
getNumberOfEventMemorySnapshots
public Integer getNumberOfEventMemorySnapshots( IConnectionHandle connectionHandle,
Integer eventCode)
throws DiagException
Determines the number of existing snapshot records for the specified dtc event code and selected control
unit.
Parameters:
Returns:
Throws:
exportEventMemorySnapshots
public String exportEventMemorySnapshots( IConnectionHandle connectionHandle,
String targetFilePath)
throws DiagException
Exportes the snapshot records of all dtc event codes from the selected control unit into the specified target
file. If the file exists, then this file is overwritten.
Parameters:
Returns:
Throws:
readAvailableDevEventMemorySelection
public List<String> readAvailableDevEventMemorySelection( IConnectionHandle connectionHandle)
throws DiagException
Reads the available memory selections for developer event memories from the selected control unit.
Parameters:
Returns:
readDevEventMemory
public IDiagResultEventMemory readDevEventMemory( IConnectionHandle connectionHandle,
List<String> memorySelections,
Long dtcStatusMask,
Boolean readSnapshotRecord)
throws DiagException
Reads the developer event memories from the selected control unit including all environmental conditions.
For UDS control units only the event memories with the specified status mask will be read. The mask
parameter does not effect KWP control units.
Parameters:
memorySelections - the memory selections. If empty, all available memory selections will be used.
dtcStatusMask - Specifies the status of the event memories which will be read.
Returns:
Throws:
readDevEventMemorySnapshots
public IDiagResultDtcSnapshotList readDevEventMemorySnapshots(IConnectionHandle connectionHand
le,
List<String> memorySelections,
Integer eventCode)
throws DiagException
Reads all snapshot records for the specified developer dtc event code from the selected control unit.
Parameters:
memorySelections - the memory selections. If empty, all available memory selections will be used.
Throws:
getNumberOfDevEventMemorySnapshots
public Integer getNumberOfDevEventMemorySnapshots(IConnectionHandle connectionHandle,
List<String> memorySelections,
Integer eventCode)
throws DiagException
Determines the number of existing snapshot records for the specified developer dtc event code and
selected control unit.
Parameters:
memorySelections - the memory selections. If empty, all available memory selections will be used.
Returns:
Throws:
exportDevEventMemorySnapshots
public String exportDevEventMemorySnapshots(IConnectionHandle connectionHandle,
List<String> memorySelections,
String targetFilePath)
throws DiagException
Exportes the snapshot records of all developer dtc event codes from the selected control unit into the
specified target file. If the file exists, then this file is overwritten.
Parameters:
memorySelections - the memory selections. If empty, all available memory selections will be used.
Throws:
resetDevEventMemory
public void resetDevEventMemory(IConnectionHandle connectionHandle,
List<String> memorySelections)
throws DiagException
Deletes the developer event memories from the selected control unit for the given memory selections.
Parameters:
memorySelections - the memory selections. If empty, all developer event memories will be
deleted.
Throws:
readListOfActiveFaultEntries
public IDiagResultEventMemory readListOfActiveFaultEntries( IConnectionHandle connectionHandle
)
throws DiagException
Reads the event memories with the status active fault path. The function is only available for UDS control
units. For KWP control units the function throws an exception.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while reading the event memory or the operation was called for
a KWP control unit.
readListOfUncheckedFaultPaths
public IDiagResultEventMemory readListOfUncheckedFaultPaths(IConnectionHandle connectionHandle
)
throws DiagException
Reads the event memories with the status unchecked fault path. The function is only available for UDS
control units. For KWP control units the function throws an exception.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while reading the event memory or the operation was called for
a KWP control unit.
resetEventMemories
public void resetEventMemories( Boolean clearOBD,
Boolean clearFunctional,
Boolean clearNotErasedECUsPhysical,
Integer timeBeforePhysicalClear,
List<Integer> controlUnitList)
throws DiagException
Tries to delete the event memories in the vehicle by sending a sequence of diagnostic services. First
optional sending the functional OBD-Service 0x04 followed by a TP2.0-broadcast and a functional UDS-
service 0x14. Finally all control units of the specified unit list are cleared physically, which KD-Bit is set in
the gateway component list. If the unit list is null or empty, then all units with a set KD-Bit are cleared. All
deletion steps can be deactivated by the function arguments.
Parameters:
clearNotErasedECUsPhysical - Switch for physically deletion of all defined units, which KD-Bit is
set in the gateway component list.
Throws:
Tries to delete the event memories in the vehicle by sending a sequence of diagnostic services. First
optinal sending the functional OBD-Service 0x04 followed by a TP2.0-broadcast and finally a functional
UDS-service 0x14. Closes all connections after running. The arguments correspond to the administration
settings of function configuration -> event memory -> workflow complete system delete.
Parameters:
clearOBD - Switch if to clear OBD control units (OBD-Service 0x04 functional) first. Maybe null,
than default TRUE is used.
clearNotErasedECUsPhysical - Switch if to read fitment list afterwards and clear physical event
memory if KD bit is set. Maybe null, than default FALSE is used.
Throws:
resetAllEventMemoriesSequential
public void resetAllEventMemoriesSequential()
throws DiagException
Tries to delete the event memories in the vehicle by sending a sequence of diagnostic services. Step 1:
Clear DTC's of all emission-related ecu's (OBD-Service 0x04) Step2: For every control unit in the list clear
the DTC memory. Closes all connections after running.
Throws:
resetAllOBDFaultMemories
public void resetAllOBDFaultMemories()
throws DiagException
Deletes the event memory of all OBD relevant control units by sending the functional OBD-Service 0x04.
Closes all connections after running.
Throws:
resetEventMemory
public void resetEventMemory( IConnectionHandle connectionHandle)
throws DiagException
Parameters:
Throws:
connectToEcu
public IDiagResultConnectEcu connectToEcu(int ecuAddress)
throws DiagException
Opens a diagnostic connection to the control unit specified by the address. Existing connections to other
control units will be closed. All subsequent operations of this interface which operate on a control unit will
use the control unit specified by this function. Connection behaviour switches to
CLOSE_CONNECTION_BEHAVIOUR which closes the connection after an operation call. To change this
behaviour call openConnection. The return value contains reference to IConnectionHandle which is
necessary for all following control unit dependend calls.
Parameters:
Returns:
Throws:
connectToEcuAndOpenConnection
public IDiagResultConnectEcu connectToEcuAndOpenConnection( int ecuAddress)
throws DiagException
Opens the diagnostic connection to the control unit specified by the address and switches to
STAY_CONNECTED_BEHAVIOUR. Existing connections to other control units will be closed. In
STAY_CONNECTED_BEHAVIOUR the connection to a control unit stays opened after every call of a diagnosic
operation. To change this behaviour call closeConnection. The behaviour also changes calling
connectToEcu and setVehicleProject.
Parameters:
Returns:
Throws:
connectToEcuWithLogicalLink
public IDiagResultConnectEcu connectToEcuWithLogicalLink( String logicalLinkname)
throws DiagException
Opens a diagnostic connection to the control unit specified by logical link name. Existing connections to
other control units will be closed. All subsequent operations of this interface which operate on a control unit
will use the control unit specified by this function. Connection behaviour switches to
CLOSE_CONNECTION_BEHAVIOUR which closes the connection after an operation call. To change this
behaviour call openConnection. The return value contains reference to IConnectionHandle which is
necessary for all following control unit dependend calls.
Parameters:
Returns:
Throws:
createMultilinkHandleByAddress
public IMultilinkEcuHandle createMultilinkHandleByAddress(Long ecuAddress)
throws DiagException
Creates a handle for a multilink call to represent an ecu. The method checks the validity of the ecu
address, but not the connection to the ecu. No ecu connection is established.
Parameters:
Returns:
Throws:
createMultilinkHandleByLogicalLink
public IMultilinkEcuHandle createMultilinkHandleByLogicalLink(String logicalLinkname)
throws DiagException
Creates a handle for a multilink call to represent an ecu. The method checks the availability of the logical
link name in the vehicle project, but not the connection to the ecu. No ecu connection is established.
Parameters:
Returns:
Throws:
DiagException - If the logical link name is not available in the vehicle project.
readMultilinkIdentification
public List<IDiagResultIdentification> readMultilinkIdentification( List<IMultilinkEcuHandle>
ecuList,
boolean readExtendedIdent,
boolean readSubSystems)
throws DiagException
Reads the identification data for the specified control units with the current multilink settings. If the flag
readExtendedIdent is enabled, then the extended identification is read. In the other case only the
standard identification is determined. If the flag readSubSystems is enabled, then the subsystems are read
in addition. Attention! Only UDS control units are supported. The result element of a KWP control unit
contains an error message. Closes all connections after running.
Parameters:
Returns:
Throws:
readMultilinkEventMemory
public List<IDiagResultEventMemory> readMultilinkEventMemory( List<IMultilinkEcuHandle> ecuLis
t)
throws DiagException
Reads the event memories of the specified conrol units with the current multilink settings. Attention! Only
UDS control units are supported. The result element of a KWP control unit contains an error message.
Closes all connections after running.
Parameters:
Returns:
Throws:
resetMultilinkEventMemory
public List<IDiagResultMulti> resetMultilinkEventMemory(List<IMultilinkEcuHandle> ecuList,
boolean clearOBD)
throws DiagException
Deletes the event memories of the specified conrol units with the current multilink settings. If the flag
clearOBD is enabled, then the functional deleting of OBD control units is executed additionally. Attention!
Only UDS control units are supported. The result element of a KWP control unit contains an error message.
Closes all connections after running.
Parameters:
clearOBD - Switch for the additional deleting of OBD control units. Maybe null, than default FALSE
is used.
Returns:
Throws:
readMultilinkMeasurement
public List<IDiagResultMeasurement> readMultilinkMeasurement( List<IDiagMultiMeasurementDescri
ptor> measurementDescriptors)
throws DiagException
Reads all measurement values specified by the list of measurementDescriptors with the current multilink
settings. Attention! Only UDS control units are supported. The result element of a KWP control unit
contains an error message. Closes all connections after running.
Parameters:
Returns:
Throws:
createMultilinkMeasurementDescriptor
public IDiagMultiMeasurementDescriptor createMultilinkMeasurementDescriptor(IMultilinkEcuHandl
e ecuHandle,
String measurementName)
throws DiagException
Parameters:
Returns:
readMultilinkAdaptation
public List<IDiagResultAdaptation> readMultilinkAdaptation( List<IDiagMultiAdaptionDescriptor>
adaptationDescriptors)
throws DiagException
Reads all adaptation values specified by the list of adaptionDescriptors with the current multilink settings.
Attention! Only UDS control units are supported. The result element of a KWP control unit contains an error
message. Closes all connections after running.
Returns:
Throws:
createMultilinkAdaptationDescriptor
public IDiagMultiAdaptionDescriptor createMultilinkAdaptationDescriptor(IMultilinkEcuHandle ec
uHandle,
String adaptationName)
throws DiagException
Parameters:
For KWP the adaptation name is the channel number given as string - i.e. "1" to "255".
Returns:
readMultilinkCoding
public List<IDiagResultCoding> readMultilinkCoding( List<IMultilinkEcuHandle> ecuList,
boolean readSubSystems)
throws DiagException
Reads the coding values from for the specified control units with the current multilink settings. For UDS
control units the plain text coding and the byte coding will be read. The slave coding values will be read,
every slave coding value will be returned as an additional entry in the result list. Each result element has an
assignment to the associated control unit and subsystem.
Attention! Only UDS control units are supported. The result element of a KWP control unit contains an error
message.
Attention! Software compositions / components are not included
Closes all connections after running.
Parameters:
Returns:
Throws:
writeMultilinkCoding
public List<IDiagResultMulti> writeMultilinkCoding( List<IDiagMultiCodingValueDescriptor> codi
ngValueDescriptors)
throws DiagException
Writes the text or byte coding values, that are specified in the descriptor list codingValueDescriptors with
the current multilink settings. The function is only defined for UDS control units. The result element of a
KWP control unit contains an error message. Closes all connections after running.
Parameters:
Returns:
createMultilinkCodingDescriptor
public IDiagMultiCodingValueDescriptor createMultilinkCodingDescriptor( IMultilinkEcuHandle ec
uHandle,
String systemName,
Map<String,String> textCoding,
String byteCoding,
IDiagResultValue.ValueType byteCodingType,
Boolean ecuReset)
throws DiagException
Parameters:
systemName - The system name. The first coding model gets the name master. The subsystems
for UDS get the ODX-Shortnames. For KWP subSysXX where XX is the number of subsystem
starting with 0.
textCoding - The plain text representation of the new coding values. The function is only defined
for uds control units. Each entry of the key-value-pairs contains the shortname of the coding entry
and the new coding value.
byteCoding - The new byte coding value or an empty string if the text coding should be performed.
byteCodingType - The value type of the byte coding. Can be ValueType.INT for a KWP short
coding value or ValueType.BYTEFIELD for a KWP long coding and UDS coding value.
Returns:
Throws:
createMultilinkAdaptationValueDescriptor
public IDiagMultiAdaptionValueDescriptor createMultilinkAdaptationValueDescriptor(IDiagMultiAd
aptionDescriptor adaptationDescriptor,
Map<String,String> adaptationValues)
throws DiagException
Creates a multilink descriptor for writing adaptation values.
The adaptation values to be written are passed to this function by a key value dictionary. The key
specifies the short name of the adaptation value and the value specifies the adaptation value to be written.
Parameters:
Returns:
Throws:
writeMultilinkAdaptation
public List<IDiagResultMulti> writeMultilinkAdaptation( List<IDiagMultiAdaptionValueDescriptor
> adaptationValueDescriptors)
throws DiagException
Writes adaptation values for the specified list adaptationValueDescriptors with the current multilink settings.
Attention! Only UDS control units are supported. The result element of a KWP control unit contains an error
message. Closes all connections after running
Parameters:
Returns:
Throws:
getShortNamesOfSubSystems
public List<String> getShortNamesOfSubSystems(IConnectionHandle connectionHandle)
throws DiagException
Returns a list of subsystem shortnames of the active control unit. The function is only specified for UDS
control units. For KWP control units an exception will be thrown.
Parameters:
Throws:
DiagException - If an error occurs while reading the short names or the operation was called for a
KWP control unit.
readCoding
public List<IDiagResultCoding> readCoding(IConnectionHandle connectionHandle)
throws DiagException
Reads the coding value from the active control unit. For UDS control units the plain text coding values and
the byte coding will be read. For KWP control units only the byte coding value will be read. For both types
the slave coding values will be read, every slave coding value will be returned as an entry in the result list.
If the control unit has no slaves the result list contains only one entry.
Parameters:
Returns:
The result coding values. The first entry respresents the master coding value.
Throws:
getShortNamesOfCodingValues
public List<String> getShortNamesOfCodingValues(IConnectionHandle connectionHandle)
throws DiagException
Parameters:
Returns:
Throws:
Writes the byte coding values for the specified (sub)system. For the system name of the master control unit
the constant 'master' or the shortname can be used. The possible system names can be retrieved by
evaluating the result list of readCoding. For UDS control units the subsytem names can also be retrieved
by calling getShortNamesOfSubSystems.
Parameters:
systemName - The (sub)system name. KWP subsystems starts with prefix subSys followed by the
index.
codingValues - The coding value to write in String representation. For KWP short coding the value
is expected as an integer value. For KWP long coding and UDS binary coding a byte array is
expected.
Returns:
Throws:
writeByteCoding
public IDiagResult writeByteCoding( IConnectionHandle connectionHandle,
String systemName,
String codingValues)
throws DiagException
Writes the byte coding values for the specified (sub)system. For the system name of the master control unit
the constant 'master' or the shortname can be used. The possible system names can be retrieved by
evaluating the result list of readCoding. For UDS control units the subsytem names can also retrieved by
calling getShortNamesOfSubSystems.
Parameters:
codingValues - The coding value to write in String representation. For KWP short coding the value
is expected as an integer value. For KWP long coding and UDS binary coding a byte array is
expected.
Returns:
Throws:
writeTextCoding
public IDiagResult writeTextCoding(IConnectionHandle connectionHandle,
String systemName,
Map<String,String> codingValues)
throws DiagException
Writes the text coding values for the specified system. The function is only defined for UDS control units.
For the system name of the master control unit the constant 'master' or the shortname can be used. For
KWP control units an exception will be thrown.
Parameters:
systemName - The (sub)system name. KWP subsystems starts with prefix subSys followed by the
index.
Returns:
Throws:
writeTextCoding
public IDiagResult writeTextCoding( IConnectionHandle connectionHandle,
String systemName,
MapAdapter codingValues,
boolean ecuReset)
throws DiagException
Writes the text coding values for the specified system with possibility of a reset. The function is only defined
for UDS control units. For the system name of the master control unit the constant 'master' or the
shortname can be used. For KWP control units an exception will be thrown.
Parameters:
systemName - The (sub)system name. KWP subsystems starts with prefix subSys followed by the
index.
codingValues - The plain text coding values. Example for a key / value pair:
("Param_AirCondiSysteAvail", "available").
Returns:
Throws:
writeTextCoding
public IDiagResult writeTextCoding(IConnectionHandle connectionHandle,
String systemName,
Map<String,String> codingValues,
boolean ecuReset)
throws DiagException
Writes the text coding values for the specified system with possibility of a reset. The function is only defined
for UDS control units. For the system name of the master control unit the constant 'master' or the
shortname can be used. For KWP control units an exception will be thrown.
Parameters:
systemName - The (sub)system name. KWP subsystems starts with prefix subSys followed by the
index.
codingValues - The plain text coding values. Example for a key / value pair:
("Param_AirCondiSysteAvail", "available").
Returns:
Throws:
readSpecialCoding
public IDiagResultSpecialCoding readSpecialCoding(IConnectionHandle connectionHandle)
throws DiagException
Reads the special coding information from the currently selected control unit.
If the current control unit does not support special coding the function throws an exception.
Parameters:
Returns:
Throws:
writeSpecialCoding
public IDiagResult writeSpecialCoding(IConnectionHandle connectionHandle,
Map<String,String> parameters)
throws DiagException
Writes the provided "special coding information" to the currently selected control unit.
For the provided map of parameters the following key/value pairs are allowed:
Key "Brand": "vw", "audi", "seat", "skoda", "vn", "bugatti", "lamborghini", "bentley", "rollsroyce",
"ford", "porsche"
Parameters:
Returns:
General response.
Throws:
writeSpecialCoding
public IDiagResult writeSpecialCoding(IConnectionHandle connectionHandle,
MapAdapter parameters)
throws DiagException
Writes the provided "special coding information" to the currently selected control unit.
For the provided map of parameters the following key/value pairs are allowed:
Key "Brand": "vw", "audi", "seat", "skoda", "vn", "bugatti", "lamborghini", "bentley", "rollsroyce",
"ford", "porsche"
Parameters:
Returns:
General response.
Throws:
setVehicleProject
public void setVehicleProject(String projectName)
throws DiagException
Sets and loads the vehicle project for the diagnostic interface. Loading a project is a precondition for
connecting to a control unit.
Parameters:
setVehicleProjectAutomatic
public String setVehicleProjectAutomatic( IConnectionInterface.PROJECT_MODE projectMode)
throws DiagException
Determines the project for the current vin automatically. If exactly on project is determined, it will be set and
loaded and the project name will be returned. If more than one project is determined a exception will be
thrown.
Parameters:
Returns:
Throws:
DiagException - If the project is not unique or an error occurs while setting it.
getProjectEcuAddressList
public List<Integer> getProjectEcuAddressList()
throws DiagException
Retrieves a list holding the addresses of all control units in the current project.
Returns:
Throws:
getShortNamesOfAccessModes
public List<String> getShortNamesOfAccessModes( IConnectionHandle connectionHandle)
throws DiagException
Returns the ODX-ShortNames of all available access modes for UDS control units. The function throws an
exception for KWP control units.
Parameters:
Returns:
Throws:
DiagException - If an error occurs or the function was called on an KWP control unit.
getShortNamesOfDiagnosticSessions
public List<String> getShortNamesOfDiagnosticSessions(IConnectionHandle connectionHandle)
throws DiagException
Returns the ODX-ShortName list of all available diagnostic sessions for UDS control units. The function
throws an exception for KWP control units.
Parameters:
Returns:
Throws:
DiagException - If an error occurs or the function was called on an KWP control unit.
securityAccess
public IDiagResult securityAccess(IConnectionHandle connectionHandle,
String loginCode,
String accessMode)
throws DiagException
Executes the security access operation on the control unit using the specified login code and access mode.
Parameters:
Returns:
General response
Throws:
DiagException - If the security access fails or an error occurs while calling this method.
securityAccessSFDOnline
public IDiagResultSFD securityAccessSFDOnline(IConnectionHandle connectionHandle,
ISecurityAccessInterface.OnlineRequestedRole role,
ISecurityAccessInterface.OnlineAccessDuration duration,
ISecurityAccessInterface.OnlineAccessMethod accessMethod)
throws DiagException
Executes the security access unlock operation on the control unit by using an online token (SFD). The
online token is requested from the sfd backend system. This function is only supported for calls from the
local computer. A remote request is rejected with an exception.
Parameters:
Returns:
Throws:
DiagException - If the control unit doesn't support the sfd unlock operation or the call comes from
a remote computer.
securityAccessSFDOffline
public IDiagResultSFD securityAccessSFDOffline( IConnectionHandle connectionHandle,
ISecurityAccessInterface.OnlineRequestedRole role,
ISecurityAccessInterface.OnlineAccessDuration duration)
throws DiagException
Executes the security access unlock operation on the control unit by using an offline token (SFD) without a
connection to the sfd backend. A offline token must be present for the specified ecu, role and duration in
the sfd-token directory (see ODIS-Admin). All older, unused tokens are automatically deleted for the
specified ecu. This function is only supported for calls from the local computer. A remote request is rejected
with an exception.
Parameters:
Returns:
Throws:
DiagException - If the control unit doesn't support the sfd unlock operation or the call comes from
a remote computer.
securityAccessSFDEcuLock
public IDiagResultSFD securityAccessSFDEcuLock( IConnectionHandle connectionHandle)
throws DiagException
Executes the security access lock operation on the specified control unit (SFD).
Parameters:
Returns:
DiagException - If the control unit doesn't support the sfd lock operation.
securityAccessSFDAllEcuLock
public List<IDiagResultSFD> securityAccessSFDAllEcuLock()
throws DiagException
Executes the security access lock operation for all control units that support the SFD function. Before the
functional lock operation is executed, all devices are moved into the extended session with a functional
diagnostic call.
Returns:
Throws:
securityAccessSFDReset
public IDiagResultSFD securityAccessSFDReset( IConnectionHandle connectionHandle,
ISecurityAccessInterface.OnlineRequestedRole role,
ISecurityAccessInterface.OnlineAccessDuration duration,
ISecurityAccessInterface.OnlineAccessMethod accessMethod)
throws DiagException
Executes the security access reset operation on the control unit by using an online token (SFD). This
operation resets the control unit to the initial protection values and is only allowed by the user role
'SUPERUSER'. The online token is requested from the sfd backend system. This function is only supported
for calls from the local computer. A remote request is rejected with an exception.
Parameters:
Returns:
Throws:
DiagException - If the control unit doesn't support the sfd reset operation or wrong role is
specified or the call comes from a remote computer.
securityAccessSFDCheckStatus
public IDiagResultSFDStatus securityAccessSFDCheckStatus( IConnectionHandle connectionHandle)
throws DiagException
Reads the security access unlock status for the specified control unit (SFD).
Parameters:
Returns:
Throws:
getShortNamesOfAdaptationChannels
public List<String> getShortNamesOfAdaptationChannels(IConnectionHandle connectionHandle)
throws DiagException
Returns the ODX short names of all available adaptation channels for UDS control units. For KWP control
unit the function throws an exception.
Parameters:
Returns:
Throws:
Returns the ODX short names of all available adaptation values from an adaptation channel. For KWP
control units the function throws an exception.
Parameters:
adaptationChannel - The adaptation channel from which the adaptation values shall be retrieved.
Returns:
Throws:
DiagException - If an error occurs while calling this function or the function is called for a KWP
control unit.
readAdaptation
public IDiagResultAdaptation readAdaptation(IConnectionHandle connectionHandle,
String adaptationChannel)
throws DiagException
Reads the adaptation values of the specified adaptation channel from the currently selected control unit.
Returns read values as a list. For KWP control units the size of the list is 1. For UDS control units n values
will return. If an error occurs while reading the adaptation values the function throws an exception.
Parameters:
adaptationChannel - The adaptation channel from which the adaptation values shall be retrieved.
Returns:
Throws:
For KWP the adaptation channel is the channel number given as string - i.e. "1" to "255".
The adaptation value to be written is to be passed as the single entry in the key value dictionary
with the adaption channel serving as key.
Parameters:
adaptationChannel - The adaptation channel to which the adaptation values shall be written.
adaptationValues - The adaptation values which shall be written. Example for a key / value pair:
("Param_ActivStartStopFunct", "active").
Returns:
Throws:
writeAdaptation
public IDiagResult writeAdaptation(IConnectionHandle connectionHandle,
String adaptationChannel,
Map<String,String> adaptationValues)
throws DiagException
For KWP the adaptation channel is the channel number given as string - i.e. "1" to "255".
The adaptation value to be written is to be passed as the single entry in the key value dictionary
with the adaption channel serving as key.
Parameters:
adaptationChannel - The adaptation channel to which the adaptation values shall be written.
adaptationValues - The adaptation values which shall be written. Example for a key / value pair:
("Param_ActivStartStopFunct", "active").
Returns:
Throws:
clearAdaptationChannels
public void clearAdaptationChannels(IConnectionHandle connectionHandle)
throws DiagException
Resets all adaptation channels to their default values. For UDS control units the function throws an
exception.
Parameters:
Throws:
DiagException - If an error occurs while calling this function or the function is called for an UDS
control unit.
actuatorDiagnosticsAbort
public void actuatorDiagnosticsAbort( IConnectionHandle connectionHandle)
throws DiagException
Throws:
actuatorDiagnosticsCheck
public List<IDiagResultStatus> actuatorDiagnosticsCheck(IConnectionHandle connectionHandle,
List<String> actuators)
throws DiagException
Reads the status information and the measurement values for the specified actuators (UDS control units)
or the actuator specified in actuatorDiagnosticsInit (KWP control units).
The actuators are only relevant for the UDS actuator diagnostic. The measurement values which should be
read for an actuator can be configured by the function actuatorDiagnosticsInit. If no actuators are
specified, only the overall measurement values configured in actuatorDiagnosticsInit will be read. For
KWP control units the parameter will be ignored.
Parameters:
actuators -
UDS: The actuators for which the measurement values will be read.
KWP: No actuators to specify.
Returns:
Throws:
actuatorDiagnostics2Init
public void actuatorDiagnostics2Init( IConnectionHandle connectionHandle,
List<IDiagDescriptor2WithParametersAndMeasurements> actuators,
List<IDiagMeasurementDescriptor> measurements)
throws DiagException
Initializes the actuator diagnosis with the specified actuators. The initialization must be called to start the
actuator diagnosis.
For UDS control units settings and measurement values can be configured, which will be read for every
basic setting by a check operation. The specified measurements can be configured for different control
units.
For KWP control units the settings are limited to one object and the measurement values will be ignored.
Ensures that the following operation will run over the same diagnostic connection.
Parameters:
Throws:
actuatorDiagnosticsInit
public void actuatorDiagnosticsInit(IConnectionHandle connectionHandle,
List<IDiagDescriptorWithParametersAndMeasurements> actuators,
List<String> measurements)
throws DiagException
Initializes the actuator diagnosis with the specified actuators. The initialization must be called to start the
actuator diagnosis.
For UDS control units settings and measurement values can be configured, which will be read for every
basic setting by a check operation.
For KWP control units the settings are limited to one object and the measurement values will be ignored.
Ensures that the following operation will run over the same diagnostic connection.
Parameters:
Throws:
actuatorDiagnosticsNext
public List<IDiagResultStatus> actuatorDiagnosticsNext( IConnectionHandle connectionHandle)
throws DiagException
Switches to the next configured actuator. For UDS actuator diagnosis the function can only be executed if
no actuator diagnosis is running or if only one actuator diagnosis is running. It terminates the currently
running actuator diagnosis and selectes the next actuator to start. The next actuator is determined from the
list of actuators defined with actuatorDiagnosticsInit. Calling actuatorDiagnosticsStart with an
empty parameter list starts the selected actuator. For KWP the functions throws a DiagException.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while calling this function or the function is called for a KWP
control unit.
actuatorDiagnosticsStart
public List<IDiagResultStatus> actuatorDiagnosticsStart(IConnectionHandle connectionHandle,
List<String> actuators)
throws DiagException
Starts the actuator diagnosis for the specified actuators (UDS control units) or the actuator specified in
actuatorDiagnosticsInit (KWP control units).
Parameters:
actuators -
UDS: The actuators to start.
KWP: No actuators to specify.
Returns:
Throws:
actuatorDiagnosticsStop
public List<IDiagResultStatus> actuatorDiagnosticsStop( IConnectionHandle connectionHandle,
List<String> actuators)
throws DiagException
Stops the actuator diagnosis for the specified actuators (UDS control units) or the actuator specified in
actuatorDiagnosticsInit (KWP control units).
Parameters:
Returns:
Throws:
actuatorDiagnosticsWaitUntilNotRunning
public List<IDiagResultStatus> actuatorDiagnosticsWaitUntilNotRunning(IConnectionHandle connec
tionHandle,
List<String> actuators,
long timeout)
throws DiagException
Controls the process of reading status and Measurands. An update is processed until the state is changed
to a non active one or if the set timeout has been expired.
Parameters:
actuators -
UDS: The actuators for which the measurement values will be read.
KWP: No actuators to specify.
Returns:
Throws:
createDiagActuator2
public IDiagDescriptor2WithParametersAndMeasurements createDiagActuator2( String actuatorName,
Map<String,String> parameters,
List<IDiagMeasurementDescriptor> measurementValues)
throws DiagException
Creates an actuator object that can be used to initialize the actuator diagnosis. An
IDiagDescriptorWithParametersAndMeasurements object consist of at least an actuator name. For UDS
control units this code must be on of the values returned by getShortNamesOfActuators. For KWP2000
control units this value is the actuator code as an integer value. For KWP1281 control units this parameter
is ignored. Parameters and measurement values can be defined optionally for UDS control units. For KWP
control units these parameters will be ignored.
Parameters:
Returns:
Throws:
createDiagActuator
public IDiagDescriptorWithParametersAndMeasurements createDiagActuator( String actuatorName,
Map<String,String> parameters,
List<String> measurementValues)
throws DiagException
Creates an actuator object that can be used to initialize the actuator diagnosis. An
IDiagDescriptor2WithParametersAndMeasurements object consist of at least an actuator name. For
UDS control units this code must be on of the values returned by getShortNamesOfActuators. For
KWP2000 control units this value is the actuator code as an integer value. For KWP1281 control units this
parameter is ignored. Parameters and measurement values can be defined optionally for UDS control
units. For KWP control units these parameters will be ignored. The specified measurements can be
configured for different control units.
Parameters:
Returns:
Throws:
Returns the ODX short names of all available actuators from the currently selected control unit. For a KWP
control unit this function throws an exception.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while calling this function or this function is called for a KWP
control unit.
getShortNamesOfMeasurementsForActuatorDiagnostics
public List<String> getShortNamesOfMeasurementsForActuatorDiagnostics(IConnectionHandle connec
tionHandle)
throws DiagException
Returns the ODX short names of all measurements for the actuator diagnosis. For a KWP control unit this
function throws an exception.
Parameters:
Returns:
The measurements.
Throws:
DiagException - If an error occurs while calling this function or this function is called for a KWP
control unit.
getShortNamesOfStartParametersForActuator
public List<String> getShortNamesOfStartParametersForActuator(IConnectionHandle connectionHand
le,
String actuatorName)
throws DiagException
Returns the ODX short names of all available parameters from the specified actuator. For a KWP control
unit this function throws an exception.
Parameters:
Returns:
The parameters.
Throws:
DiagException - If an error occurs while calling this function or this function is called for a KWP
control unit.
getShortNamesOfMeasurementGroups
public List<String> getShortNamesOfMeasurementGroups( IConnectionHandle connectionHandle)
throws DiagException
Returns a list of ODX short names of all available measurement groups for the currently selected control
unit. For KWP control unit this function throws an exception.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while calling this function or this function is called for a KWP
control unit.
getShortNamesOfMeasurements
public List<String> getShortNamesOfMeasurements(IConnectionHandle connectionHandle,
String measurementGroup)
throws DiagException
Returns ODX short names of all available measurements of the specified measurement group.For KWP
control unit this function throws an exception.
Parameters:
Returns:
The ODX short names of all available measurements of the specified measurement group.
Throws:
DiagException - If an error occurs while calling this function or this function is called for a KWP
control unit.
createDiagMeasurementDescriptor
public IDiagMeasurementDescriptor createDiagMeasurementDescriptor(long ecuAddress,
String measurementGroup,
String measurementParam)
throws DiagException
Parameters:
Returns:
Throws:
readMeasurement
public IDiagResultMeasurement readMeasurement(IConnectionHandle connectionHandle,
String measurementGroup,
String measurementParam)
throws DiagException
Reads the measurements from the currently selected control unit. Reads all values from the specified
group or - if specified - a specific measurement from that group. For KWP control units the reading of block
numbers and positions are supported.
Parameters:
measurementGroup - The ODX short name of the measurement group or the KWP block number.
measurementParam - The ODX short name of the measurement or the KWP position number.
Returns:
Throws:
readMeasurements
public List<IDiagResultMeasurement> readMeasurements( List<IDiagMeasurementDescriptor> measure
mentDescriptors)
throws DiagException
Reads the measurement values from the currently selected control unit. Reads all values specified by the
list of measurementDescriptors. For KWP control units reading of block numbers and positions are
supported.
Parameters:
Returns:
Throws:
getShortNamesOfSoftwareCompositions
public List<IDiagResultIdentificationShortName> getShortNamesOfSoftwareCompositions(IConnectio
nHandle connectionHandle)
throws DiagException
Returns the ODX short names of all identification values for the software compositions and software
components. The relation of software components to software composition is done by the sequence. For a
composition all components follow afterwards. For a KWP control unit this function throws an exception.
Parameters:
Throws:
DiagException - If an error occurs while reading the short names or the operation was called for a
KWP control unit.
getShortNamesOfIdentificationDatas
public List<String> getShortNamesOfIdentificationDatas( IConnectionHandle connectionHandle,
String subsytem)
throws DiagException
Returns the ODX short names of all identification values for the specified subsystem. If the subsystem
name is empty the short names of the master ecu will be returned. For a KWP control unit this function
throws an exception.
Parameters:
subsytem - Name of the subsystem for which the values will be returned.
Returns:
Throws:
DiagException - If an error occurs while calling this function or this function is called for a KWP
control unit.
readIdentificationSoftwareCompositions
public List<IDiagResultIdentification> readIdentificationSoftwareCompositions(IConnectionHandl
e connectionHandle)
throws DiagException
Reads software compositions identification data from the currently selected control unit.
Parameters:
Returns:
The identification data of the master and its software compositions and software components.
Throws:
readIdentification
public List<IDiagResultIdentification> readIdentification(IConnectionHandle connectionHandle)
throws DiagException
Reads all identification data from the currently selected control unit including extended informations slave
control units, software cluster and software compositions.
Parameters:
Returns:
Throws:
readIdentificationData
public IDiagResultValue readIdentificationData( IConnectionHandle connectionHandle,
String identDataIdentifier)
throws DiagException
Reads a single identification data from the currently selected master conrol unit and returns it. Single
identification data can be read for UDS and KWP2000 Service 22 control units and must be specified by an
identifier. For UDS control units one of the shortnames returned by
getShortNamesOfIdentificationDatas must be used. For KWP control units also an uds shortname
must be used to specify the identification data. The shortname will be mapped to an appropiate record data
identifier. For a list of mapped shortnames see the automation parameter mapping file. If a specified
identifier is not available or cannot be mapped the function returns a result with an appropiate error
message as value.
Parameters:
Returns:
sendRawService
public byte[] sendRawService( IConnectionHandle connectionHandle,
byte[] requestPdu)
throws DiagException
Parameters:
Returns:
Throws:
sendRawService
public byte[] sendRawService(IConnectionHandle connectionHandle,
String requestPduString)
throws DiagException
Transforms input parameter from String to a byte array and writes raw hex data.
Parameters:
Returns:
Answer of request.
Throws:
Writes raw hex data with suppressed connection check via "tester present".
Parameters:
Returns:
Throws:
sendRawServiceFunctional
public IDiagResultRawService sendRawServiceFunctional(byte[] requestPdu,
String logicalLink)
throws DiagException
Parameters:
Returns:
Throws:
sendRawServiceFunctional
public IDiagResultRawService sendRawServiceFunctional(String requestPduString,
String logicalLink)
throws DiagException
Returns:
Throws:
readRAM
public IDiagResultMemoryCells readRAM(IConnectionHandle connectionHandle,
Integer startAddress,
Integer numberOfMemoryCells)
throws DiagException
Reads the specified number of memory bytes from the ECU-RAM. Starting at the specified address. This
method is supported only by the KWP1281 protocol.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while calling this function or the function is not called for a
KWP1281 control unit.
readROM
public IDiagResultMemoryCells readROM(IConnectionHandle connectionHandle,
Integer startAddress,
Integer numberOfMemoryCells)
throws DiagException
Reads the specified number of memory bytes from the ECU-ROM. Starting at the specified address. This
method is supported only by the KWP1281 protocol.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while calling this function or the function is not called for a
KWP1281 control unit.
readEEPROM
public IDiagResultMemoryCells readEEPROM( IConnectionHandle connectionHandle,
BigInteger startAddress,
Integer numberOfMemoryCells)
throws DiagException
Reads the specified number of memory bytes from the ECU-EEPROM. Starting at the specified address.
The number of the address bytes is calculated automatically.
Parameters:
Returns:
Throws:
readEEPROMWithFixedAddressLength
public IDiagResultMemoryCells readEEPROMWithFixedAddressLength( IConnectionHandle connectionHa
ndle,
BigInteger startAddress,
Integer numberOfAddressBytes,
Integer numberOfMemoryCells)
throws DiagException
Reads the specified number of memory bytes from the ECU-EEPROM. Starting at the specified address by
using the given number of address bytes.
Parameters:
Returns:
Throws:
readEEPROMSerial
public IDiagResultMemoryCells readEEPROMSerial( IConnectionHandle connectionHandle,
Integer startAddress,
Integer numberOfMemoryCells)
throws DiagException
Reads (serial) the specified number of memory bytes from the ECU-EEPROM. Starting at the specified
address. This method is supported only by the KWP1281 protocol.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while calling this function or the function is not called for a
KWP1281 control unit.
writeEEPROM
public IDiagResult writeEEPROM( IConnectionHandle connectionHandle,
BigInteger startAddress,
byte[] memoryCellData)
throws DiagException
Writes the specified memory data to the ECU-EEPROM. Starting at the specified address. The number of
the address bytes is calculated automatically.
Parameters:
Returns:
General response.
Throws:
writeEEPROMWithFixedAddressLength
public IDiagResult writeEEPROMWithFixedAddressLength( IConnectionHandle connectionHandle,
BigInteger startAddress,
Integer numberOfAddressBytes,
byte[] memoryCellData)
throws DiagException
Writes the specified memory data to the ECU-EEPROM. Starting at the specified address by using the
given number of address bytes.
Parameters:
Returns:
General response.
Throws:
Writes (serial) the specified memory data to the ECU-EEPROM. Starting at the specified address. This
method is supported only by the KWP1281 protocol.
Parameters:
Returns:
General response.
Throws:
DiagException - If an error occurs while calling this function or the function is not called for a
KWP1281 control unit.
configureSetting
public void configureSetting( String paramKey,
String paramValue)
throws DiagException
Parameters:
Throws:
Parameters:
Throws:
setTraceLevel
public void setTraceLevel(String level)
throws DiagException
Setting the trace level. If level not exist, the level is set to FATAL.
Parameters:
level - Possible values {ALL, DEBUG, INFO, WARN, ERROR, FATAL, OFF}
Throws:
DiagException - If setting log level fails. If level not exist, the level is set to FATAL.
setTraceLevel
public void setTraceLevel(Level level)
throws DiagException
Parameters:
Throws:
Starts or stops the tracing of BUS, DoIP or JOB traces. Which traces are affected is configured within
configureSetting.
Parameters:
Throws:
getVersions
public IDiagResultVersions getVersions()
throws DiagException
Returns the versions of the used modules. The PDU API Version can be empty if it is not found at the
moment when this function is called.
Returns:
Throws:
getODXVersions
public List<IDiagResultODXVersion> getODXVersions()
throws DiagException
Returns a list of all MCD projects with project information of the current project path. For every subdirectory
a list entry is generated.
Returns:
ODX versions.
Throws:
Closes the connection to the current control unit and switches to CLOSE_CONNECTION_BEHAVIOUR. In
CLOSE_CONNECTION_BEHAVIOUR the connection to a control unit is closed after every call of a diagnosic
operation.
Parameters:
Throws:
DiagException - If an error occurs while setting the internal flag or the function is called before the
function openConnection was called.
openConnection
public void openConnection( IConnectionHandle connectionHandle)
throws DiagException
Opens the connection to the current control unit and switches to STAY_CONNECTED_BEHAVIOUR. In
STAY_CONNECTED_BEHAVIOUR the connection to a control unit stays opened after every call of a diagnosic
operation. To change this behaviour call closeConnection. The behaviour also changes calling
connectToEcu and setVehicleProject.
Parameters:
Throws:
switchSession
public IDiagResult switchSession( IConnectionHandle connectionHandle,
String session)
throws DiagException
For UDS control units the ODX short name of the diagnostic session is used to identify the session to
switch to.
For KWP control units the following identifyer are used:
Identifier Description
00 VAS505x mode
83 End of line within volkswagen
84 End of line within control unit producer
85 Update programming
86 Developper mode
89 Standard selfdiagnostics
Parameters:
Returns:
General response.
Throws:
disableTransportMode
public void disableTransportMode()
throws DiagException
Throws:
enableTransportMode
public void enableTransportMode()
throws DiagException
Deactivation of a vehicle in order to minimize energy consumption. This is done if a long period of idleness
e.g. storage or transport is approaching. No connection to control unit is neccessary as precondition.
Throws:
checkFlashProgramming
public boolean checkFlashProgramming( IConnectionHandle connectionHandle)
throws DiagException
Checks if the current control unit is in principle flashable. If the information is not available the methods
returns true.
Parameters:
Returns:
Throws:
checkFlashProgrammingWithFlashContainer
public boolean checkFlashProgrammingWithFlashContainer( IConnectionHandle connectionHandle,
String containerFileName,
String sessionName)
throws DiagException
Checks if the current control unit is flashable with the containerFileName content.UDS: Check over
expected idents (contains checks of partnumber and software version)KWP: Check of partnumber and
softwareversion
Parameters:
Returns:
True if the current control unit is flashable with the containerFileName content.
Throws:
checkFlashPreConditions
public List<IDiagResultPreCondition> checkFlashPreConditions( IConnectionHandle connectionHand
le)
throws DiagException
Checks the flashing preconditions for the current control unit and delivers the list of unfulfilled conditions.
Parameters:
Returns:
The list of unfulfilled preconditions or an empty list if all conditions are fulfilled.
Throws:
flashProgramming
public IDiagResultFlashSession flashProgramming(IConnectionHandle connectionHandle,
String containerFileName,
String sessionName,
Boolean checkSessionWithEcu)
throws DiagException
Parameters:
sessionName - The session name to use for the update programming. The parameter can be null.
checkSessionWithEcu - Switch if check is activated for UDS on expected idents and for KWP on
part number and software version. Maybe null, than default TRUE is used.
Returns:
Throws:
createFlashSessionDescriptor
public IDiagFlashSessionDescriptor createFlashSessionDescriptor(int ecuAddress,
String containerFilePath,
String sessionName,
Boolean checkSessionWithEcu)
throws DiagException
Creates a descriptor for a flash session that can be used to flash a given control unit with the specified
flash session. In addition, the availability of the ecu, container and session are checked.
Parameters:
checkSessionWithEcu - Switch if check is activated for UDS on expected idents and for KWP on
part number and software version. Maybe null, than default TRUE is used.
Returns:
Throws:
flashProgrammingParallel
public IDiagResultFlashProgramming flashProgrammingParallel(List<IDiagFlashSessionDescriptor>
flashSessionDescriptors)
throws DiagException
Starts the parallel update programming of the specified flash sessions. Only one flash session may be
assigned to every control unit.
Returns:
Throws:
flashProgrammingCoordinated
public IDiagResultFlashProgramming flashProgrammingCoordinated(List<IDiagFlashSessionDescripto
r> flashSessionDescriptors,
List<String> coordinationFiles)
throws DiagException
Starts the coordinated update programming of the specified flash sessions. The coordination is based on
the provided json files. Only one flash session may be assigned to every control unit. Used only for macros,
the web interface does not allow multiple control files.
Parameters:
coordinationFiles - the path to the json files determining the order in which the flashing should
be performed.
Returns:
Throws:
flashProgrammingCoordinated
public IDiagResultFlashProgramming flashProgrammingCoordinated( List<IDiagFlashSessionDescript
or> flashSessionDescriptors,
String coordinationFile)
throws DiagException
Starts the coordinated update programming of the specified flash sessions. The coordination is based on
the provided json file. Only one flash session may be assigned to every control unit.
Parameters:
coordinationFile - the path to the json file determining the order in which the flashing should be
performed.
Returns:
Throws:
flashProgrammingCoordinatedByZipArchive
public IDiagResultFlashProgramming flashProgrammingCoordinatedByZipArchive( String coordinatio
nZipFilePath)
throws DiagException
Starts the coordinated update programming with the zip archive content. The coordination is based on the
included json files.
Parameters:
Returns:
flashProgrammingSequence
public IDiagResultFlashProgramming flashProgrammingSequence(String flashControlFilePath,
Boolean checkExpectedIdents)
throws DiagException
Starts a parallel update programming sequence, which is defined in the control file. The control file contains
the updating order and the information about control units and flash containers/sessions to be used.
Parameters:
checkExpectedIdents - Switch to enable the check of expected idents. Maybe null, than default
TRUE is used.
Returns:
Throws:
getFlashSessions
public String[] getFlashSessions( IConnectionHandle connectionHandle,
String containerFileName,
Boolean checkSessionWithEcu)
throws DiagException
Returns the names of all flash sessions contained in the specified flash container.
Parameters:
checkSessionWithEcu - Switch if check is activated for UDS on expected idents and for KWP on
part number and software version. Maybe null, than default TRUE is used.
Returns:
createBasicSetting2
public IDiagDescriptor2WithParametersAndMeasurements createBasicSetting2( String basicSettingN
ame,
Map<String,String> parameters,
List<IDiagMeasurementDescriptor> measurements)
throws DiagException
Creates a basic setting object that can be used to initialize the basic setting diagnosis. An
IDiagDescriptor2WithParametersAndMeasurements object consist of at least a basic setting name. For
UDS control units this code must be on of the values returned by getShortNamesOfBasicSettings. For
KWP2000 control units this value is the actuator code as an integer value. For KWP1281 control units this
parameter is ignored. Parameters and measurement values can be defined optionally for UDS control
units. For KWP control units these parameters will be ignored. The specified measurements can be
configured for different control units.
Parameters:
Returns:
Throws:
createBasicSetting
public IDiagDescriptorWithParametersAndMeasurements createBasicSetting( String basicSettingNam
e,
Map<String,String> parameters,
List<String> measurements)
throws DiagException
Creates a basic setting object that can be used to initialize the basic setting diagnosis. An
IDiagDescriptorWithParametersAndMeasurements object consist of at least an basic setting name. For
UDS control units this code must be on of the values returned by getShortNamesOfBasicSettings. For
KWP2000 control units this value is the actuator code as an integer value. For KWP1281 control units this
parameter is ignored. Parameters and measurement values can be defined optionally for UDS control
units. For KWP control units these parameters will be ignored.
Parameters:
Returns:
Throws:
basicSettingCheck
public List<IDiagResultStatus> basicSettingCheck( IConnectionHandle connectionHandle,
List<String> basicSettings)
throws DiagException
Parameters:
basicSettings -
UDS: The basic settings to check.
KWP: No basic settings to specify.
Returns:
Throws:
basicSettingAbort
public void basicSettingAbort(IConnectionHandle connectionHandle)
throws DiagException
Stops all running basic settings and terminates the basic setting diagnosis. For KWP the functions throws a
DiagException.
Parameters:
Throws:
DiagException - If an error occurs while calling this function or the function is called for a KWP
control unit.
basicSetting2Init
public void basicSetting2Init(IConnectionHandle connectionHandle,
List<IDiagDescriptor2WithParametersAndMeasurements> basicSettings,
List<IDiagMeasurementDescriptor> measurements)
throws DiagException
Initializes the basic setting diagnosis with the specified settings. The initialization must be called to start the
basic setting diagnosis.
For UDS control units a list of settings and a list of measurement values can be configured optionally, which
will be read for every basic setting by a check operation. The specified measurements can be configured
for different control units.
For KWP control units the list of settings is limited to one object and the list of measurement values will be
ignored.
Ensures that the following operation will run over the same diagnostic connection. After calling this function
switching to another ECU is not allowed. For UDS control Units calling basicSettingAbort releases this
state.
Parameters:
measurements - Optional measurements which have to be read within the basic setting operation.
For UDS the this are ODX-ShortNames of the measurement values.
Throws:
basicSettingInit
public void basicSettingInit( IConnectionHandle connectionHandle,
List<IDiagDescriptorWithParametersAndMeasurements> basicSettings,
List<String> measurements)
throws DiagException
Initializes the basic setting diagnosis with the specified settings. The initialization must be called to start the
basic setting diagnosis.
For UDS control units a list of settings and a list of measurement values can be configured optionally, which
will be read for every basic setting by a check operation.
For KWP control units the list of settings is limited to one object and the list of measurement values will be
ignored.
Ensures that the following operation will run over the same diagnostic connection. After calling this function
switching to another ECU is not allowed. For UDS control Units calling basicSettingAbort releases this
state.
Parameters:
measurements - Optional measurements which have to be read within the basic setting operation.
For UDS the this are ODX-ShortNames of the measurement values.
Throws:
basicSettingStart
public List<IDiagResultStatus> basicSettingStart( IConnectionHandle connectionHandle,
List<String> basicSettings)
throws DiagException
Parameters:
basicSettings -
UDS: The basic settings to start.
KWP: No basic settings to specify.
Returns:
The status of the start operation and the measurement values if set.
Throws:
basicSettingStop
public List<IDiagResultStatus> basicSettingStop(IConnectionHandle connectionHandle,
List<String> basicSettings)
throws DiagException
Stops the basic setting diagnosis for:
the specified settings (UDS control units).
the setting specified in basicSettingInit (KWP control units)
Parameters:
basicSettings -
UDS: The basic settings to stop.
KWP: No basic settings to specify.
Returns:
Throws:
basicSettingNext
public List<IDiagResultStatus> basicSettingNext(IConnectionHandle connectionHandle)
throws DiagException
Switches to the next configured basic setting. For UDS basic setting the function can only be executed if no
basic setting is running or if only one basic setting is running. It terminates the currently running basic
setting and selectes the next basic setting to start. The next basic setting is determined from the list of
basic setting defined with basicSettingInit. Calling basicSettingStart with an empty parameter list
starts the selected basic setting. For KWP the functions throws a DiagException.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while calling this function or the function is called for a KWP
control unit.
basicSettingSwitch
public List<IDiagResultStatus> basicSettingSwitch(IConnectionHandle connectionHandle)
throws DiagException
Switches the mode of operation for basic setting. The function is only available for KWP2000 control units.
A DiagException is thrown for KWP1281 and UDS control units. Two operation modes are availalble:
"Fahrzeugsystem in Grundeinstellung" or
"Fahrzeugsystem nicht in Grundeinstellung".
Parameters:
Returns:
Throws:
DiagException - If an error occurs while calling this function or the function is called for a
KWP1281 or an UDS control unit.
basicSettingWaitUntilNotRunning
public List<IDiagResultStatus> basicSettingWaitUntilNotRunning(IConnectionHandle connectionHan
dle,
List<String> basicSettings,
long timeout)
throws DiagException
Controls the process of reading status and measurands. An update is processed until the state is changed
to a non active one or if the set timeout has been expired.
Parameters:
basicSettings -
UDS: The basic settings for which the measurement values will be read.
KWP: No basic settings to specify.
Returns:
Throws:
getShortNamesOfBasicSettings
public List<String> getShortNamesOfBasicSettings( IConnectionHandle connectionHandle)
throws DiagException
Returns the ODX short names of all available basic settings from the currently selected control unit. For a
KWP control unit this function throws an exception.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while calling this function or the function is called for a KWP
control unit.
getShortNamesOfStartParametersForBasicSettings
public List<String> getShortNamesOfStartParametersForBasicSettings( IConnectionHandle connecti
onHandle,
String basicSettingName)
throws DiagException
Returns the ODX short names of all available parameters from the specified basic setting. For a KWP
control unit this function throws an exception.
Parameters:
Returns:
The parameters.
Throws:
DiagException - If an error occurs while calling this function or this function is called for a KWP
control unit.
getShortNamesOfMeasurementsForBasicSettings
public List<String> getShortNamesOfMeasurementsForBasicSettings(IConnectionHandle connectionHa
ndle)
throws DiagException
Returns the ODX short names of all measurements for the basic setting. For a KWP control unit this
function throws an exception.
Parameters:
Returns:
The measurements.
Throws:
DiagException - If an error occurs while calling this function or this function is called for a KWP
control unit.
immediateRoutineExecution
public IDiagResultStatus immediateRoutineExecution( IConnectionHandle connectionHandle,
String immediateRoutineName,
Map<String,String> immediateRoutineParameters)
throws DiagException
Starts the immediate routine with the provided parameters for the specified control unit.
Parameters:
Returns:
Throws:
getShortNamesOfStartParametersForImmediateRoutine
public List<String> getShortNamesOfStartParametersForImmediateRoutine(IConnectionHandle connec
tionHandle,
String immediateRoutineName)
throws DiagException
Returns the ODX short names of all available start parameters from the specified immediate routine.
Parameters:
The parameters.
Throws:
getShortNamesOfImmediateRoutines
public List<String> getShortNamesOfImmediateRoutines( IConnectionHandle connectionHandle)
throws DiagException
Returns the ODX short names of all available immediate routines from the currently selected control unit.
For a KWP control unit this function throws an exception.
Parameters:
Returns:
Throws:
DiagException - If an error occurs while calling this function or the function is called for a KWP
control unit.
dataSetDownload
public IDiagResultDatasetDownload dataSetDownload(IConnectionHandle connectionHandle,
String xmlFilePath)
throws DiagException
Writing of a data set with XML content or zip-archive into the current control unit.
Parameters:
Returns:
The result of the container verification and the data set download.
Potential Error-IDs:
- ODS3001E: No data set file found
- ODS3006E: Wrong data set file format
- ODS3014E: Unpacking error occurred
- ODS3015E: No control file available
- ODS3021E: Missing flash container (odx/frf)
- ODS3022E: Flash container cannot be loaded
- ODS6922E: Negative consistency check
- ODS6923E: Control file doesn't contain the current ecu address
- ODS6999E: Negative execution of data set download job
Throws:
createSoftwareCompositionComponentListEntry
public IDiagSoftwareCompositionComponentListEntry createSoftwareCompositionComponentListEntry(
String listNumber,
int listPosition,
long nodeId,
boolean isCoded)
throws DiagException
Creates a software composition component list entry for writing the software composition component list.
Parameters:
Returns:
Throws:
createSoftwareCompositionComponentListEntry
public IDiagSoftwareCompositionComponentListEntry createSoftwareCompositionComponentListEntry(
String listNumber,
boolean isCoded)
throws DiagException
Creates a software composition component list entry for writing the software composition component list.
Parameters:
Returns:
Throws:
createComponentListEntry
public IDiagComponentListEntry createComponentListEntry(int ecuId,
int listPosition,
long nodeId,
boolean isCoded)
throws DiagException
Creates an component list entry for writing the gateway component list.
Parameters:
Returns:
Throws:
createComponentListEntry
public IDiagComponentListEntry createComponentListEntry(int ecuId,
boolean isCoded)
throws DiagException
Creates an component list entry for writing the gateway component list.
Parameters:
Returns:
Throws:
readGatewayComponentList
public IDiagResultComponentList readGatewayComponentList( IConnectionHandle connectionHandle)
throws DiagException
Reads the gateway component list of the currently selected control unit. If the current control unit has no
component list the function throws an exception.
Parameters:
Returns:
Throws:
readSubsystemComponentList
public IDiagResultComponentList readSubsystemComponentList( IConnectionHandle connectionHandle
)
throws DiagException
Reads the subsystem component list of the currently selected control unit. If the current control unit has no
subsystem component list the function throws an exception.
Parameters:
Returns:
writeSubsystemComponentListFromPresentState
public IDiagResult writeSubsystemComponentListFromPresentState( IConnectionHandle connectionHa
ndle)
throws DiagException
Writes the subsystem component list to the currently selected control unit. The coding state for the list
entries are set to the read present state values. If the current control unit has no component list or is not an
UDS control unit the function throws an exception.
Parameters:
Returns:
General response.
Throws:
DiagException - If an error occurs while calling this function or the function is called for a
KWPcontrol unit.
writeSubsystemComponentList
public IDiagResult writeSubsystemComponentList( IConnectionHandle connectionHandle,
List<IDiagComponentListEntry> componentList)
throws DiagException
Writes the specified subsystem components to the currently selected control unit. If the current control unit
has no subsystem component list the function throws an exception.
Parameters:
Returns:
General response.
Throws:
Updates the subsystem component list of the currently selected control unit (only for macro api).
Parameters:
Returns:
Throws:
readSoftwareCompositionComponentList
public IDiagResultSoftwareCompositionComponentList readSoftwareCompositionComponentList(IConne
ctionHandle connectionHandle)
throws DiagException
Reads the software composition component list of the currently selected control unit. If the current control
unit has no software composition component list the function throws an exception.
Parameters:
Returns:
Throws:
createSoftwareCompositionComponentCodingDescriptor
public IDiagMultiSoftwareCompositionComponentCodingDescriptor createSoftwareCompositionCompone
ntCodingDescriptor( IMultilinkEcuHandle controlUnit,
List<IDiagSoftwareCompositionComponentListEntry> compositionComponents)
throws DiagException
Description copied from interface: ISoftwareCompositionComponentListInterface
Parameters:
Returns:
Throws:
writeMultilinkSoftwareCompositionComponentList
public List<IDiagResultMulti> writeMultilinkSoftwareCompositionComponentList( List<IDiagMultiS
oftwareCompositionComponentCodingDescriptor> codingDescriptors)
throws DiagException
Writes the specified software composition components to the corresponding control unit with multilink.
Parameters:
Returns:
General response.
Throws:
readMultilinkSoftwareCompositionComponentList
public List<IDiagResultSoftwareCompositionComponentList> readMultilinkSoftwareCompositionCompo
nentList( List<IMultilinkEcuHandle> ecuList)
throws DiagException
Reads the software composition component list for all specified control units.
Parameters:
Returns:
The software composition component lists for all specified control units.
Throws:
writeSoftwareCompositionComponentListFromPresentState
public IDiagResult writeSoftwareCompositionComponentListFromPresentState( IConnectionHandle co
nnectionHandle)
throws DiagException
Writes the software composition component list to the currently selected control unit. The coding state for
the list entries are set to the read present state values. If the current control unit has no software
composition component list or is not an UDS control unit the function throws an exception.
Parameters:
Returns:
General response.
Throws:
DiagException - If an error occurs while calling this function or the function is called for a
KWPcontrol unit.
writeSoftwareCompositionComponentList
public IDiagResult writeSoftwareCompositionComponentList( IConnectionHandle connectionHandle,
List<IDiagSoftwareCompositionComponentListEntry> componentList)
throws DiagException
Writes the specified software composition components to the currently selected control unit. If the current
control unit has no software composition component list the function throws an exception.
Parameters:
General response.
Throws:
updateSoftwareCompositionComponentList
public IDiagResultSoftwareCompositionComponentList updateSoftwareCompositionComponentList(ICon
nectionHandle connectionHandle)
throws DiagException
Updates the software composition list of the currently selected control unit (only for macro api).
Parameters:
Returns:
Throws:
writeComponentListFromPresentState
public IDiagResult writeComponentListFromPresentState(IConnectionHandle connectionHandle)
throws DiagException
Writes the specified gateway component list to the currently selected control unit. The coding state for the
list entries are set to the present state values. If the current control unit has no component list or is not an
UDS control unit the function throws an exception.
Parameters:
Returns:
General response.
Throws:
DiagException - If an error occurs while calling this function or the function is called for a
KWPcontrol unit.
writeGatewayComponentList
public IDiagResult writeGatewayComponentList( IConnectionHandle connectionHandle,
List<IDiagComponentListEntry> componentList)
throws DiagException
Writes the specified gateway components to the currently selected control unit. If the current control unit
has no component list the function throws an exception.
Parameters:
Returns:
General response.
Throws:
writeGatewayComponentListBinary
public IDiagResult writeGatewayComponentListBinary( IConnectionHandle connectionHandle,
byte[] componentListBinary)
throws DiagException
Writes the gateway components for KWP binary. Throws an Exception if called for UDS.
Parameters:
Returns:
General response.
Throws:
DiagException - If an error occurs while calling this function or the function is called for an UDS
control unit.
createProtocolVDSBZD
public String createProtocolVDSBZD( String vin,
String vehicleNumber,
boolean readEventMemory,
String userName,
String measuringLocation,
String measuringType,
Long mileage,
ITotalSystemsInterface.MileageUnit mileageUnit,
List<String> adaptationPresets,
List<String> measurementPresets,
List<String> identificationPresets,
List<String> additionalPresets)
throws DiagException
Parameters:
userName - User name used for login. Maybe null, than user name of looged in user of computer is
used.
Returns:
Throws:
Parameters:
userName - User name used for login. Maybe null, than user name of looged in user of computer is
used.
Returns:
Throws:
Returns:
Throws:
getAvailableAdaptationPresets
public List<String> getAvailableAdaptationPresets()
throws DiagException
Returns:
Throws:
getAvailableMeasurementPresets
public List<String> getAvailableMeasurementPresets()
throws DiagException
Returns:
Throws:
Returns:
Throws:
getAvailableAdditionalPresets
public List<String> getAvailableAdditionalPresets()
throws DiagException
Returns:
Throws:
loginService42
public void loginService42( String user,
String password)
throws DiagException
Parameters:
Throws:
Throws:
readAvailableCarportBrands
public List<String> readAvailableCarportBrands()
throws DiagException
Read teh available brands that may be used when sending protocols to carport (see
ITotalSystemsInterface.sendProtocolsToCarport(List, String, String)).
Returns:
Throws:
sendProtocolsToCarport
public IDiagResultProtocolTransfer sendProtocolsToCarport(List<String> protocolNames,
String taskCode,
String brand)
throws DiagException
Parameters:
taskCode - Action code only used of not yet set in protocol. Maybe null.
brand - the brand of the protocol. Maybe null for automatic brand selection.
Returns:
sendProtocolsToFileServer
public IDiagResultProtocolTransfer sendProtocolsToFileServer( List<String> protocolNames,
String destinationPath)
throws DiagException
Parameters:
Returns:
Throws:
sendProtocolsToVDS
public IDiagResultProtocolTransfer sendProtocolsToVDS(List<String> protocolNames)
throws DiagException
Parameters:
Returns:
Throws:
Parameters:
Returns:
Throws:
setCommParameter
public void setCommParameter( String logicalLink,
String name,
String value)
throws DiagException
Sets the specified communication parameter for the specified logical link. Communication parameters can
be set after a project has been opened. The configuration will be concidered when opening the logical link.
Closing the logical link or connecting to another ecu/logical link will not effect the configuration. The
configuration will be set to its default when opening a project or calling resetCommParameter.
Parameters:
Throws:
setCommParameters
public void setCommParameters(String logicalLink,
Map<String,String> commParams)
throws DiagException
Sets the specified communication parameters for the specified logical link. Communication parameters can
be set after a project has been opened. The configuration will be concidered when opening the logical link.
Closing the logical link or connecting to another ecu/logical link will not effect the configuration. The
configuration will be set to its default when opening a project or calling resetCommParameter.
Parameters:
Throws:
getCommParam
public IDiagResultCommParam getCommParam( IConnectionHandle connectionHandle,
String name)
throws DiagException
Gets the current communication parameter of an opened logical link. The communication parameter can be
get after the logical link has been opened.
Parameters:
connectionHandle - The connection handle of the opened link for which the parameter can be get.
Returns:
Throws:
getCommParams
public List<IDiagResultCommParam> getCommParams(IConnectionHandle connectionHandle)
throws DiagException
Gets the current communication parameters of an opened logical link. The communication parameter can
be get after the logical link has been opened. If the logical link is not open, then an empty list is returned.
Parameters:
connectionHandle - The connection handle of the opened link for which the parameters can be
get.
Returns:
Throws:
getCommParamGroup
public List<IDiagResultCommParam> getCommParamGroup(IConnectionHandle connectionHandle,
List<String> paramNames)
throws DiagException
Gets the current communication parameters of an opened logical link. The communication parameters can
be get after the logical link has been opened.
Parameters:
connectionHandle - The connection handle of the opened link for which the parameters can be
get.
Returns:
Throws:
getCommParamDefault
public IDiagResultCommParam getCommParamDefault(String logicalLink,
String name)
throws DiagException
Gets the default value of the specified communication parameter and logical link from the odx database.
The default communication parameter can be get after a project has been opened.
Parameters:
Returns:
getCommParamsDefault
public List<IDiagResultCommParam> getCommParamsDefault( String logicalLink)
throws DiagException
Gets the default values of all communication parameters for the specified logical link from the odx
database. The default communication parameters can be get after a project has been opened.
Parameters:
Returns:
Throws:
getCommParamGroupDefault
public List<IDiagResultCommParam> getCommParamGroupDefault( String logicalLink,
List<String> paramNames)
throws DiagException
Gets the default value of the specified communication parameters and logical link from the odx database.
The default communication parameters can be get after a project has been opened.
Parameters:
Returns:
Throws:
Gets the modified value of the specified communication parameter and logical link. The default
communication parameter can be get after a project has been opened.
Parameters:
Returns:
Throws:
getCommParamsConfig
public List<IDiagResultCommParam> getCommParamsConfig(String logicalLink)
throws DiagException
Gets the modified communication parameters for the specified logical link. The modified communication
parameters can be get after a project has been opened.
Parameters:
Returns:
Throws:
getCommParamGroupConfig
public List<IDiagResultCommParam> getCommParamGroupConfig(String logicalLink,
List<String> paramNames)
throws DiagException
Gets the modified value of the specified communication parameters and logical link. The default
communication parameter can be get after a project has been opened.
Parameters:
Returns:
Throws:
resetCommParameters
public void resetCommParameters(String logicalLink)
throws DiagException
Resets all communication parameters of the specified logical link to its initial value. Like
setCommParameter changes will not take effect until reopening the logical link.
Parameters:
Throws:
resetCommParameter
public void resetCommParameter( String logicalLink,
String name)
throws DiagException
Resets the specified communication parameter to its initial value. Like setCommParameter changes will not
take effect until reopening the logical link.
Parameters:
Throws:
Resets all communication parameters to their initial values. Like setCommParameter changes will not take
effect until reopening the logical link.
Throws:
setBaudrate
public void setBaudrate(IConfigureCommParamInterface.Baudrate baudrate)
throws DiagException
Parameters:
Throws:
getLockedConnections
public List<IConnectionHandle> getLockedConnections()
throws DiagException
Returns:
Throws:
lockConnection
public void lockConnection( IConnectionHandle connectionHandle)
throws DiagException
Sets a lock for the specified connection. A lock guarantees that the connection stays open while operating
on other connections. Operation calls to other connections will throw an exception when no other
connection can be opened in parallel. If no lock is set the connection can be closed anytime, depending on
the configured number of parallel connections. To set a lock it is necassary to switch into
STAY_CONNECTED_BEHAVIOUR for the connection. A lock can be removed calling unlockConnection. Locks
will also be removed when calling one of the following
operations.closeConnection,setVehicleProject,and any operation working with multipe control units in
parallel such as readAllEventMemories, readMeasurements or createProtocolBZD
Parameters:
Throws:
unlockConnection
public void unlockConnection( IConnectionHandle connectionHandle)
throws DiagException
Parameters:
Throws:
getDoIPVCIs
public List<IDoIPVCI> getDoIPVCIs()
throws DiagException
Returns:
The result list of DoIP VCIs. If no VCI is available the list is empty.
Throws:
Searches DoIP VCIs. If parameter ipAddress is a null or empty string, the search is done with a broadcast.
Otherwise the search is done by IP address. If additional description information is available, than this is
added in IDoIPVCI.getName(). The call is only allowed in diagnostic state INIT.
Parameters:
ipAddress - The parameter has only to be set, if a search by IP should be done. Then a string in
format XXX.XXX.XXX.XXX is expected.
Returns:
The result list of DoIP VCIs. If no VCI is found the list is empty.
Throws:
setCanFDVehicleProject
public void setCanFDVehicleProject( String projectName)
throws DiagException
Sets and loads the vehicle project for CAN-FD. Loading a project is a precondition for connecting to a
control unit.
Parameters:
Throws:
setCanFDVehicleProjectAutomatic
public String setCanFDVehicleProjectAutomatic(IConnectionInterface.PROJECT_MODE projectMode)
throws DiagException
Determines the project for the current vin automatically. If exactly one project is determined, it will be set
and loaded and the project name will be returned. If more than one project is determined a exception will
be thrown.
Parameters:
Throws:
DiagException - If the project is not unique or an error occurs while setting it.
setDoIPVehicleProject
public void setDoIPVehicleProject(IDoIPVCI doIPVCI,
String projectName)
throws DiagException
Sets and loads the vehicle project for DoIP. ATTENTION: Before every call this function a call of
IVehicleSelectionInterface.searchDoIPVCIs(String) must be done, because closing a project
removes the dynamic VCI information. A call of IVehicleSelectionInterface.searchDoIPVCIs(String)
refreshes them. Loading a project is a precondition for connecting to a control unit.
Parameters:
doIPVCI - Identifier to select a DoIP VCI. Try to find a match with all attributes which are not null or
empty string.
Throws:
DiagException - If an error occurs while setting the vehicle project. E.g. if no VCI or more than
one VCI was found for doIPVCI.
setDoIPVehicleProjectAutomatic
public String setDoIPVehicleProjectAutomatic( IDoIPVCI doIPVCI,
IConnectionInterface.PROJECT_MODE projectMode)
throws DiagException
Determines the project for the current vin automatically. If exactly on project is determined, it will be set and
loaded and the project name will be returned. If more than one project is determined a exception will be
thrown.
Parameters:
doIPVCI - Identifier to select a DoIP VCI. Try to find a match with all attributes which are not null or
empty string.
Returns:
DiagException - If the project is not unique or an error occurs while setting it.
setDoIPActivationLine
public void setDoIPActivationLine(boolean toSet)
throws DiagException
Switch to set / unset DoIP activation line if a VCI is selected within the application which supports DoIP and
has a current activation line state unlike NOT_SUPPORTED.
Parameters:
Throws:
unloadProject
public void unloadProject()
throws DiagException
Throws:
getClamp15State
public String getClamp15State()
throws DiagException
Returns:
the clamp 15 state. Possible values are "on", "off", "not available".
Throws:
Returns:
the clamp 30 state. Possible values are "on", "off", "not available".
Throws:
checkVciState
public String checkVciState()
throws DiagException
Returns:
the VCI state. Possible values are "connected", "not connected", "not available".
Throws:
enginGroupInit
public void enginGroupInit( String basicSettingName)
throws DiagException
Initializes the engine diagnosis with the specified settings. The initialization must be called to start the
engine group diagnosis.
Parameters:
Throws:
Switches the mode of operation for engine group. Two operation modes are availalble:
"Fahrzeugsystem in Grundeinstellung" or
"Fahrzeugsystem nicht in Grundeinstellung".
Returns:
Throws:
engineGroupCheck
public List<IDiagResultStatus> engineGroupCheck()
throws DiagException
Returns:
Throws:
engineGroupStart
public List<IDiagResultStatus> engineGroupStart()
throws DiagException
Returns:
The status of the start operation and the measurement values if set.
Throws:
Returns:
Throws:
initProtocol
public void initProtocol()
throws DiagException
Inits protocol.
Throws:
startProtocol
public void startProtocol()
throws DiagException
Starts protocol.
Throws:
stopProtocol
public void stopProtocol()
throws DiagException
Stops protocol.
Throws:
saveProtocol
public void saveProtocol()
throws DiagException
Saves protocol.
Throws:
discardProtocol
public void discardProtocol()
throws DiagException
Discards protocol.
Throws:
executeMacro
public boolean executeMacro(String macroName)
throws DiagException
Executes a macro.
Parameters:
Returns:
TODO
Throws:
Parameters:
Returns:
Throws:
See:
Description
Package de.volkswagen.odis.vaudas.vehiclefunction.automation
Description
Package for common issues of automation.
Class DiagException
de.volkswagen.odis.vaudas.vehiclefunction.automation
java.lang.Object
java.lang.Throwable
java.lang.Exception
de.volkswagen.odis.vaudas.vehiclefunction.automation.DiagException
extends Exception
This exception provides a base for all exceptions thrown by this plugin.
Method Summary
String
getErrorId() 1
3
2
String
getLocalizedMessage() 1
3
1
String
getLocalizedMsg() 1
3
1
Method Detail
getLocalizedMessage
public String getLocalizedMessage()
Overrides:
getLocalizedMsg
public String getLocalizedMsg()
Returns:
the localized message. Only necessary for web service use. Method getLocalizedMessage() could
not be used because override Exception method.
getErrorId
public String getErrorId()
Returns:
Interface for handling data creation and transfer of ecu state informaton.
Method Summary
List<String>
readAvailableCarportBrands() 1
3
Read teh available brands that may be used when sending protocols to
carport (see sendProtocolsToCarport(List, String, String)). 7
List<IDiagResultEventMemory>
readEventMemories(List<Integer> controlUnitList, List<String>
adaptationPresets, List<String> measurementPresets, List<String> 1
identificationPresets, List<String> additionalPresets) 3
6
Reads the event memory entries of the specified control unit list.
void
resetEventMemories(Boolean clearOBD, Boolean clearFunctional,
Boolean clearNotErasedECUsPhysical, Integer timeBeforePhysicalClear, 1
List<Integer> unitListForPhysicalDeletion)
3
Tries to delete the event memories in the vehicle by sending a sequence of 5
diagnostic services.
Method Detail
resetEventMemories
void resetEventMemories(Boolean clearOBD,
Boolean clearFunctional,
Boolean clearNotErasedECUsPhysical,
Integer timeBeforePhysicalClear,
List<Integer> unitListForPhysicalDeletion)
throws DiagException
Tries to delete the event memories in the vehicle by sending a sequence of diagnostic services. First
optional sending the functional OBD-Service 0x04 followed by a TP2.0-broadcast and a functional UDS-
service 0x14. Finally all control units of the specified unit list are cleared physically, which KD-Bit is set in
the gateway component list. If the unit list is null or empty, then all units with a set KD-Bit are cleared. All
deletion steps can be deactivated by the function arguments.
Parameters:
clearNotErasedECUsPhysical - Switch for physically deletion of all defined units, which KD-Bit is
set in the gateway component list.
unitListForPhysicalDeletion - The unit list, which is be considered for the physical deletion. If
the list is empty or null, then all units of the gateway component list are considered.
Throws:
readEventMemories
List<IDiagResultEventMemory> readEventMemories(List<Integer> controlUnitList,
List<String> adaptationPresets,
List<String> measurementPresets,
List<String> identificationPresets,
List<String> additionalPresets)
throws DiagException
Reads the event memory entries of the specified control unit list. If the unit list is null or empty, then all
available control units are read. In addition, measurements and adaptations can be defined for reading.
Parameters:
Returns:
Throws:
Read teh available brands that may be used when sending protocols to carport (see
sendProtocolsToCarport(List, String, String)).
Returns:
Throws:
See:
Description
Package
de.volkswagen.odis.vaudas.vehiclefunction.automation.types
Description
Return types and input types of automation interface functions.
Interface IConnectionHandle
de.volkswagen.odis.vaudas.vehiclefunction.automation.types
Method Summary
Long
getHandle() 1
3
Return the handle for identifying a connection.
9
Method Detail
getHandle
Long getHandle()
Returns:
Input parameter object for settting the coding state of a control unit in the gateway component list. For writing the
coding state use the function writeGatewayComponentList.
Method Summary
int
getEcuId() 1
4
Return the diagnostic address of the entry.
0
int
getListPosition() 1
4
Returns the list position in the gateway component list of this entry.
1
long
getNodeId() 1
4
Returns the node address of this entry.
1
boolean
isCoded() 1
4
Checks if the state of this entry is coded.
2
boolean
isListPositionAvailable() 1
4
Is the value for list position available and can be used..
1
boolean
isNodeIdAvailable() 1
4
Is the value for node id available and can be used..
1
void
setCoded(boolean coded) 1
4
Sets the coded state for this entry.
2
Method Detail
getEcuId
int getEcuId()
Returns:
Returns:
isNodeIdAvailable
boolean isNodeIdAvailable()
Returns:
getListPosition
int getListPosition()
Returns the list position in the gateway component list of this entry.
Returns:
isListPositionAvailable
boolean isListPositionAvailable()
Returns:
Returns:
setCoded
void setCoded(boolean coded)
Parameters:
Method Summary
List<IDiagMeasurementDescriptor>
getMeasurements() 1
4
Returns the list of configured measurements.
4
Map<String,String>
getParameters() 1
4
Returns the parameter list.
3
String
getShortName() 1
4
Returns the short name of the descriptor.
3
Method Detail
getShortName
String getShortName()
Returns:
getParameters
Map<String,String> getParameters()
Returns:
Returns:
Method Summary
List<String>
getMeasurements() 1
4
Returns the list of configured measurements.
6
Map<String,String
>
getParameters() 1
4
Returns the parameter list.
5
String
getShortName() 1
4
Returns the short name of the descriptor.
5
Method Detail
getShortName
String getShortName()
Returns:
getParameters
Map<String,String> getParameters()
Returns:
Returns:
Method Summary
IConnectionHandle
getConnectionHandle() 1
4
Delivers the handle to identify connection.
7
String
getContainerPath() 1
4
Delivers the flash container file path of this descriptor.
7
String
getSessionName() 1
4
Delivers the session name of this descriptor.
8
Boolean
isCheckSessionWithEcu() 1
4
State of switch if check is activated for UDS on expected idents and for KWP on part
number and software version. 8
Method Detail
getConnectionHandle
IConnectionHandle getConnectionHandle()
Returns:
getContainerPath
String getContainerPath()
Returns:
Returns:
isCheckSessionWithEcu
Boolean isCheckSessionWithEcu()
State of switch if check is activated for UDS on expected idents and for KWP on part number and software
version.
Returns:
Method Summary
long
getEcuAddress() 1
4
Retrieves the address of this descriptor's control unit.
9
String
getGroup() 1
4
Retrieves this despriptor's measurement group.
9
String
getParameter() 1
5
Retrieves this despriptor's measurement parameter.
0
Method Detail
getEcuAddress
long getEcuAddress()
Returns:
The address.
getGroup
String getGroup()
Returns:
Returns:
Method Summary
String
getAdaption() 1
5
Retrieves this despriptor's adaption name.
1
IMultilinkEcuHandl
e
getMultilinkEcuHandle() 1
5
Retrieves the handle of this descriptor's control unit.
1
Method Detail
getMultilinkEcuHandle
IMultilinkEcuHandle getMultilinkEcuHandle()
Returns:
The address.
getAdaption
String getAdaption()
Returns:
Method Summary
Map<String,String>
getAdaptationValues() 1
5
Retrieves the adaptation values which shall be written.
2
IDiagMultiAdaptionDescriptor
getAdaptionDescriptor() 1
5
Retrieves the descriptor for the adaptation.
2
Method Detail
getAdaptionDescriptor
IDiagMultiAdaptionDescriptor getAdaptionDescriptor()
Returns:
getAdaptationValues
Map<String,String> getAdaptationValues()
Returns:
Method Summary
String
getByteCoding() 1
5
Return the coding value as byte coding value.
4
IDiagResultValue.ValueType
getByteCodingValueType() 1
5
Returns the value type of the byte coding.
5
IMultilinkEcuHandle
getMultilinkEcuHandle() 1
5
Retrieves the handle of this descriptor's control unit.
3
String
getSystemName() 1
5
Returns the system name of the control unit.
4
Map<String,String>
getTextCoding() 1
5
Returns a plain text representation of the coding value.
4
Boolean
isEcuReset() 1
5
Checks the execution of a ecu reset after coding process.
4
Method Detail
getMultilinkEcuHandle
IMultilinkEcuHandle getMultilinkEcuHandle()
Returns:
The address.
isEcuReset
Boolean isEcuReset()
Returns:
getSystemName
String getSystemName()
Returns the system name of the control unit. For a master control unit the name master will be returned.
For uds slaves the short name of the subsystem will be returned and for kwp slaves the index of the
subsystem will returned with prefix subSys starting with index 0 like subSys0.
Returns:
getTextCoding
Map<String,String> getTextCoding()
Returns a plain text representation of the coding value. The function is only defined for uds control units.
For kwp control units an empty dictionary returns. One entry of the result contains a pair of values. Each
entry of the key-value-pairs contains the shortname of the coding entry and the new coding value.
Returns:
getByteCoding
String getByteCoding()
Return the coding value as byte coding value. Is valid for kwp and uds control units.
Returns:
Returns the value type of the byte coding. Can be ValueType.INT for a KWP short coding value or
ValueType.BYTEFIELD for a KWP long coding and UDS coding value.
Returns:
Method Summary
String
getGroup() 1
5
Retrieves this despriptor's measurement group.
6
IMultilinkEcuHandl
e
getMultilinkEcuHandle() 1
5
Retrieves the handle of this descriptor's control unit.
6
String
getParameter() 1
5
Retrieves this despriptor's measurement parameter.
7
Method Detail
getMultilinkEcuHandle
IMultilinkEcuHandle getMultilinkEcuHandle()
Returns:
The address.
getGroup
String getGroup()
Returns:
Returns:
Method Summary
List<IDiagSoftwareCompositionComponentListEntry>
getCodingList() 1
5
Retrieves the composition components that should be
coded. 8
IMultilinkEcuHandle
getMultilinkEcuHandle() 1
5
Retrieves the handle of this descriptor's control unit.
8
Method Detail
getMultilinkEcuHandle
IMultilinkEcuHandle getMultilinkEcuHandle()
Returns:
The address.
getCodingList
List<IDiagSoftwareCompositionComponentListEntry> getCodingList()
Returns:
Method Summary
IDiagResultNegativeResponse
getNegativeResult() 1
5
9
void
setNegativeResult(IDiagResultNegativeResponse 1
negativeResult)
5
Sets the negative response object.. 9
Method Detail
getNegativeResult
IDiagResultNegativeResponse getNegativeResult()
Returns:
setNegativeResult
void setNegativeResult(IDiagResultNegativeResponse negativeResult)
Parameters:
All Superinterfaces:
IDiagResult, IDiagResultTable
Method Summary
List<IDiagResultAdaptationValue>
getAdaptationValues() 1
6
1
long
getEcuAddress() 1
6
Retrieves the address of the control unit for which this result holds the
values. 0
String
getErrorMessage() 1
Returns a message of the error occured while reading the adaptation
6
using readMultilinkAdaptation. 1
String
getLogicalLinkname() 1
6
Retrieves the logical linkname of the control unit for which this result holds
the values. 1
String
getRecordDataIdentifier() 1
6
Returns the record data identifier of the executed service.
1
Method Detail
getEcuAddress
long getEcuAddress()
Retrieves the address of the control unit for which this result holds the values.
Returns:
The address.
getLogicalLinkname
String getLogicalLinkname()
Retrieves the logical linkname of the control unit for which this result holds the values.
Returns:
The address.
getErrorMessage
String getErrorMessage()
Returns a message of the error occured while reading the adaptation using readMultilinkAdaptation. If
no error occured the function returns an emtpy string.
Returns:
getRecordDataIdentifier
String getRecordDataIdentifier()
Returns the record data identifier of the executed service. Returns an empty string if no record data
identifier is available.
Returns:
getAdaptationValues
List<IDiagResultAdaptationValue> getAdaptationValues()
Returns:
Adaptation values.
Interface IDiagResultAdaptationValue
de.volkswagen.odis.vaudas.vehiclefunction.automation.types
Method Summary
IDiagResultValue
getAdaptationValue() 1
6
Returns the read adaption value.
3
List<IDiagResultValue>
getMeasuredValues() 1
6
Returns the list of measured values returned from the control unit while reading the
adaptation value. 3
String
getRecordDataIdentifier() 1
6
Returns the record data identifier of the executed service.
4
Method Detail
getAdaptationValue
IDiagResultValue getAdaptationValue()
Returns:
getMeasuredValues
List<IDiagResultValue> getMeasuredValues()
Returns the list of measured values returned from the control unit while reading the adaptation value.
Returns:
Returns the record data identifier of the executed service. Returns an empty string if no record data
identifier is available.
Returns:
All Superinterfaces:
IDiagResult
extends IDiagResult
Represents the coding value read from a control unit. Contains the (sub)system name of the control unit, the coding
value as byte array and a plain text representation.
Method Summary
String
getByteCoding() 1
6
Return the coding value as byte coding value.
6
IDiagResultValue.ValueType
getByteCodingValueType() 1
6
Returns the value type of the byte coding.
7
long
getEcuAddress() 1
6
Returns the address of the control unit.
6
String
getErrorMessage() 1
Returns the message of the error occured while reading the coding values using
6
readMultilinkCoding. 7
String
getLogicalLinkname() 1
6
Returns the logical linkname of the control unit.
6
String
getSystemName() 1
6
The system name of the control unit.
6
Map<String,String>
getTextCoding() 1
6
Returns a plain text representation of the coding value.
7
Method Detail
getEcuAddress
long getEcuAddress()
Returns:
The address.
getLogicalLinkname
String getLogicalLinkname()
Returns:
The address.
getSystemName
String getSystemName()
The system name of the control unit. For a master control unit the name master will be returned. For uds
slaves the short name of the subsystem will be returned and for kwp slaves the index of the subsystem will
returned with prefix subSys starting with index 0 like subSys0.
Returns:
getByteCoding
String getByteCoding()
Return the coding value as byte coding value. Is valid for kwp and uds control units.
Returns:
Returns the message of the error occured while reading the coding values using readMultilinkCoding. If
no error occured the function returns an emtpy string.
Returns:
getByteCodingValueType
IDiagResultValue.ValueType getByteCodingValueType()
Returns the value type of the byte coding. Can be ValueType.INT for a KWP short coding value or
ValueType.BYTEARRAY for a KWP long coding and UDS coding value.
Returns:
getTextCoding
Map<String,String> getTextCoding()
Returns a plain text representation of the coding value. The function is only defined for uds control units.
For kwp control units an empty dictionary returns. One entry of the result contains a pair of values. The first
value is the shortname of the coding entry, the second is the coding value.
Returns:
Method Summary
String
getParamName() 1
6
Delivers the name of the communication parameter.
8
String
getParamValue() 1
6
Delivers the value of the communication parameter.
8
Method Detail
getParamValue
String getParamValue()
Returns:
getParamName
String getParamName()
Returns:
Method Summary
byte[]
getByteCoding() 1
6
9
List<IDiagResultComponentListEntry>
getComponentListEntries() 1
6
Returns the list component entries.
9
Method Detail
getByteCoding
byte[] getByteCoding()
Returns:
getComponentListEntries
List<IDiagResultComponentListEntry> getComponentListEntries()
Returns:
Method Summary
IDiagResultValue
getBusIdentifier() 1
7
Returns the ODX information for the bus identifier (0x2A2D).
7
IDiagResultValue
getCodedState() 1
7
Returns the ODX information for the coded bit (0x04A3).
4
IDiagResultValue
getDtcInfo() 1
7
Returns the ODX information for the dtc bit (0x2A28).
5
int
getEcuId() 1
7
Return the diagnostic address of the entry.
2
IDiagResultValue
getEcuIdInformation() 1
7
Returns the ODX information for the ecu id.
2
IDiagResultComponentListEntry.EntryType
getEntryType() 1
7
Gets type of the entry.
7
int
getListPosition() 1
7
Returns the list position in the gateway component list of this entry.
3
long
getNodeId() 1
7
Returns the node address of this entry.
2
IDiagResultValue
getNodeIdInformation() 1
7
Returns the ODX information for the node id.
3
IDiagResultValue
getPresentState() 1
7
Returns the ODX information for the present bit (0x2A26).
4
List<IDiagResultValue>
getProtocolInformation() 1
7
Returns the ODX information for the protocol entry (0x2A29).
6
IDiagResultValue
getSleepBit() 1
7
Returns the ODX information info for the sleep bit (0x2A27).
5
IDiagResultValue
getTPIdentifier() 1
7
Returns the ODX information for the TP-CAN-Identifier (0x2A2C).
6
boolean
isBusIdentifierAvailable() 1
7
Returns if the bus identifier is available.
7
boolean
isCoded() 1
7
Checks if the state of this entry is coded.
4
boolean
isCodedStateAvailable() 1
7
Returms if the coded state information is available.
4
boolean
isDtcInfoAvailable() 1
7
Checks if the dtc information is available.
5
boolean
isEcuIdInformationAvailable() 1
7
2
boolean
isListPositionAvailable() 1
7
Checks if the list position is available for this entry.
3
boolean
isNodeIdAvailable() 1
7
Checks if a node id is available for this entry.
3
boolean
isPresentStateAvailable() 1
7
Returns if present state information is available.
4
boolean
isProtocolInformationAvailable() 1
7
Checks if the protocol information is available.
6
boolean
isSleepBitAvailable() 1
7
Checks if the sleep bit is available for this entry.
5
boolean
isTPIdentifierAvailable() 1
7
Returns if the tp identifier is available.
6
Method Detail
getEcuId
int getEcuId()
Returns:
isEcuIdInformationAvailable
boolean isEcuIdInformationAvailable()
Returns:
getEcuIdInformation
IDiagResultValue getEcuIdInformation()
Returns the ODX information for the ecu id. Return value is only valid if isEcuIdInformationAvailable
returns true. Otherwise an empty result returns.
Returns:
getNodeId
long getNodeId()
Returns:
Returns:
getNodeIdInformation
IDiagResultValue getNodeIdInformation()
Returns the ODX information for the node id. Return value is only valid if isNodeIdAvailable returns true.
Otherwise an empty result value returns.
Returns:
getListPosition
int getListPosition()
Returns the list position in the gateway component list of this entry.
Returns:
isListPositionAvailable
boolean isListPositionAvailable()
Returns:
Returns:
getCodedState
IDiagResultValue getCodedState()
Returns:
isCodedStateAvailable
boolean isCodedStateAvailable()
Returns:
getPresentState
IDiagResultValue getPresentState()
Returns:
isPresentStateAvailable
boolean isPresentStateAvailable()
Returns if present state information is available.
Returns:
getSleepBit
IDiagResultValue getSleepBit()
Returns the ODX information info for the sleep bit (0x2A27).
Returns:
isSleepBitAvailable
boolean isSleepBitAvailable()
Returns:
isDtcInfoAvailable
boolean isDtcInfoAvailable()
Returns:
getDtcInfo
IDiagResultValue getDtcInfo()
isProtocolInformationAvailable
boolean isProtocolInformationAvailable()
Returns:
getProtocolInformation
List<IDiagResultValue> getProtocolInformation()
Returns:
isTPIdentifierAvailable
boolean isTPIdentifierAvailable()
Returns:
getTPIdentifier
IDiagResultValue getTPIdentifier()
Returns:
Returns:
getBusIdentifier
IDiagResultValue getBusIdentifier()
Returns:
getEntryType
IDiagResultComponentListEntry.EntryType getEntryType()
Returns:
Method Summary
String
getActiveEcuVariant() 1
8
Returns the detected odx variant of this control unit.
0
IConnectionHandle
getConnectionHandle() 1
7
Returns handle for following control unit dependent calls.
9
IDiagResultConnectEcu.DiagnosticProtocol
getDiagnosticProtocol() 1
8
Returns the used protocol.
1
String
getEcuId() 1
8
Returns diagnostic address of the connected control unit as a
hexadecimal string. 0
String
getEcuName() 1
8
Retuns the translated control unit name of the connect ecu.
0
String
getLogicalLinkname() 1
8
Retuns the logical linkname of the connect ecu.
0
Method Detail
getConnectionHandle
IConnectionHandle getConnectionHandle()
Returns:
Returns:
getEcuId
String getEcuId()
Returns diagnostic address of the connected control unit as a hexadecimal string. For the ecu address 1
the string "0x01" will be returned,
Returns:
getActiveEcuVariant
String getActiveEcuVariant()
Returns:
getLogicalLinkname
String getLogicalLinkname()
Returns:
Returns:
All Superinterfaces:
IDiagResult
extends IDiagResult
Represents the result of the container verification and the dataset download.
Method Summary
long
getEcuAddress() 1
8
Delivers the address of the control unit.
3
String
getErrorID() 1
8
Delivers the error-id of the occurred error.
4
String
getErrorMessage() 1
8
Delivers the translated message of the occurred error.
4
String
getLogicalLinkname() 1
8
Delivers the logical linkname of the control unit.
4
boolean
isErrorOccured() 1
8
Checks for an occured error.
4
Method Detail
getEcuAddress
long getEcuAddress()
Returns:
The address.
getLogicalLinkname
String getLogicalLinkname()
Returns:
The address.
getErrorMessage
String getErrorMessage()
Returns:
getErrorID
String getErrorID()
Returns:
isErrorOccured
boolean isErrorOccured()
Checks for an occured error.
Returns:
All Superinterfaces:
IDiagResult
extends IDiagResult
Method Summary
int
getDtcValue() 1
8
Returns the dtc value of this snapshot record.
8
int
getEcuId() 1
8
Returns the id of the control unit from which the event memory was read.
7
String
getEcuName() 1
8
Returns the name of the control unit from which the event memory was read.
7
String
getErrorMessage() 1
Returns a message of the error occured while reading the snapshot records
8
using readEventMemorySnapshots. 7
String
getLogicalLinkname() 1
8
Returns the logical linkname of the control unit from which the event memory
was read. 7
int
getSnapshotRecordNumber() 1
8
Returns the number of this snapshot record.
8
List<IDiagResultMeasurement>
getSnapshotValues() 1
8
Returns the (measurement) values of this snapshot record.
8
Method Detail
getEcuId
int getEcuId()
Returns the id of the control unit from which the event memory was read.
Returns:
getEcuName
String getEcuName()
Returns the name of the control unit from which the event memory was read.
Returns:
getLogicalLinkname
String getLogicalLinkname()
Returns the logical linkname of the control unit from which the event memory was read.
Returns:
getErrorMessage
String getErrorMessage()
Returns a message of the error occured while reading the snapshot records using
readEventMemorySnapshots. If no error occured the function returns an emtpy string.
Returns:
Returns:
getDtcValue
int getDtcValue()
Returns:
getSnapshotRecordNumber
int getSnapshotRecordNumber()
Returns:
All Superinterfaces:
IDiagResult
extends IDiagResult
Method Summary
List<IDiagResultDtcSnapshot>
getDtcSnapshotRecords() 1
8
Returns the list of snapshot records.
9
Method Detail
getDtcSnapshotRecords
List<IDiagResultDtcSnapshot> getDtcSnapshotRecords()
Returns:
Method Summary
int
getBitPosition() 1
9
Return the position of the bit beginning with 0.
0
String
getBitPositionText() 1
9
Return the position as String which is displayed in the GUI.
0
String
getBitValueText() 1
9
Return the value as String which is displayed in the GUI.
1
boolean
isBitSet() 1
9
Return the value as boolean.
1
Method Detail
getBitPosition
int getBitPosition()
Returns:
getBitPositionText
String getBitPositionText()
Returns:
Returns:
getBitValueText
String getBitValueText()
Returns:
Represents the environment data of an event memory entry. There are two kind of environment entries, the
standard environment conditions and additionl measurement values.
Method Summary
List<IDiagResultValue>
getMeasurements() 1
9
Returns the list of measurement value conditions.
2
List<IDiagResultDtcSnapshot>
getSnapshotRecords() 1
9
Returns the list of snapshot records.
3
List<IDiagResultStandardEnvironmentCondition>
getStandardData() 1
9
Returns the list of standard environment conditions.
2
Method Detail
getStandardData
List<IDiagResultStandardEnvironmentCondition> getStandardData()
Returns:
getMeasurements
List<IDiagResultValue> getMeasurements()
Returns:
Returns:
All Superinterfaces:
IDiagResultValue
extends IDiagResultValue
Method Summary
IDiagResultEventInfo.EventInfoType
getEventInfoType() 1
9
Retrurns the type of this event info.
4
Method Detail
getEventInfoType
IDiagResultEventInfo.EventInfoType getEventInfoType()
Returns:
All Superinterfaces:
IDiagResult
extends IDiagResult
Represents the result of an event memory read operation. It contains an id of the ecu from which the event memory
was read and a list of event memory entries.
Method Summary
int
getEcuId() 1
9
Returns the id of the control unit from which the event memory was read.
6
String
getEcuName() 1
9
Returns the name of the control unit from which the event memory was
read. 7
String
getErrorMessage() 1
Returns a message of the error occured while reading the event memory
9
using readAllEventMemories. 7
List<IDiagResultEventMemoryEntry>
getEventMemoryEntries() 1
9
Returns the list of event memory entries from the ecu.
7
String
getLogicalLinkname() 1
9
Returns the logical linkname of the control unit from which the event
memory was read. 7
Method Detail
getEcuId
int getEcuId()
Returns the id of the control unit from which the event memory was read.
Returns:
getEcuName
String getEcuName()
Returns the name of the control unit from which the event memory was read.
Returns:
getLogicalLinkname
String getLogicalLinkname()
Returns the logical linkname of the control unit from which the event memory was read.
Returns:
getErrorMessage
String getErrorMessage()
Returns a message of the error occured while reading the event memory using readAllEventMemories. If
no error occured or the event mory was not read by readAllEventMemories the function returns an emtpy
string.
Returns:
getEventMemoryEntries
List<IDiagResultEventMemoryEntry> getEventMemoryEntries()
Returns the list of event memory entries from the ecu. If the ecu has no event memory the funciton returns
an empty list.
Returns:
Since:
26-Mrz-2010 12:51:13
Method Summary
String
getDevMemorySelection() 2
0
The memory selection for a developer DTC.
1
List<IDiagResultDtcState>
getDtcStates() 1
9
Returns the interpreted state record byte.
9
IDiagResultEnvironmentData
getEnvironmentData() 2
0
Returns the environment conditions of this event memory entry.
0
List<IDiagResultEventInfo>
getEventInfos() 2
0
Returns a list of detailed information about the event memory entry, for example
the event code and the event text. 0
long
getUdsState() 2
0
The uds-specific dtc-state.
0
boolean
isDevDTCEntry() 2
0
The flag 'developer DTC'.
0
Method Detail
getDtcStates
List<IDiagResultDtcState> getDtcStates()
Returns the interpreted state record byte. Every bit from the state record has its entry in the result list. The
state record will only return for UDS control units, for KWP control an empty list will return.
Returns:
Returns:
getEventInfos
List<IDiagResultEventInfo> getEventInfos()
Returns a list of detailed information about the event memory entry, for example the event code and the
event text.
Returns:
getUdsState
long getUdsState()
Returns:
The udsState.
isDevDTCEntry
boolean isDevDTCEntry()
Returns:
the flag
getDevMemorySelection
String getDevMemorySelection()
The memory selection for a developer DTC. Empty if no selection or no developer DTC.
Returns:
memory selection
Interface IDiagResultFlashProgramming
de.volkswagen.odis.vaudas.vehiclefunction.automation.types
All Superinterfaces:
IDiagResult
extends IDiagResult
Method Summary
List<IDiagResultFlashSession>
getSessionResultList() 2
0
Delivers the result list of all flashed sessions.
2
Method Detail
getSessionResultList
List<IDiagResultFlashSession> getSessionResultList()
Returns:
All Superinterfaces:
IDiagResult
extends IDiagResult
Method Summary
String
getContainerPath() 2
0
Delivers the file path of the flash container.
4
long
getContainerSize() 2
0
Delivers the file size of the flash container (bytes).
5
long
getDuration() 2
0
Delivers the duration of the running flash process (seconds).
5
int
getEcuId() 2
0
Delivers the ecu-id (address) of the flashed control unit.
4
String
getErrorMessage() 2
0
Delivers the error message or an empty string.
5
List<IDiagResultPreCondition>
getNotCompliedPreConditions() 2
0
Delivers the not complied preconditions of a kwp flash process.
4
String
getSessionName() 2
0
Delivers the session name.
4
boolean
isErrorOccurred() 2
0
Delivers the result of the flash process.
5
Method Detail
getEcuId
int getEcuId()
Returns:
getContainerPath
String getContainerPath()
Returns:
getSessionName
String getSessionName()
Returns:
getNotCompliedPreConditions
List<IDiagResultPreCondition> getNotCompliedPreConditions()
Returns:
Returns:
isErrorOccurred
boolean isErrorOccurred()
Returns:
getDuration
long getDuration()
Returns:
getContainerSize
long getContainerSize()
Returns:
Method Summary
Long
getEcuAddress() 2
0
Returns diagnostic address of the currently control unit.
7
String
getErrorMessage() 2
Returns a message of the error occured while reading the
0
event memory using readMultilinkIdentification. 8
List<IDiagResultValue>
getExtendedData() 2
0
Returns a list of extended identification data.
8
IDiagResultIdentification.IdentificationDataType
getIdentificationDataType() 2
0
Returns type of identification data.
7
String
getLogicalLinkname() 2
0
Retuns the logical linkname of the currently control unit.
7
List<IDiagResultValue>
getSoftwareComponentData() 2
0
Returns a list of software component identification data.
8
List<IDiagResultValue>
getStandardData() 2
0
Returns the standard identification data read from the
system. 7
String
getSystemName() 2
0
The system name of the control unit.
6
Method Detail
getSystemName
String getSystemName()
The system name of the control unit. For a master control unit the name master will be returned. For uds
slaves the short name of the subsystem will be returned and for kwp slaves the index of the subsystem will
returned with prefix subSys starting with index 0 like subSys0.
Returns:
getIdentificationDataType
IDiagResultIdentification.IdentificationDataType getIdentificationDataType()
Returns:
getEcuAddress
Long getEcuAddress()
Returns:
getLogicalLinkname
String getLogicalLinkname()
Returns:
getStandardData
List<IDiagResultValue> getStandardData()
getExtendedData
List<IDiagResultValue> getExtendedData()
Returns:
getSoftwareComponentData
List<IDiagResultValue> getSoftwareComponentData()
Returns:
getErrorMessage
String getErrorMessage()
Returns a message of the error occured while reading the event memory using
readMultilinkIdentification. If no error occured the function returns an emtpy string.
Returns:
Method Summary
IDiagResultIdentification.IdentificationDataType
getIdentificationDataType() 2
1
0
String
getShortName() 2
1
0
Method Detail
getIdentificationDataType
IDiagResultIdentification.IdentificationDataType getIdentificationDataType()
Returns:
getShortName
String getShortName()
Returns:
Short name.
Interface IDiagResultMeasurement
de.volkswagen.odis.vaudas.vehiclefunction.automation.types
All Superinterfaces:
IDiagResult, IDiagResultTable
extends IDiagResultTable
Method Summary
long
getEcuAddress() 2
1
Retrieves the address of the control unit for which this result holds the values.
1
String
getErrorMessage() 2
Returns a message of the error occured while reading the measurement using
1
readMultilinkMeasurement. 3
String
getLogicalLinkname() 2
1
Retrieves the logical linkname of the control unit for which this result holds the
values. 2
String
getMeasurementGroup() 2
1
Retrieves the measurement group for which this result holds the values.
2
List<IDiagResultValue>
getMeasurements() 2
1
2
String
getRecordDataIdentifier() 2
1
Returns the record data identifier of the executed service.
2
Method Detail
getEcuAddress
long getEcuAddress()
Retrieves the address of the control unit for which this result holds the values.
Returns:
The address.
getLogicalLinkname
String getLogicalLinkname()
Retrieves the logical linkname of the control unit for which this result holds the values.
Returns:
The address.
getMeasurementGroup
String getMeasurementGroup()
Retrieves the measurement group for which this result holds the values.
For UDS this ist the ODX short name of the measurement group,
for KWP this is the block number, given as string: e.g. "12".
Returns:
getMeasurements
List<IDiagResultValue> getMeasurements()
Returns:
Measurements.
getRecordDataIdentifier
String getRecordDataIdentifier()
Returns the record data identifier of the executed service. Returns an empty string if no record data
identifier is available.
Returns:
getErrorMessage
String getErrorMessage()
Returns a message of the error occured while reading the measurement using
readMultilinkMeasurement. If no error occured the function returns an emtpy string.
Returns:
All Superinterfaces:
IDiagResult
extends IDiagResult
Method Summary
byte[]
getMemoryCells() 2
1
Returns the list of memory cells.
4
Method Detail
getMemoryCells
byte[] getMemoryCells()
Returns:
All Superinterfaces:
IDiagResult
extends IDiagResult
Method Summary
Long
getEcuAddress() 2
1
6
String
getErrorMessage() 2
1
6
String
getFunctionName() 2
1
6
String
getLogicalLinkname() 2
1
5
Long
getTimestamp() 2
1
6
Method Detail
getLogicalLinkname
String getLogicalLinkname()
Returns:
Returns:
getErrorMessage
String getErrorMessage()
Returns:
getFunctionName
String getFunctionName()
Returns:
The name of the executed function (e.g. the adaption channel or the name of subsystem or the
measurement name).
getTimestamp
Long getTimestamp()
Returns:
Method Summary
int
getNRC() 2
1
7
int
getSID() 2
1
7
String
getTranslatedMessage() 2
1
8
boolean
isNegativeResponse() 2
1
8
Method Detail
getNRC
int getNRC()
Returns:
The negative response code. Returns 0x00 if the id is not available or isNegativeResponse
returns false.
getSID
int getSID()
Returns:
The corresponding service id. Returns 0x00 if the id is not available or isNegativeResponse
returns false.
getTranslatedMessage
String getTranslatedMessage()
Returns:
The translated message for the occured negative response or an empty string if
isNegativeResponse returns false.
isNegativeResponse
boolean isNegativeResponse()
Returns:
Method Summary
String
getDate() 2
1
Date of the last change in ISO-8601 format or yyyy-MM-dd'T'HH:mm:ss.
9
String
getErrorFlag() 2
2
Returns error code of a project entry.
0
String
getName() 2
1
Returns name of the ODX project / name of directory.
9
String
getRevision() 2
2
Returns revision number of ODX file.
0
String
getState() 2
2
Returns state of get ODX version operation.
0
Method Detail
getName
String getName()
Returns:
getDate
String getDate()
Date of the last change in ISO-8601 format or yyyy-MM-dd'T'HH:mm:ss. Example: 2010-01-
18T12:38:23.000+01:00
Returns:
getRevision
String getRevision()
Returns:
getState
String getState()
Returns:
getErrorFlag
String getErrorFlag()
Returns error code of a project entry. The following values are possible:
Returns:
Method Summary
String
getTranslation() 2
2
Delivers the translated text of the parameter value.
3
String
getValue() 2
2
Delivers the value of the object as string.
2
String
getValueId() 2
2
Delivers the value as a translatable text id.
2
Method Detail
getValue
String getValue()
Returns:
The value.
getValueId
String getValueId()
Returns:
Returns:
Method Summary
String
getTextID() 2
2
Delivers the text-id of the precondition.
5
String
getTranslatedText() 2
2
Delivers the translated text of the precondition.
4
int
getValue() 2
2
Delivers the value of the precondition.
4
Method Detail
getValue
int getValue()
Returns:
getTranslatedText
String getTranslatedText()
Returns:
Returns:
Method Summary
List<IDiagResultProtocolTransferEntry>
getProtocolTransferEntries() 2
2
6
Method Detail
getProtocolTransferEntries
List<IDiagResultProtocolTransferEntry> getProtocolTransferEntries()
Returns:
Item of IDiagResultProtocolTransfer.
Method Summary
String
getMessage() 2
2
8
String
getProtocolName() 2
2
7
IDiagResultProtocolTransferEntry.TransferResultState
getResultState() 2
2
7
Method Detail
getProtocolName
String getProtocolName()
Returns:
getResultState
IDiagResultProtocolTransferEntry.TransferResultState getResultState()
Returns:
Returns:
Method Summary
List<IDiagResultRawServiceResponse>
getRawServiceResponses() 2
3
Returns the list of ecu responses.
0
Method Detail
getRawServiceResponses
List<IDiagResultRawServiceResponse> getRawServiceResponses()
Returns:
Method Summary
byte[]
getResponsePDU() 2
3
Returns the response of the ecu.
1
String
getVariantName() 2
3
Returns the variant name of the responding ecu.
1
Method Detail
getResponsePDU
byte[] getResponsePDU()
Returns:
getVariantName
String getVariantName()
Returns:
Represents a single roll mode entry; i.e. the roll mode information on a single ecu.
Method Summary
String
getAdditionalText() 2
3
Text holding aditional information.
3
int
getEcuId() 2
3
Return the diagnostic address of this entry's ecu.
2
String
getEcuName() 2
3
Return the translated name of this entry's ecu.
3
IDiagResultRollModeEntry.RollModeState
getState() 2
3
Return this entry's roll mode state.
3
long
getTimestamp() 2
3
Retrieves the date / time of this entry's latest modification.
4
boolean
isAdditionalTextError() 2
3
Checks if the additional text describes an error or just
normal" info. 3
boolean
isNRCSignaled() 2
3
Returns if this entry's ECU has responded with an NRC lately.
4
Method Detail
getEcuId
int getEcuId()
getEcuName
String getEcuName()
Returns:
getState
IDiagResultRollModeEntry.RollModeState getState()
Returns:
The state.
getAdditionalText
String getAdditionalText()
Returns:
isAdditionalTextError
boolean isAdditionalTextError()
Returns:
Returns:
getTimestamp
long getTimestamp()
Returns:
The time of latest modification as milliseconds since January 1, 1970, 00:00:00 GMT.
Enum IDiagResultRollModeEntry.RollModeState
Enum Constant Summary
ACTIVE
235
Rollmode is ACTIVE.
ERROR
235
Rollmode: there is an error occured by this ecu.
NO_DETECT
235
Rollmode is NO_DETECT; i.e. it is not possible to detect the state.
NOT_ACTIVE
235
Rollmode ist NOT ACTIVE.
TIMEOUT
235
Timeout occured setting or detecting the rollmode state.
UNKNOWN
235
Rollmode is UNKNOWN; e.g. has not been tried to detect.
Interface IDiagResultSFD
de.volkswagen.odis.vaudas.vehiclefunction.automation.types
All Superinterfaces:
IDiagResult
extends IDiagResult
Method Summary
long
getEcuAddress() 2
3
Delivers the address of the control unit.
6
String
getErrorID() 2
3
Delivers the error-id of the occurred error.
7
String
getErrorMessage() 2
3
Delivers the translated message of the occurred error.
7
String
getLogicalLinkname() 2
3
Delivers the logical linkname of the control unit.
7
boolean
isError() 2
3
Checks for an occured error.
8
boolean
isNrc() 2
3
Checks for a negative response (NRC).
8
Method Detail
getEcuAddress
long getEcuAddress()
Delivers the address of the control unit.
Returns:
The address.
getLogicalLinkname
String getLogicalLinkname()
Returns:
The address.
getErrorMessage
String getErrorMessage()
Returns:
getErrorID
String getErrorID()
isError
boolean isError()
Returns:
isNrc
boolean isNrc()
Returns:
All Superinterfaces:
IDiagResult, IDiagResultSFD
extends IDiagResultSFD
Method Summary
IDiagResultParameterValue
getDuration() 2
4
Delivers the duration of sfd protection.
0
IDiagResultParameterValue
getRole() 2
3
Delivers the role for sfd protection.
9
IDiagResultParameterValue
getStatus() 2
4
Delivers the status of sfd protection.
0
IDiagResultParameterValue
getType() 2
4
Delivers the type of sfd protection.
0
Method Detail
getRole
IDiagResultParameterValue getRole()
Returns:
Returns:
getStatus
IDiagResultParameterValue getStatus()
Returns:
getDuration
IDiagResultParameterValue getDuration()
Returns:
Method Summary
List<IDiagResultSoftwareCompositionComponentListEntry>
getComponentListEntries() 2
4
Returns the list component entries.
1
Long
getEcuAddress() 2
4
Returns diagnostic address of the currently control
unit. 1
String
getErrorMessage() 2
4
Returns a message of the occured error while
reading the software composition component list. 2
String
getLogicalLinkname() 2
4
Retuns the logical linkname of the currently control
unit. 2
Method Detail
getComponentListEntries
List<IDiagResultSoftwareCompositionComponentListEntry> getComponentListEntries()
Returns:
getEcuAddress
Long getEcuAddress()
getLogicalLinkname
String getLogicalLinkname()
Returns:
getErrorMessage
String getErrorMessage()
Returns a message of the occured error while reading the software composition component list. If no error
occured the function returns an emtpy string.
Returns:
Method Summary
List<String>
getComponentSystemNames() 2
4
Returns list of software components with its system name.
4
String
getListNumber() 2
4
Returns the list number which is the key of the entry.
3
int
getListPosition() 2
4
Returns the list position in the software composition list.
4
long
getNodeId() 2
4
Returns the node address of this entry.
4
String
getSystemeName() 2
4
Returns the system name of this entry.
4
boolean
isCoded() 2
4
Returns coded state.
4
Method Detail
getListNumber
String getListNumber()
Returns:
Returns:
getNodeId
long getNodeId()
Returns:
getSystemeName
String getSystemeName()
Returns:
isCoded
boolean isCoded()
Returns:
getComponentSystemNames
List<String> getComponentSystemNames()
Returns list of software components with its system name.
Returns:
All Superinterfaces:
IDiagResult
extends IDiagResult
Method Summary
IDiagResultValue
getParameter(IDiagResultSpecialCoding.Parameter 2
Type parameterType)
4
Retrieves the current value for the specified parameterType.
6
Method Detail
getParameter
IDiagResultValue getParameter(IDiagResultSpecialCoding.ParameterType parameterType)
Parameters:
Returns:
All Superinterfaces:
IDiagResultValue
extends IDiagResultValue
Method Summary
IDiagResultStandardEnvironmentCondition.StandardEnvironmentC
onditionType
getStandardEnvironmentConditionTy
pe() 2
4
Returns the type ("meaning") of this standard 8
environment condition.
Method Detail
getStandardEnvironmentConditionType
IDiagResultStandardEnvironmentCondition.StandardEnvironmentConditionType getStandardEnvironmen
tConditionType()
Returns:
All Superinterfaces:
IDiagResult, IDiagResultTable
extends IDiagResultTable
Method Summary
IDiagResultValue
getDiagResultStatus() 2
Returns the status from the actuator diagnostic or basic setting as
5
DiagResultValue to distinguish between translated or shortname status. 1
IDiagResultStatus.EKWPResultState
getKwpResultState() 2
5
Returns the status from the actuator diagnostic or basic setting.
2
List<IDiagResultMeasurement>
getMeasuredValues() 2
5
Returns a list of measured values read during the operation.
1
String
getName() 2
5
Returns the name of the executed basic setting or actuator diagnosis.
0
String
getRecordDataIdentifier() 2
5
Returns the record data identifier of the executed service.
2
String
getStatus() 2
5
Returns the status from the actuator diagnostic or basic setting.
1
Method Detail
getName
String getName()
Returns the name of the executed basic setting or actuator diagnosis. For UDS control unit the name
contains the ODX-short name. For KWP control units the name contains the setting group number or the
actuator code. If the status is not assigned to a setting group or actuator the name will be left empty.
Returns:
getStatus
String getStatus()
Returns:
getDiagResultStatus
IDiagResultValue getDiagResultStatus()
Returns the status from the actuator diagnostic or basic setting as DiagResultValue to distinguish
between translated or shortname status. The translated status can be retrieved from
getDiagResultStatus.getTranslatedValue and the short name or kwp result state from
getDiagResultStatus.getValue.
Returns:
getMeasuredValues
List<IDiagResultMeasurement> getMeasuredValues()
Returns:
Returns the record data identifier of the executed service. Returns an empty string if no record data
identifier is available.
Returns:
getKwpResultState
IDiagResultStatus.EKWPResultState getKwpResultState()
Returns:
All Superinterfaces:
IDiagResult
extends IDiagResult
Method Summary
String
getTableKey() 2
5
5
String
getTableKeyText() 2
5
5
Method Detail
getTableKey
String getTableKey()
Returns:
getTableKeyText
String getTableKeyText()
Returns:
Method Summary
List<IDiagResultValue>
getChildren() 2
5
Returns the list of child result values for this result.
9
String
getName() 2
5
Returns the ODX name of this value.
7
IDiagResultValue
getParent() 2
5
Returns the parent result object of this result.
9
IDiagResultValue.RangeInfo
getRangeInfo() 2
5
Returns the range info of this result getRangeInfo(). 8
String
getRecordDataIdentifier() 2
5
Returns the record data identifier of the executed service.
9
String
getTranslatedName() 2
5
Returns the translated name of this value.
7
String
getTranslatedValue() 2
5
Returns the value in its textual representation for this result.
8
IDiagResultValue.ValueType
getType() 2
5
Returns the type of this result's value.
8
String
getUnit() 2
5
Returns the unit of this value.
7
String
getValue() 2
5
Returns the value in its textual representation for this result.
7
boolean
isValid() 2
5
Returns if the information is valid and can be used.
8
Method Detail
getName
String getName()
Returns the ODX name of this value. Returns an empty string if no name is available.
Returns:
getTranslatedName
String getTranslatedName()
Returns the translated name of this value. Returns an empty string if no name is available. If the translation
is not available the name whith a specific prefix will return.
Returns:
getUnit
String getUnit()
Returns the unit of this value. If no unit is available an empty string will return.
Returns:
getValue
String getValue()
Returns the value in its textual representation for this result. For ODX elements the short name or texttable
entry will return. If used from webservice and the type is STRING, the characters which can not be
transported with XML are encoded with \ u notation. E.g. the value 0 is represented as _.
Returns:
getTranslatedValue
String getTranslatedValue()
Returns the value in its textual representation for this result. For ODX elements the translation of the value
will return. If used from webservice and the type is STRING, the characters which can not be transported
with XML are encoded with \ u notation. E.g. the value 0 is represented as _.
Returns:
getRangeInfo
IDiagResultValue.RangeInfo getRangeInfo()
Returns:
getType
IDiagResultValue.ValueType getType()
Returns:
The type.
isValid
boolean isValid()
Returns if the information is valid and can be used.
Returns:
getChildren
List<IDiagResultValue> getChildren()
Returns the list of child result values for this result. Returns an empty list if this result object has no
children.
Returns:
getParent
IDiagResultValue getParent()
Returns the parent result object of this result. Returns null if this result has no parent.
Returns:
getRecordDataIdentifier
String getRecordDataIdentifier()
Returns the record data identifier of the executed service. Returns an empty string if no record data
identifier is available.
Returns:
Method Summary
String
getAutomationAPIVersion() 2
6
3
String
getECFVersion() 2
6
4
String
getMCDServerAPIVersion() 2
6
3
String
getMCDServerVersion() 2
6
3
String
getPDUAPIVersion() 2
6
3
String
getPDUVersion() 2
6
3
String
getProductVersion() 2
6
2
Method Detail
getProductVersion
String getProductVersion()
Returns:
Returns:
getMCDServerVersion
String getMCDServerVersion()
Returns:
getMCDServerAPIVersion
String getMCDServerAPIVersion()
Returns:
getPDUAPIVersion
String getPDUAPIVersion()
Returns:
getPDUVersion
String getPDUVersion()
Returns:
PDU version.
getECFVersion
String getECFVersion()
Returns:
ECF version.
Interface IDiagSoftwareCompositionComponentListEntry
de.volkswagen.odis.vaudas.vehiclefunction.automation.types
Input parameter object for settting the coding state of a software composition.
Method Summary
long
getNodeId() 2
6
Returns the node address of this entry.
5
boolean
isNodeIdAvailable() 2
6
Is the value for node id available and can be used..
5
void
setCoded(boolean coded) 2
6
Sets the coded state for this entry.
6
Method Detail
getNodeId
long getNodeId()
Returns:
isNodeIdAvailable
boolean isNodeIdAvailable()
Returns:
Parameters:
Method Summary
String
getIdentifier() 2
6
7
String
getIp() 2
6
7
String
getName() 2
6
7
Method Detail
getIdentifier
String getIdentifier()
Returns:
the identifier.
getName
String getName()
Returns:
the name.
getIp
String getIp()
Returns:
the ip address.
Interface IMacroEngine
de.volkswagen.odis.vaudas.vehiclefunction.automation.types
Method Summary
void
abort()
2
stops the execution of the macro. abort waits for up to 7
MAXTHREADTIMEOUT milliseconds for the macro execution to stop. that 1
may be necessary, if a diagnostic function is pending.
IMacroEngine.EngineState
execute(String macro, boolean debug)
2
7
start execution of a macro. if no macro is running, the macro
specified is loaded and started. 0
IMacroEngine.EngineState
getEngineState() 2
7
Returns the current engine state.
2
double
getInterval() 2
7
returns the execution interval.
2
int
getLineNumber() 2
7
gets the number of the currently executed line in the macro.
2
String
getMacrofile() 2
7
returns the name of the macro file.
1
String
getPythonError() 2
7
Delivers the python error string, or null, if no error was detected.
3
BlockingQueue<IMacroEngine.EngineState>
getStateQueue() 2
7
Delivers the blocking queue of engine states.
3
IMacroEngine.EngineState
pause()
2
pauses the execution of the macro. if a macro is running or being 7
debugged, the engine state is transferred to pause. otherwhiles there is no 1
effect.
void
setDebugMode(IMacroEngine.DebugMode debugMode) 2
7
sets the debug mode.
2
void
setInterval(double interval) 2
7
sets the execution interval.
1
void
setMacroEngineListener(IMacroEngineListener listener)
2
7
Sets the listener to be informed about changes of states, modes
and data. 0
void
triggerStep() 2
7
triggers the execution of one macro statement.
1
Method Detail
execute
IMacroEngine.EngineState execute(String macro,
boolean debug)
start execution of a macro. if no macro is running, the macro specified is loaded and started. If a macro is
already running, paused or being debugged, the state is just transfereed to running, the parameter macro
is ignored. This method does NOT block until the until the Execution of the macro has finished. If starting of
the macro execution fails, the state is set to 'Stop'.
Parameters:
Returns:
setMacroEngineListener
void setMacroEngineListener(IMacroEngineListener listener)
Sets the listener to be informed about changes of states, modes and data.
Parameters:
listener - - The listener to be informed; set null to ignore any changes or output.
abort
void abort()
stops the execution of the macro. abort waits for up to MAXTHREADTIMEOUT milliseconds for the macro
execution to stop. that may be necessary, if a diagnostic function is pending.
pause
IMacroEngine.EngineState pause()
pauses the execution of the macro. if a macro is running or being debugged, the engine state is transferred
to pause. otherwhiles there is no effect.
Returns:
triggerStep
void triggerStep()
setInterval
void setInterval(double interval)
Parameters:
getMacrofile
String getMacrofile()
Returns:
Parameters:
getEngineState
IMacroEngine.EngineState getEngineState()
Returns:
getInterval
double getInterval()
Returns:
getLineNumber
int getLineNumber()
Returns:
Delivers the blocking queue of engine states. May be interesting for callers that dont want to set up a
listener for detecting the end of macro execution.
Returns:
getPythonError
String getPythonError()
Returns:
java.lang.Object
de.volkswagen.odis.vaudas.vehiclefunction.automation.types.IMacroEngine.Factory
Enclosing class:
IMacroEngine
extends Object
Constructor Summary
Factory() 276
Method Summary
static
IMacroEngine
getInstance() 2
7
Delivers the singleton macro engine.
6
Constructor Detail
Factory
public Factory()
Method Detail
getInstance
public static IMacroEngine getInstance()
Returns:
the instance