API Dokumentation [PDF]

Zitiervorschau

Method Summary void

actuatorDiagnostics2Init(IConnectio nHandle connectionHandle, List actuators, 62 List measurements)

Initializes the actuator diagnosis with the specified actuators. void

actuatorDiagnosticsAbort(IConnectio nHandle connectionHandle)

61

Stops all running actuators and terminates the actuator diagnosis. List

actuatorDiagnosticsCheck(IConnectio nHandle connectionHandle, List actuators)

Reads the status information and the measurement values for the specified actuators (UDS control units) or the actuator specified in actuatorDiagnosticsInit (KWP control units). void

62

actuatorDiagnosticsInit(IConnection Handle connectionHandle, List actuators, List measurements) Initializes the actuator diagnosis with the specified actuators.

List

actuatorDiagnosticsNext(IConnection Handle connectionHandle)

63

Switches to the next configured actuator. List

actuatorDiagnosticsStart(IConnectio nHandle connectionHandle, List actuators)

Starts the actuator diagnosis for the specified actuators (UDS control units) or the actuator specified in actuatorDiagnosticsInit (KWP control units).

64

List

actuatorDiagnosticsStop(IConnection Handle connectionHandle, List actuators)

Stops the actuator diagnosis for the specified actuators (UDS control units) or the actuator specified in actuatorDiagnosticsInit (KWP control units). List

actuatorDiagnosticsWaitUntilNotRunn ing(IConnect ionHandle connectionHandle, List actuators, long timeout)

64

65

Controls the process of reading status and Measurands. void

basicSetting2Init(IConnectionHandle connectionHandle, List basicSettings, List

92

measurements)

Initializes the basic setting diagnosis with the specified settings. void

basicSettingAbort(IConnectionHandle connectionHandle)

91

Stops all running basic settings and terminates the basic setting diagnosis. List

basicSettingCheck(IConnectionHandle connectionHandle, List basicSettings)

91

Starts the basic setting diagnosis check for: the specified settings (UDS control units). void

basicSettingInit(IConnectionHandle connectionHandle, List basicSettings,

List measurements)

92

Initializes the basic setting diagnosis with the specified settings. List

basicSettingNext(IConnectionHandle connectionHandle)

Switches to the next configured basic setting.

94

List

basicSettingStart(IConnectionHandle connectionHandle, List basicSettings)

93

Starts the basic setting diagnosis for: the specified settings (UDS control units). List

basicSettingStop(IConnectionHandle connectionHandle, List basicSettings)

93

Stops the basic setting diagnosis for: the specified settings (UDS control units). List

basicSettingSwitch(IConnectionHandl e connectionHandle)

94

Switches the mode of operation for basic setting. List

basicSettingWaitUntilNotRunning(ICo nnectionHand le connectionHandle, List basicSettings, long timeout)

95

Controls the process of reading status and measurands. List

checkFlashPreConditions(IConnection Handle connectionHandle)

85

Checks the flashing preconditions for the current control unit and delivers the list of unfulfilled conditions. boolean

checkFlashProgramming(IConnectionHa ndle connectionHandle)

84

Checks if the current control unit is in principle flashable. boolean

checkFlashProgrammingWithFlashConta iner(IConnec tionHandle connectionHandle, String containerFileName, String sessionName)

85

Checks if the current control unit is flashable with the containerFileName content. String

checkVciState() Returns the current VCI state.

void

clearAdaptationChannels(IConnection Handle connectionHandle) Resets all adaptation channels to their default values.

12 5

61

void

closeConnection(IConnectionHandle connectionHandle)

Closes the connection to the current control unit and switches to CLOSE_CONNECTION_BEHAVIOUR. void

configureSetting(String

83

paramKey, String

paramValue)

79

Configures a setting of the tester with a key value combination. IDiagResultConnectEcu

connectToEcu(int

ecuAddress)

Opens a diagnostic connection to the control unit specified by the address. IDiagResultConnectEcu

38

connectToEcuAndOpenConnection(int ecuAddress)

Opens the diagnostic connection to the control unit specified by the address and switches to STAY_CONNECTED_BEHAVIOUR. IDiagResultConnectEcu

38

connectToEcuWithLogicalLink(String logicalLinkname)

39

Opens a diagnostic connection to the control unit specified by logical link name. IDiagDescriptorWithParametersAndMeasurements

createBasicSetting(String basicSettingName, Map parameters, List measurements)

90

Creates a basic setting object that can be used to initialize the basic setting diagnosis. IDiagDescriptor2WithParametersAndMeasurements

createBasicSetting2(String basicSettingName, Map parameters, List measurements)

90

Creates a basic setting object that can be used to initialize the basic setting diagnosis. IDiagComponentListEntry

createComponentListEntry(int

ecuId,

boolean isCoded)

Creates an component list entry for writing the gateway component list. IDiagComponentListEntry

10 0

createComponentListEntry(int

ecuId, int listPosition, long nodeId, boolean isCoded)

Creates an component list entry for writing the gateway component list.

10 0

IDiagDescriptorWithParametersAndMeasurements

createDiagActuator(String

actuatorName, Map parameters, List measurementValues)

66

Creates an actuator object that can be used to initialize the actuator diagnosis. IDiagDescriptor2WithParametersAndMeasurements

createDiagActuator2(String

actuatorName,

Map parameters, List measurementValues)

65

Creates an actuator object that can be used to initialize the actuator diagnosis. IDiagMeasurementDescriptor

createDiagMeasurementDescriptor(long ecuAddress, String measurementGroup, String measurementParam)

69

Creates a descriptor for measurements. IDiagFlashSessionDescriptor

createFlashSessionDescriptor(int ecuAddress, String containerFilePath, String sessionName, Boolean checkSessionWithEcu)

Creates a descriptor for a flash session that can be used to flash a given control unit with the specified flash session. IDiagMultiAdaptionDescriptor

86

createMultilinkAdaptationDescriptor (IMultilinkE 43 cuHandle ecuHandle, String adaptationName) Creates a multilink descriptor for a adaptation.

IDiagMultiAdaptionValueDescriptor

createMultilinkAdaptationValueDescr iptor(IDiagM ultiAdaptionDescriptor adaptationDescriptor, Map adaptationValues)

45

Creates a multilink descriptor for writing adaptation values. IDiagMultiCodingValueDescriptor

createMultilinkCodingDescriptor(IMu ltilinkEcuHa ndle ecuHandle, String systemName, Map textCoding, String byteCoding, IDiagResultValue.ValueType byteCodingType, Boolean ecuReset)

45

Creates a multilink descriptor for writing coding values. IMultilinkEcuHandle

createMultilinkHandleByAddress(Long ecuAddress)

Creates a handle for a multilink call to represent an ecu.

39

IMultilinkEcuHandle

createMultilinkHandleByLogicalLink( String logicalLinkname)

40

Creates a handle for a multilink call to represent an ecu. IDiagMultiMeasurementDescriptor

createMultilinkMeasurementDescripto r(IMultilink EcuHandle ecuHandle, String measurementName) 42 Creates a multilink descriptor for a measurement.

String

createProtocolVDSBZD(String

vin, String vehicleNumber, boolean readEventMemory, String userName, String measuringLocation, String measuringType, Long mileage,

ITotalSystemsInterface.MileageUnit mileageUnit, List adaptationPresets, List measurementPresets, List identificationPresets, List additionalPresets)

10 8

Creates VDS/BZD protocol. String

createProtocolVDSBZD(String

vin, String vehicleNumber, boolean readEventMemory, String userName, String measuringLocation, String measuringType, Long mileage,

ITotalSystemsInterface.MileageUnit mileageUnit, List adaptationPresets, List measurementPresets, List identificationPresets, List additionalPresets, Boolean useGatewayComponentList)

10 9

Creates VDS/BZD protocol. IDiagMultiSoftwareCompositionComponentCodingDescripto r

createSoftwareCompositionComponentC odingDescrip tor(IMultilinkEcuHandle controlUnit, List compositionComponents)

Creates an coding descriptor to code software composition components with multilink. IDiagSoftwareCompositionComponentListEntry

createSoftwareCompositionComponentL istEntry(Str ing listNumber, boolean isCoded)

Creates a software composition component list entry for writing the software composition component list.

99

IDiagSoftwareCompositionComponentListEntry

createSoftwareCompositionComponentL istEntry(Str ing listNumber, int listPosition, long nodeId, boolean isCoded)

99

Creates a software composition component list entry for writing the software composition component list. IDiagResultDatasetDownload

dataSetDownload(IConnectionHandle connectionHandle, String xmlFilePath)

98

Writing of a data set with XML content or ziparchive into the current control unit. void

disableTransportMode() Reactivation of a vehicle after a long time of idleness e.g. storage or transport.

void

discardProtocol()

12 8

Discards protocol. String

echo(String

text)

Conveniant method to check the availability of the web service. void

engineGroupCheck() Starts the engine group diagnosis check for the setting specified in enginGroupInit.

List

engineGroupStart() Starts the engine group diagnosis for the setting specified in enginGroupInit.

List

engineGroupStop() Stops the engine group diagnosis for: the setting specified in enginGroupInit.

List

engineGroupSwitch() Switches the mode of operation for engine group.

void

enginGroupInit(String

basicSettingName)

Initializes the engine diagnosis with the specified settings. boolean

26

enableTransportMode() Deactivation of a vehicle in order to minimize energy consumption.

List

84

executeMacro(String Executes a macro.

macroName)

84

12 6

12 6

12 7 12 6 12 5 12 8

void

exit() Returns immediately and closes the application in a separate thread.

String

28

exportDevEventMemorySnapshots(IConn ectionHandle connectionHandle, List 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

Update programming with an update container. IDiagResultFlashProgramming

flashProgrammingCoordinated(List flashSessionDescriptors, String coordinationFile)

88

Starts the coordinated update programming of the specified flash sessions. IDiagResultFlashProgramming

flashProgrammingCoordinated(List flashSessionDescriptors, List coordinationFiles)

87

Starts the coordinated update programming of the specified flash sessions. IDiagResultFlashProgramming

flashProgrammingCoordinatedByZipArc hive(String coordinationZipFilePath)

88

Starts the coordinated update programming with the zip archive content. IDiagResultFlashProgramming

flashProgrammingParallel(List flashSessionDescriptors) Starts the parallel update programming of the specified flash sessions.

87

IDiagResultFlashProgramming

flashProgrammingSequence(String flashControlFilePath, Boolean checkExpectedIdents)

89

Starts a parallel update programming sequence, which is defined in the control file. String

getAutomationApiVersion()

27

Delivers the automation API version number. List

getAvailableAdaptationPresets() Gets the list of available adaptation presets.

List

getAvailableAdditionalPresets()

11 0 111

Gets the list of available addtional presets. List

getAvailableIdentificationPresets()

111

Gets the list of available identification presets. List

getAvailableMeasurementPresets() Gets the list of available measurement presets.

List

getAvailableProtocols()

11 0

Gets a list of generated protocols. String

getClamp15State() Returns the current clamp 15 (ignition) state.

String

getClamp30State() Returns the current clamp 30 (battery) state.

IDiagResultCommParam

Gets the current communication parameter of an opened logical link.

getCommParamConfig(String

Gets the modified value of the specified communication parameter and logical link.

getCommParamDefault(String

11 5

11 8

logicalLink,

String name)

Gets the default value of the specified communication parameter and logical link from the odx database. List

12 5

logicalLink,

String name)

IDiagResultCommParam

12 4

getCommParam(IConnectionHandle connectionHandle, String name)

IDiagResultCommParam

11 0

11 6

getCommParamGroup(IConnectionHandle connectionHandle, List paramNames)

Gets the current communication parameters of an opened logical link.

11 6

List

getCommParamGroupConfig(String logicalLink, List paramNames)

Gets the modified value of the specified communication parameters and logical link. List

getCommParamGroupDefault(String logicalLink, List paramNames)

Gets the default value of the specified communication parameters and logical link from the odx database. List

Gets the current communication parameters of an opened logical link.

getCommParamsConfig(String

logicalLink)

Gets the modified communication parameters for the specified logical link. List

getCommParamsDefault(String

getDoIPVCIs() Gets the current DoIP VCIs without refreshing.

String[]

11 5

11 8

logicalLink)

Gets the default values of all communication parameters for the specified logical link from the odx database. List

11 7

getCommParams(IConnectionHandle connectionHandle)

List

11 8

11 7 12 1

getFlashSessions(IConnectionHandle connectionHandle, String containerFileName, Boolean checkSessionWithEcu)

89

Returns the names of all flash sessions contained in the specified flash container. List

getLockedConnections() Returns currently locked connections.

Integer

12 0

getNumberOfDevEventMemorySnapshots( IConnectionH andle connectionHandle, List memorySelections, Integer eventCode)

Determines the number of existing snapshot records for the specified developer dtc event code and selected control unit.

34

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

getODXVersions() Returns a list of all MCD projects with project information of the current project path.

List

getProjectEcuAddressList() Retrieves a list holding the addresses of all control units in the current project.

List

82

getShortNamesOfAccessModes(IConnect ionHandle connectionHandle)

53

53

Returns the ODX-ShortNames of all available access modes for UDS control units. List

getShortNamesOfActuators(IConnectio nHandle connectionHandle)

67

Returns the ODX short names of all available actuators from the currently selected control unit. List

getShortNamesOfAdaptationChannels(I ConnectionHa ndle connectionHandle) 58 Returns the ODX short names of all available adaptation channels for UDS control units.

List

getShortNamesOfAdaptationValues(ICo nnectionHand le connectionHandle, String adaptationChannel) 59 Returns the ODX short names of all available adaptation values from an adaptation channel.

List

getShortNamesOfBasicSettings(IConne ctionHandle connectionHandle)

95

Returns the ODX short names of all available basic settings from the currently selected control unit. List

getShortNamesOfCodingValues(IConnec tionHandle connectionHandle) Reads the coding names from the active control unit.

47

List

getShortNamesOfDiagnosticSessions(I ConnectionHa ndle connectionHandle) 54 Returns the ODX-ShortName list of all available diagnostic sessions for UDS control units.

List

getShortNamesOfIdentificationDatas( IConnectionH andle connectionHandle, String subsytem) 71 Returns the ODX short names of all identification values for the specified subsystem.

List

getShortNamesOfImmediateRoutines(IC onnectionHan dle connectionHandle)

98

Returns the ODX short names of all available immediate routines from the currently selected control unit. List

getShortNamesOfMeasurementGroups(IC onnectionHan dle connectionHandle)

68

Returns a list of ODX short names of all available measurement groups for the currently selected control unit. List

getShortNamesOfMeasurements(IConnec tionHandle connectionHandle, String measurementGroup)

68

Returns ODX short names of all available measurements of the specified measurement group.For KWP control unit this function throws an exception. List

getShortNamesOfMeasurementsForActua torDiagnosti cs(IConnectionHandle connectionHandle) 67 Returns the ODX short names of all measurements for the actuator diagnosis.

List

getShortNamesOfMeasurementsForBasic Settings(ICo nnectionHandle connectionHandle) 96 Returns the ODX short names of all measurements for the basic setting.

List

getShortNamesOfSoftwareCompositions (IConnection Handle connectionHandle)

70

Returns the ODX short names of all identification values for the software compositions and software components. List

getShortNamesOfStartParametersForAc tuator(IConn ectionHandle connectionHandle, String actuatorName)

67

Returns the ODX short names of all available parameters from the specified actuator. List

getShortNamesOfStartParametersForBa sicSettings( IConnectionHandle connectionHandle, String basicSettingName)

96

Returns the ODX short names of all available parameters from the specified basic setting. List

getShortNamesOfStartParametersForIm mediateRouti ne(IConnectionHandle connectionHandle, String immediateRoutineName)

97

Returns the ODX short names of all available start parameters from the specified immediate routine. List

getShortNamesOfSubSystems(IConnecti onHandle connectionHandle)

46

Returns a list of subsystem shortnames of the active control unit. IDiagResultVersions

getVersions()

82

Returns the versions of the used modules. IDiagResultStatus

immediateRoutineExecution(IConnecti onHandle connectionHandle, String immediateRoutineName, Map immediateRoutineParameters)

97

Starts the immediate routine with the provided parameters for the specified control unit. void

initProtocol() Inits protocol.

void

lockConnection(IConnectionHandle connectionHandle)

Sets a lock for the specified connection.

12 7 12 0

void

loginService42(String

user, String

password)

111

Login to the Volkswagen-Integration-Infrastructure (DMS-BB) via diagnostic session service. void

logoutService42() Logout from the Volkswagen-IntegrationInfrastructure (DMS-BB) via diagnostic session service.

void

11 2

openConnection(IConnectionHandle connectionHandle)

Opens the connection to the current control unit and switches to STAY_CONNECTED_BEHAVIOUR. IDiagResultAdaptation

83

readAdaptation(IConnectionHandle connectionHandle, String adaptationChannel)

Reads the adaptation values of the specified adaptation channel from the currently selected control unit. List

readAllEventMemories() Reads the event memories of all conrol units in the vehicle.

List

59

28

readAvailableCarportBrands() Read teh available brands that may be used when sending protocols to carport (see

11 2

ITotalSystemsInterface.sendProtocolsToCarport(L ist, String, String)). List

readAvailableDevEventMemorySelectio n(IConnectio nHandle connectionHandle) 32 Reads the available memory selections for developer event memories from the selected control unit.

List

readCoding(IConnectionHandle connectionHandle)

47

Reads the coding value from the active control unit. IDiagResultEventMemory

readDevEventMemory(IConnectionHandl e connectionHandle, List memorySelections, Long dtcStatusMask, Boolean readSnapshotRecord)

Reads the developer event memories from the selected control unit including all environmental conditions.

33

IDiagResultDtcSnapshotList

readDevEventMemorySnapshots(IConnec tionHandle connectionHandle, List memorySelections, Integer eventCode)

33

Reads all snapshot records for the specified developer dtc event code from the selected control unit. IDiagResultMemoryCells

readEEPROM(IConnectionHandle connectionHandle, BigInteger startAddress, Integer numberOfMemoryCells)

76

Reads the specified number of memory bytes from the ECU-EEPROM. IDiagResultMemoryCells

readEEPROMSerial(IConnectionHandle connectionHandle, Integer startAddress, Integer numberOfMemoryCells)

77

Reads (serial) the specified number of memory bytes from the ECU-EEPROM. IDiagResultMemoryCells

readEEPROMWithFixedAddressLength(IC onnectionHan dle connectionHandle, BigInteger startAddress, Integer numberOfAddressBytes, Integer numberOfMemoryCells)

76

Reads the specified number of memory bytes from the ECU-EEPROM. List

readEventMemories(List controlUnitList, List adaptationPresets, List measurementPresets, List identificationPresets, List additionalPresets)

27

Reads the event memory entries of the specified control unit list. IDiagResultEventMemory

readEventMemory(IConnectionHandle connectionHandle)

29

Reads the event memories from the selected control unit including all environmental conditions. IDiagResultEventMemory

readEventMemory(IConnectionHandle connectionHandle, long dtcStatusMask)

29

Reads the event memories from the selected control unit including all environmental conditions. IDiagResultDtcSnapshot

readEventMemorySnapshot(IConnection Handle connectionHandle, Integer eventCode, Integer snapshotRecordNumber)

Reads the specific snapshot record for the specified snapshot record number and dtc event code from the selected control unit.

31

IDiagResultDtcSnapshotList

readEventMemorySnapshots(IConnectio nHandle connectionHandle, Integer eventCode)

30

Reads all snapshot records for the specified dtc event code from the selected control unit. IDiagResultEventMemory

readEventMemoryWithMask(IConnection Handle connectionHandle, long dtcStatusMask)

30

Reads the event memories from the selected control unit including all environmental conditions. IDiagResultEventMemory

readEventMemoryWithMask(IConnection Handle connectionHandle, long dtcStatusMask, Boolean readSnapshotRecords)

29

Reads the event memories from the selected control unit including all environmental conditions. IDiagResultComponentList

readGatewayComponentList(IConnectio nHandle connectionHandle) 10 1 Reads the gateway component list of the currently selected control unit.

List

readIdentification(IConnectionHandl e connectionHandle) Reads all identification data from the currently selected control unit including extended informations slave control units, software cluster and software compositions.

IDiagResultValue

72

readIdentificationData(IConnectionH andle connectionHandle, String identDataIdentifier)

72

Reads a single identification data from the currently selected master conrol unit and returns it. List

readIdentificationSoftwareCompositi ons(IConnect ionHandle connectionHandle) 71 Reads software compositions identification data from the currently selected control unit.

IDiagResultEventMemory

readListOfActiveFaultEntries(IConne ctionHandle connectionHandle)

35

Reads the event memories with the status active fault path. IDiagResultEventMemory

readListOfUncheckedFaultPaths(IConn ectionHandle connectionHandle) Reads the event memories with the status unchecked fault path.

36

IDiagResultMeasurement

readMeasurement(IConnectionHandle connectionHandle, String measurementGroup, String measurementParam)

69

Reads the measurements from the currently selected control unit. List

readMeasurements(List measurementDescriptors)

70

Reads the measurement values from the currently selected control unit. List

readMultilinkAdaptation(List adaptationDescriptors)

43

Reads all adaptation values specified by the list of adaptionDescriptors with the current multilink settings. List

readMultilinkCoding(List ecuList, boolean readSubSystems)

44

Reads the coding values from for the specified control units with the current multilink settings. List

readMultilinkEventMemory(List ecuList)

41

Reads the event memories of the specified conrol units with the current multilink settings. List

readMultilinkIdentification(List ecuList, boolean readExtendedIdent, boolean readSubSystems)

40

Reads the identification data for the specified control units with the current multilink settings. List

readMultilinkMeasurement(List measurementDescriptors)

42

Reads all measurement values specified by the list of measurementDescriptors with the current multilink settings. List

readMultilinkSoftwareCompositionCom ponentList(L 10 ist ecuList) 4 Reads the software composition component list for all specified control units.

IDiagResultMemoryCells

readRAM(IConnectionHandle connectionHandle, Integer startAddress, Integer numberOfMemoryCells)

75

Reads the specified number of memory bytes from the ECU-RAM. IDiagResultMemoryCells

readROM(IConnectionHandle connectionHandle, Integer startAddress, Integer numberOfMemoryCells)

75

Reads the specified number of memory bytes from the ECU-ROM. IDiagResultSoftwareCompositionComponentList

readSoftwareCompositionComponentLis t(IConnectio 10 nHandle connectionHandle) 3 Reads the software composition component list of the currently selected control unit.

IDiagResultSpecialCoding

readSpecialCoding(IConnectionHandle connectionHandle)

51

Reads the special coding information from the currently selected control unit. IDiagResultComponentList

readSubsystemComponentList(IConnect ionHandle connectionHandle) 10 1 Reads the subsystem component list of the currently selected control unit.

int

requestSecAccessASM(IConnectionHand le connectionHandle) 12 9 Requests security access to the ecu for reading ASM data.

void

resetAllCommParameters() Resets all communication parameters to their initial values.

void

12 0

resetAllEventMemories(Boolean

clearOBD, Boolean clearNotErasedECUsPhysical, Integer timeBeforePhysicalClear)

37

Tries to delete the event memories in the vehicle by sending a sequence of diagnostic services. void

resetAllEventMemoriesSequential() Tries to delete the event memories in the vehicle by sending a sequence of diagnostic services.

37

void

resetAllOBDFaultMemories() Deletes the event memory of all OBD relevant control units by sending the functional OBD-Service 0x04.

void

resetCommParameter(String

logicalLink,

String name)

Resets the specified communication parameter to its initial value. void

resetCommParameters(String

logicalLink)

Resets all communication parameters of the specified logical link to its initial value. void

37

11 9

11 9

resetDevEventMemory(IConnectionHand le connectionHandle, List memorySelections)

35

Deletes the developer event memories from the selected control unit for the given memory selections. void

resetEventMemories(Boolean

clearOBD, Boolean clearFunctional, Boolean clearNotErasedECUsPhysical, Integer timeBeforePhysicalClear, List controlUnitList)

36

Tries to delete the event memories in the vehicle by sending a sequence of diagnostic services. void

resetEventMemory(IConnectionHandle connectionHandle)

38

Deletes the event memories of the selected control unit. List

resetMultilinkEventMemory(List ecuList, boolean clearOBD)

41

Deletes the event memories of the specified conrol units with the current multilink settings. void

saveProtocol()

12 8

Saves protocol. List

searchDoIPVCIs(String

ipAddress)

Searches DoIP VCIs. IDiagResult

12 2

securityAccess(IConnectionHandle connectionHandle, String loginCode, String accessMode)

Executes the security access operation on the control unit using the specified login code and access mode.

54

List

securityAccessSFDAllEcuLock() Executes the security access lock operation for all control units that support the SFD function.

IDiagResultSFDStatus

securityAccessSFDCheckStatus(IConne ctionHandle connectionHandle)

57

58

Reads the security access unlock status for the specified control unit (SFD). IDiagResultSFD

securityAccessSFDEcuLock(IConnectio nHandle connectionHandle)

56

Executes the security access lock operation on the specified control unit (SFD). IDiagResultSFD

securityAccessSFDOffline(IConnectio nHandle connectionHandle, ISecurityAccessInterface.OnlineRequestedRole role, ISecurityAccessInterface.OnlineAccessDuration duration)

56

Executes the security access unlock operation on the control unit by using an offline token (SFD) without a connection to the sfd backend. IDiagResultSFD

securityAccessSFDOnline(IConnection Handle connectionHandle, ISecurityAccessInterface.OnlineRequestedRole role, ISecurityAccessInterface.OnlineAccessDuration duration, ISecurityAccessInterface.OnlineAccessMethod accessMethod)

55

Executes the security access unlock operation on the control unit by using an online token (SFD). IDiagResultSFD

securityAccessSFDReset(IConnectionH andle connectionHandle, ISecurityAccessInterface.OnlineRequestedRole role, ISecurityAccessInterface.OnlineAccessDuration duration, ISecurityAccessInterface.OnlineAccessMethod accessMethod)

57

Executes the security access reset operation on the control unit by using an online token (SFD). IDiagResultProtocolTransfer

sendProtocolsToAVx(List protocolNames)

Sends protocols to the AVx system.

11 4

IDiagResultProtocolTransfer

sendProtocolsToCarport(List protocolNames, String taskCode, String brand)

Sends protocols to carport system. IDiagResultProtocolTransfer

sendProtocolsToFileServer(List protocolNames, String destinationPath)

Sends protocols to the specified file server. IDiagResultProtocolTransfer

sendProtocolsToVDS(List protocolNames)

Sends protocols to the VDS system. byte[]

11 2 11 3 11 3

sendRawService(IConnectionHandle connectionHandle, byte[] requestPdu)

73

Writes raw hex data. byte[]

sendRawService(IConnectionHandle connectionHandle, String requestPduString)

73

Transforms input parameter from String to a byte array and writes raw hex data. IDiagResultRawService

sendRawServiceFunctional(byte[] requestPdu, String logicalLink)

74

Writes raw hex data functional. IDiagResultRawService

sendRawServiceFunctional(String requestPduString, String logicalLink)

74

Writes raw hex data functional. byte[]

sendRawServiceWithoutConnectionChec k(String logicalLink, byte[] requestPdu)

74

Writes raw hex data with suppressed connection check via "tester present". void

setBaudrate(IConfigureCommParamInte rface.Baudra 12 te baudrate) 0 Set control unit independent baud rate.

void

setCanFDVehicleProject(String projectName)

Sets and loads the vehicle project for CAN-FD. String

12 2

setCanFDVehicleProjectAutomatic(ICon nectionInte rface.PROJECT_MODE projectMode)

Determines the project for the current vin automatically.

12 2

void

setCommParameter(String

logicalLink,

String name, String value)

Sets the specified communication parameter for the specified logical link. void

setCommParameters(String

logicalLink,

Map commParams)

Sets the specified communication parameters for the specified logical link. void

11 4

11 4

setCommunicationTrace(IConfiguratio nInterface.T RACE_STATE traceState) 82 Starts or stops the tracing of BUS, DoIP or JOB traces.

void

setDoIPActivationLine(boolean

toSet)

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. void

setDoIPVehicleProject(IDoIPVCI doIPVCI, String projectName)

Sets and loads the vehicle project for DoIP. String

setDoIPVehicleProjectAutomatic(IDoI PVCI doIPVCI, IConnectionInterface.PROJECT_MODE projectMode)

12 4

12 3

12 3

Determines the project for the current vin automatically. void

setLocale(String

language, String country)

81

Setting the locale for all diagnostic functions. void

setTraceLevel(String

level)

81

Setting the trace level. void

setTraceLevel(Level

level)

Setting the API trace level for all diagnostic functions. void

setVehicleProject(String

81

projectName)

Sets and loads the vehicle project for the diagnostic interface.

52

String

setVehicleProjectAutomatic(IConnection Interface .PROJECT_MODE projectMode)

53

Determines the project for the current vin automatically. void

startProtocol() Starts protocol.

void

stopProtocol() Stops protocol.

IDiagResult

12 7 12 7

switchSession(IConnectionHandle connectionHandle, String session)

For UDS control units the ODX short name of the diagnostic session is used to identify the session to switch to. void

unloadProject() Unloads the vehicle project.

void

unlockConnection(IConnectionHandle connectionHandle)

Removes the lock for the specified connection. void

12 4 12 1

updateGatewayComponentList() Updates the gateway component list of all busmasters (only for macro api).

IDiagResultSoftwareCompositionComponentList

83

27

updateSoftwareCompositionComponentL ist(IConnect 10 ionHandle connectionHandle) 6 Updates the software composition list of the currently selected control unit (only for macro api).

IDiagResultComponentList

updateSubsystemComponentList(IConne ctionHandle connectionHandle) 10 3 Updates the subsystem component list of the currently selected control unit (only for macro api).

IDiagResult

writeAdaptation(IConnectionHandle connectionHandle, String adaptationChannel, MapAdapter adaptationValues)

Writes adaption values for the specified adaptation channel.

60

IDiagResult

writeAdaptation(IConnectionHandle connectionHandle, String adaptationChannel, Map adaptationValues)

60

Writes adaption values for the specified adaptation channel. IDiagResult

writeByteCoding(IConnectionHandle connectionHandle, String systemName, String codingValues)

48

Writes the byte coding values for the specified (sub)system. IDiagResult

writeByteCoding(IConnectionHandle connectionHandle, String systemName, String codingValues, boolean ecuReset, int checksum)

48

Writes the byte coding values for the specified (sub)system. IDiagResult

writeComponentListFromPresentState( IConnectionH 10 andle connectionHandle) 6 Writes the specified gateway component list to the currently selected control unit.

IDiagResult

writeEEPROM(IConnectionHandle connectionHandle, BigInteger startAddress, byte[] memoryCellData)

78

Writes the specified memory data to the ECUEEPROM. IDiagResult

writeEEPROMSerial(IConnectionHandle connectionHandle, Integer startAddress, byte[] memoryCellData)

79

Writes (serial) the specified memory data to the ECU-EEPROM. IDiagResult

writeEEPROMWithFixedAddressLength(I ConnectionHa ndle connectionHandle, BigInteger startAddress, Integer numberOfAddressBytes, byte[] memoryCellData)

78

Writes the specified memory data to the ECUEEPROM. IDiagResult

writeGatewayComponentList(IConnecti onHandle connectionHandle, List 10 componentList) 7 Writes the specified gateway components to the currently selected control unit.

IDiagResult

writeGatewayComponentListBinary(ICo nnectionHand 10 le connectionHandle, byte[] 7 componentListBinary) Writes the gateway components for KWP binary.

List

writeMultilinkAdaptation(List adaptationValueDescriptors)

46

Writes adaptation values for the specified list adaptationValueDescriptors with the current multilink settings. List

writeMultilinkCoding(List codingValueDescriptors)

44

Writes the text or byte coding values, that are specified in the descriptor list codingValueDescriptors with the current multilink settings. List

writeMultilinkSoftwareCompositionCo mponentList( List codingDescriptors) 4 Writes the specified software composition components to the corresponding control unit with multilink.

IDiagResult

writeSoftwareCompositionComponentLi st(IConnecti onHandle connectionHandle, List componentList)

Writes the specified software composition components to the currently selected control unit. IDiagResult

writeSoftwareCompositionComponentLi stFromPresen tState(IConnectionHandle 10 connectionHandle) 5 Writes the software composition component list to the currently selected control unit.

IDiagResult

writeSpecialCoding(IConnectionHandl e connectionHandle, MapAdapter parameters)

52

Writes the provided "special coding information" to the currently selected control unit. IDiagResult

writeSpecialCoding(IConnectionHandl e connectionHandle, Map parameters)

51

Writes the provided "special coding information" to the currently selected control unit. IDiagResult

writeSubsystemComponentList(IConnec tionHandle connectionHandle, List 10 componentList) 2 Writes the specified subsystem components to the currently selected control unit.

IDiagResult

writeSubsystemComponentListFromPres entState(ICo 10 nnectionHandle connectionHandle) 2 Writes the subsystem component list to the currently selected control unit.

IDiagResult

writeTextCoding(IConnectionHandle connectionHandle, String systemName, MapAdapter codingValues, boolean ecuReset)

49

Writes the text coding values for the specified system with possibility of a reset. IDiagResult

writeTextCoding(IConnectionHandle connectionHandle, String systemName, Map codingValues)

49

Writes the text coding values for the specified system. IDiagResult

writeTextCoding(IConnectionHandle connectionHandle, String systemName, Map codingValues, boolean ecuReset)

Writes the text coding values for the specified system with possibility of a reset.

Method Detail echo public String echo(String text)

50

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: text - The text to echo.

Returns: The text specified as input parameter

getAutomationApiVersion public String getAutomationApiVersion()

Delivers the automation API version number. Returns: the automation API version number.

updateGatewayComponentList public void updateGatewayComponentList() throws DiagException

Updates the gateway component list of all busmasters (only for macro api). Throws: DiagException - If an error occurs while calling this function.

Not available for web service.

readEventMemories public List readEventMemories(List controlUnitList, List adaptationPresets, List measurementPresets, List identificationPresets, List 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: controlUnitList - the control unit list adaptationPresets - the preset names for the additional adaptations measurementPresets - the preset names for the additional measurements identificationPresets - the preset names for the additional identifications additionalPresets - the preset names for special measurements and adaptations

Returns: the event memory entries of the read control units. Throws: DiagException - If reading fails

Not available for web service.

readAllEventMemories public List 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: The list of event memory result objects. Throws: DiagException - If an error occurs while reading all event memories.

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. Only available for web service.

readEventMemory public IDiagResultEventMemory readEventMemory(IConnectionHandle connectionHandle)  throws DiagException

Reads the event memories from the selected control unit including all environmental conditions. Parameters: connectionHandle - Handle for control unit connection.

Returns: The event memory result object. Throws: DiagException - If an error occurs while reading the event memory.

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: connectionHandle - Handle for control unit connection. dtcStatusMask - Specifies the status of the event memories which will be read.

Returns: The event memory result object. Throws: DiagException - If an error occurs while reading the event memory.

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: connectionHandle - Handle for control unit connection. dtcStatusMask - Specifies the status of the event memories which will be read.

Returns: The event memory result object. Throws: DiagException - If an error occurs while reading the event memory.

Not available for web service.

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: connectionHandle - Handle for control unit connection. dtcStatusMask - Specifies the status of the event memories which will be read.

Returns: The event memory result object. Throws: DiagException - If an error occurs while reading the event memory.

Not available for web service.

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: connectionHandle - the handle for control unit connection. eventCode - the dtc event code.

Returns: The result list of snapshot records. Throws: DiagException - If an error occurs while reading the snapshot records.

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: connectionHandle - the handle for control unit connection. eventCode - the dtc event code. snapshotRecordNumber - the number of the wanted snapshot record.

Returns: The result of the wanted snapshot record. Throws: DiagException - If an error occurs while reading the snapshot record.

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: connectionHandle - the handle for control unit connection. eventCode - the dtc event code.

Returns: The number of the present snapshot records. Throws: DiagException - If an error occurs while determining the snapshot record number.

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: connectionHandle - the handle for control unit connection. targetFilePath - the path of the export file

Returns: The path of the saved export file. Throws: DiagException - If an error occurs while exporting the snapshot records.

readAvailableDevEventMemorySelection public List readAvailableDevEventMemorySelection( IConnectionHandle connectionHandle) throws DiagException

Reads the available memory selections for developer event memories from the selected control unit. Parameters: connectionHandle - Handle for control unit connection.

Returns: The memory selections.

Throws: DiagException - If an error occurs.

readDevEventMemory public IDiagResultEventMemory readDevEventMemory( IConnectionHandle connectionHandle, List 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: connectionHandle - Handle for control unit connection. 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. readSnapshotRecord - Switch to activate the reading of snapshot records.

Returns: The event memory result object. Throws: DiagException - If an error occurs while reading the event memory.

readDevEventMemorySnapshots public IDiagResultDtcSnapshotList readDevEventMemorySnapshots(IConnectionHandle connectionHand le, List memorySelections, Integer eventCode)  throws DiagException

Reads all snapshot records for the specified developer dtc event code from the selected control unit. Parameters: connectionHandle - the handle for control unit connection. memorySelections - the memory selections. If empty, all available memory selections will be used. eventCode - the developer dtc event code.

Returns: The result list of snapshot records. Throws: DiagException - If an error occurs while reading the snapshot records.

getNumberOfDevEventMemorySnapshots public Integer getNumberOfDevEventMemorySnapshots(IConnectionHandle connectionHandle, List memorySelections, Integer eventCode)  throws DiagException

Determines the number of existing snapshot records for the specified developer dtc event code and selected control unit. Parameters: connectionHandle - the handle for control unit connection. memorySelections - the memory selections. If empty, all available memory selections will be used. eventCode - the developer dtc event code.

Returns: The number of the present snapshot records. Throws: DiagException - If an error occurs while determining the snapshot record number.

exportDevEventMemorySnapshots public String exportDevEventMemorySnapshots(IConnectionHandle connectionHandle, List 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: connectionHandle - the handle for control unit connection. memorySelections - the memory selections. If empty, all available memory selections will be used. targetFilePath - the path of the export file

Returns: The path of the saved export file. Throws: DiagException - If an error occurs while exporting the snapshot records.

resetDevEventMemory public void resetDevEventMemory(IConnectionHandle connectionHandle, List memorySelections)  throws DiagException

Deletes the developer event memories from the selected control unit for the given memory selections. Parameters: connectionHandle - Handle for control unit connection. memorySelections - the memory selections. If empty, all developer event memories will be

deleted. Throws: DiagException - If an error occurs while reading the event memory.

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: connectionHandle - Handle for control unit connection.

Returns: The event memory result object. 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: connectionHandle - Handle for control unit connection.

Returns: The event memory result object. 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 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 UDSservice 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: clearOBD - Switch for obd deletion (OBD-Service 0x04 functional). clearFunctional - Switch for functional deletion (TP2.0-broadcast and UDS-Service 0x14). clearNotErasedECUsPhysical - Switch for physically deletion of all defined units, which KD-Bit is

set in the gateway component list. timeBeforePhysicalClear - Waiting time in seconds between functional clear and reading of

fitment list for physical clear. Throws: DiagException - If an error occurs while deleting the event memories.

resetAllEventMemories public void resetAllEventMemories(Boolean clearOBD, Boolean clearNotErasedECUsPhysical, Integer timeBeforePhysicalClear)  throws DiagException

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. timeBeforePhysicalClear - Waiting time in seconds between functional clear and reading of

fitment list for physical clear. Maybe null, than the vale from administration function configuration -> event memory -> workflow complete system clear -> waiting time before physical clear is used. Throws: DiagException - If an error occurs while sending the reset operation.

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: DiagException - If an error occurs while sending the reset operation.

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: DiagException - If an error occurs while sending the reset operation.

resetEventMemory public void resetEventMemory( IConnectionHandle connectionHandle) throws DiagException

Deletes the event memories of the selected control unit. Parameters: connectionHandle - Handle for control unit connection.

Throws: DiagException - If an error occurs while sending the reset operation.

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: ecuAddress - The address of the control unit.

Returns: Information about the connected control unit. Throws: DiagException - If an error occurs while connecting.

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: ecuAddress - The address of the control unit.

Returns: Information about the connected control unit. Throws: DiagException - If an error occurs while setting the internal flag.

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: logicalLinkname - The logical linkname of the control unit.

Returns: Information about the connected control unit. Throws: DiagException - If an error occurs while connecting.

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: ecuAddress - the address of the ecu.

Returns: the multilink ecu handle. Throws: DiagException - If the ecu address is invalid.

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: logicalLinkname - the logical link name of the ecu.

Returns: the multilink ecu handle. Throws: DiagException - If the logical link name is not available in the vehicle project.

readMultilinkIdentification public List readMultilinkIdentification( List  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: ecuList - handles of all specified control units to be read readExtendedIdent - flag to de-/activate the reading of extended identification values

readSubSystems - flag to de-/activate the reading of subsystems

Returns: the identification list of all specified control units Throws: DiagException - If an error occurs while reading the identification data.

readMultilinkEventMemory public List readMultilinkEventMemory( List 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: ecuList - handles of all specified control units

Returns: The list of event memory result objects. Throws: DiagException - If an error occurs while reading the event memories.

resetMultilinkEventMemory public List resetMultilinkEventMemory(List 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: ecuList - handles of all specified control units clearOBD - Switch for the additional deleting of OBD control units. Maybe null, than default FALSE

is used.

Returns: The result list of the deletion. Throws: DiagException - If an error occurs while sending the reset operation.

readMultilinkMeasurement public List readMultilinkMeasurement( List 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: measurementDescriptors - - Holding information on the measurements to be read.

Returns: The result list with measurement values. Throws: DiagException - If an error occurs while calling this function.

createMultilinkMeasurementDescriptor public IDiagMultiMeasurementDescriptor createMultilinkMeasurementDescriptor(IMultilinkEcuHandl e ecuHandle, String measurementName)  throws DiagException

Creates a multilink descriptor for a measurement. Can be used .e.g. to provide a list of measurements to be read. Parameters: ecuHandle - The multilink ecu handle. measurementName - The name of the measurement.

For KWP this should be the block number. Returns: The newly created descriptor.

Throws: DiagException - If an error occurs while calling this function.

readMultilinkAdaptation public List readMultilinkAdaptation( List  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: The result list with adaptation values. Throws: DiagException - If an error occurs while calling this function.

createMultilinkAdaptationDescriptor public IDiagMultiAdaptionDescriptor createMultilinkAdaptationDescriptor(IMultilinkEcuHandle ec uHandle, String adaptationName)  throws DiagException

Creates a multilink descriptor for a adaptation. Can be used .e.g. to provide a list of adaptations to be read. Parameters: ecuHandle - The multilink ecu handle. adaptationName - The name of the adaptation.



For UDS the adaptation name is one of the channels returned by getShortNamesOfAdaptationChannels and the available values for the channel can be retrieved by getShortNamesOfAdaptationValues.



For KWP the adaptation name is the channel number given as string - i.e. "1" to "255".

Returns: The newly created descriptor.

Throws: DiagException - If an error occurs while calling this function.

readMultilinkCoding public List readMultilinkCoding( List 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: ecuList - handles of all specified control units to be read readSubSystems - flag to de-/activate the reading of subsystems (not including software

compositions / components) Returns: The result list of all coding values. Throws: DiagException - If an error occurs while reading the coding value.

writeMultilinkCoding public List writeMultilinkCoding( List 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: codingValueDescriptors - The list of coding descriptors.

Returns: The result list of the coding.

Throws: DiagException - If an error occurs while calling this function.

createMultilinkCodingDescriptor public IDiagMultiCodingValueDescriptor createMultilinkCodingDescriptor( IMultilinkEcuHandle ec uHandle, String systemName, Map textCoding, String byteCoding, IDiagResultValue.ValueType byteCodingType, Boolean ecuReset) throws DiagException

Creates a multilink descriptor for writing coding values. Parameters: ecuHandle - The multilink ecu handle. 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. ecuReset - The Flag to perform the ecu reset after coding.

Returns: The newly created descriptor. Throws: DiagException - If an error occurs while calling this function.

createMultilinkAdaptationValueDescriptor public IDiagMultiAdaptionValueDescriptor createMultilinkAdaptationValueDescriptor(IDiagMultiAd aptionDescriptor adaptationDescriptor, Map 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: adaptationDescriptor - The descriptor for the writing adaptation (ecu, name/channel) adaptationValues - The new adaptation values.

Returns: The newly created descriptor. Throws: DiagException - If an error occurs while calling this function.

writeMultilinkAdaptation public List writeMultilinkAdaptation( List 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: adaptationValueDescriptors - The adaptations to be written.

Returns: The result list of the adaptations. Throws: DiagException - If an error occurs while calling this function.

getShortNamesOfSubSystems public List 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: connectionHandle - Handle for control unit connection.

Returns: The subsytem short names. Throws: DiagException - If an error occurs while reading the short names or the operation was called for a

KWP control unit.

readCoding public List 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: connectionHandle - Handle for control unit connection

Returns: The result coding values. The first entry respresents the master coding value. Throws: DiagException - If an error occurs while reading the coding value.

getShortNamesOfCodingValues public List getShortNamesOfCodingValues(IConnectionHandle connectionHandle)  throws DiagException

Reads the coding names from the active control unit. Parameters: connectionHandle - Handle for control unit connection

Returns: The result short names. Throws: DiagException - If an error occurs while reading the coding value.

writeByteCoding public IDiagResult writeByteCoding(IConnectionHandle connectionHandle,  String systemName,  String codingValues,  boolean ecuReset,  int checksum) 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 be retrieved by calling getShortNamesOfSubSystems. Parameters: connectionHandle - Handle for control unit connection. 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. ecuReset - If to make a reset after writing. checksum - Checksum over codingValues.

Returns: General response object. Throws: DiagException - If an error occurs while writing the coding value.

Not available for web service.

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: connectionHandle - Handle for control unit connection.

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: General response object. Throws: DiagException - If an error occurs while writing the coding value.

writeTextCoding public IDiagResult writeTextCoding(IConnectionHandle connectionHandle,  String systemName,  Map 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: connectionHandle - Handle for control unit connection. systemName - The (sub)system name. KWP subsystems starts with prefix subSys followed by the

index. codingValues - The plain text coding values.

Returns: General response object. Throws: DiagException - If an error occurs while writing the coding value.

Not available for web service.

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: connectionHandle - Handle for control unit connection. 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"). ecuReset - If to make a reset after writing.

Returns: General response object. Throws: DiagException - If an error occurs while writing the coding value.

writeTextCoding public IDiagResult writeTextCoding(IConnectionHandle connectionHandle,  String systemName,  Map 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: connectionHandle - Handle for control unit connection. 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"). ecuReset - If to make a reset after writing.

Returns: General response object. Throws: DiagException - If an error occurs while writing the coding value.

Not available for web service.

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: connectionHandle - Handle for control unit connection.

Returns: The special coding info. Throws: DiagException - If an error occurs while calling this function.

writeSpecialCoding public IDiagResult writeSpecialCoding(IConnectionHandle connectionHandle, Map 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"



Key "Derivate": "shortrear", "notchback", "variant", "hatchback", "coupe", "cabrio, "offroad", "cityvan", "mpv", "other"



Key "Wheel": "left" or "right"



Key "Doors": "less" (than 4 doors) or "more" (4 doors or more)

Parameters: connectionHandle - Handle for control unit connection. parameters - - The parameters for the special coding

Returns: General response.

Throws: DiagException - - If an error occurs while calling this function.

Not available for web service.

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"



Key "Derivate": "shortrear", "notchback", "variant", "hatchback", "coupe", "cabrio, "offroad", "cityvan", "mpv", "other"



Key "Wheel": "left" or "right"



Key "Doors": "less" (than 4 doors) or "more" (4 doors or more)

Parameters: connectionHandle - Handle for control unit connection. parameters - - The parameters for the special coding

Returns: General response. Throws: DiagException - - If an error occurs while calling this function.

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: projectName - The project name.

Throws: DiagException - If an error occurs while setting the vehicle project.

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: projectMode - The project mode to control the kind of project determination

Returns: the project name Throws: DiagException - If the project is not unique or an error occurs while setting it.

getProjectEcuAddressList public List getProjectEcuAddressList()  throws DiagException

Retrieves a list holding the addresses of all control units in the current project. Returns: The list of ecu addresses. Throws: DiagException - If an error occurs while retrieving the address list.

getShortNamesOfAccessModes public List 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: connectionHandle - Handle for control unit connection.

Returns: The access modes. Throws: DiagException - If an error occurs or the function was called on an KWP control unit.

getShortNamesOfDiagnosticSessions public List 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: connectionHandle - Handle for control unit connection.

Returns: The list of diagnostic sessions 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. KWP2000 access modes: automatic, level34, level56, coding2 KWP1281 access mode: automatic UDS access modes: Login, System Specific Parameters: connectionHandle - Handle for control unit connection. loginCode - The login code.

accessMode - The acces mode.

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: connectionHandle - The handle for control unit connection. role - The role for the SFD unlock operation.

WEB-API: BASIC, EXTENDED, SUPERUSER MACRO: ISecurityAccessInterface.OnlineRequestedRole.BASIC, ISecurityAccessInterface.OnlineRequestedRole.EXTENDED, ISecurityAccessInterface.OnlineRequestedRole.SUPERUSER duration - The durations for the SFD unlock operation.

WEB-API: SHORT, LONG, UNLIMITED MACRO: ISecurityAccessInterface.OnlineAccessDuration.SHORT, ISecurityAccessInterface.OnlineAccessDuration.LONG, ISecurityAccessInterface.OnlineAccessDuration.UNLIMITED accessMethod - The online access method for the backend system.

WEB-API: PKI MACRO: ISecurityAccessInterface.OnlineAccessMethod.PKI Returns: The result of the SFD unlock operation. 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: connectionHandle - The handle for control unit connection. role - The role for the SFD unlock operation.

WEB-API: BASIC, EXTENDED, SUPERUSER MACRO: ISecurityAccessInterface.OnlineRequestedRole.BASIC, ISecurityAccessInterface.OnlineRequestedRole.EXTENDED, ISecurityAccessInterface.OnlineRequestedRole.SUPERUSER duration - The durations for the SFD unlock operation.

WEB-API: SHORT, LONG, UNLIMITED MACRO: ISecurityAccessInterface.OnlineAccessDuration.SHORT, ISecurityAccessInterface.OnlineAccessDuration.LONG, ISecurityAccessInterface.OnlineAccessDuration.UNLIMITED Returns: The result of the SFD unlock operation. 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: connectionHandle - The handle for control unit connection.

Returns: The result of the SFD lock process.

Throws: DiagException - If the control unit doesn't support the sfd lock operation.

securityAccessSFDAllEcuLock public List 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: The result of the SFD lock process. Throws: DiagException - If the vehicle doesn't support the sfd lock operation.

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: connectionHandle - The handle for control unit connection. role - The role for the SFD unlock operation.

WEB-API: BASIC, EXTENDED, SUPERUSER MACRO: ISecurityAccessInterface.OnlineRequestedRole.BASIC, ISecurityAccessInterface.OnlineRequestedRole.EXTENDED, ISecurityAccessInterface.OnlineRequestedRole.SUPERUSER duration - The durations for the SFD unlock operation.

WEB-API: SHORT, LONG, UNLIMITED MACRO: ISecurityAccessInterface.OnlineAccessDuration.SHORT, ISecurityAccessInterface.OnlineAccessDuration.LONG, ISecurityAccessInterface.OnlineAccessDuration.UNLIMITED

accessMethod - The online access method for the backend system.

WEB-API: PKI MACRO: ISecurityAccessInterface.OnlineAccessMethod.PKI Returns: The result of the SFD reset operation. 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: connectionHandle - The handle for control unit connection.

Returns: The SFD unlock status. Throws: DiagException - If the vehicle doesn't support the sfd unlock operation.

getShortNamesOfAdaptationChannels public List 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: connectionHandle - Handle for control unit connection.

Returns: The adaptation groups. Throws: DiagException - If an error occurs while calling this function.

getShortNamesOfAdaptationValues public List getShortNamesOfAdaptationValues(IConnectionHandle connectionHandle, String adaptationChannel)  throws DiagException

Returns the ODX short names of all available adaptation values from an adaptation channel. For KWP control units the function throws an exception. Parameters: connectionHandle - Handle for control unit connection. adaptationChannel - The adaptation channel from which the adaptation values shall be retrieved.

Returns: The adaptation values 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. KWP Adaptation groups: 1..255 UDS Adaption groups: Return values from getShortNamesOfAdaptationGroups Parameters: connectionHandle - Handle for control unit connection adaptationChannel - The adaptation channel from which the adaptation values shall be retrieved.

Returns: The adaptation which contains the adaptation values. Throws: DiagException - If an error occurs while calling this function

writeAdaptation public IDiagResult writeAdaptation( IConnectionHandle connectionHandle, String adaptationChannel, MapAdapter adaptationValues) throws DiagException

Writes adaption values for the specified adaptation channel. The adaption channel and the value(s) to be written are to be specified in different ways for UDS and KWP.



For UDS the adaptation channel is one of the channels returned by getShortNamesOfAdaptationChannels and the available values for the channel can be retrieved by getShortNamesOfAdaptationValues. 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.



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: connectionHandle - Handle for control unit connection 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: General response object. Throws: DiagException - If an error occurs while calling this function.

writeAdaptation public IDiagResult writeAdaptation(IConnectionHandle connectionHandle,  String adaptationChannel,  Map adaptationValues) throws DiagException

Writes adaption values for the specified adaptation channel. The adaption channel and the value(s) to be written are to be specified in different ways for UDS and KWP.



For UDS the adaptation channel is one of the channels returned by getShortNamesOfAdaptationChannels and the available values for the channel can be retrieved by getShortNamesOfAdaptationValues.

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.



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: connectionHandle - Handle for control unit connection 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: General response object. Throws: DiagException - If an error occurs while calling this function.

Not available for web service.

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: connectionHandle - Handle for control unit connection.

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

Stops all running actuators and terminates the actuator diagnosis.

Parameters: connectionHandle - Handle for control unit connection.

Throws: DiagException - If an error occurs while calling this function.

actuatorDiagnosticsCheck public List actuatorDiagnosticsCheck(IConnectionHandle connectionHandle, List 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: connectionHandle - Handle for control unit connection actuators -

UDS: The actuators for which the measurement values will be read. KWP: No actuators to specify. Returns: The status information. Throws: DiagException - If an error occurs while calling this function.

actuatorDiagnostics2Init public void actuatorDiagnostics2Init( IConnectionHandle connectionHandle, List actuators, List 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: connectionHandle - Handle for control unit connection. actuators - The actuators to initialize. measurements - The measurements values.

Throws: DiagException - If an error occures while calling this function.

actuatorDiagnosticsInit public void actuatorDiagnosticsInit(IConnectionHandle connectionHandle, List actuators, List 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: connectionHandle - Handle for control unit connection. actuators - The actuators to initialize. measurements - The measurements values.

Throws: DiagException - If an error occures while calling this function.

actuatorDiagnosticsNext public List 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: connectionHandle - Handle for control unit connection.

Returns: The status of the actuator diagnosis. Throws: DiagException - If an error occurs while calling this function or the function is called for a KWP

control unit.

actuatorDiagnosticsStart public List actuatorDiagnosticsStart(IConnectionHandle connectionHandle, List actuators)  throws DiagException

Starts the actuator diagnosis for the specified actuators (UDS control units) or the actuator specified in actuatorDiagnosticsInit (KWP control units). Parameters: connectionHandle - Handle for control unit connection. actuators -

UDS: The actuators to start. KWP: No actuators to specify. Returns: The status of the start operation. Throws: DiagException - If an error occures while calling this function.

actuatorDiagnosticsStop public List actuatorDiagnosticsStop( IConnectionHandle connectionHandle, List actuators) throws DiagException

Stops the actuator diagnosis for the specified actuators (UDS control units) or the actuator specified in actuatorDiagnosticsInit (KWP control units). Parameters: connectionHandle - Handle for control unit connection.

actuators -

UDS: The actuators to stop. KWP: No actuators to specify. Returns: The status of the stop operation. Throws: DiagException - If an error occures while calling this function.

actuatorDiagnosticsWaitUntilNotRunning public List actuatorDiagnosticsWaitUntilNotRunning(IConnectionHandle connec tionHandle, List 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: connectionHandle - Handle for control unit connection. actuators -

UDS: The actuators for which the measurement values will be read. KWP: No actuators to specify. timeout - Time out in ms for stopping process.

Returns: The status information. Throws: DiagException - If an error occurs while calling this function.

Not available for web service.

createDiagActuator2 public IDiagDescriptor2WithParametersAndMeasurements createDiagActuator2( String actuatorName, Map parameters, List 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: actuatorName - The actuator name. parameters - Parameters for the actuator.

Returns: The diag actuator object. Throws: DiagException - If an error occurs while calling this function.

createDiagActuator public IDiagDescriptorWithParametersAndMeasurements createDiagActuator( String actuatorName, Map parameters, List 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: actuatorName - The actuator name. parameters - Parameters for the actuator.

Returns: The diag actuator object. Throws: DiagException - If an error occurs while calling this function.

getShortNamesOfActuators public List getShortNamesOfActuators( IConnectionHandle connectionHandle) throws DiagException

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: connectionHandle - Handle for control unit connection.

Returns: The measurement values. Throws: DiagException - If an error occurs while calling this function or this function is called for a KWP

control unit.

getShortNamesOfMeasurementsForActuatorDiagnostics public List 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: connectionHandle - Handle for control unit connection.

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 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: connectionHandle - Handle for control unit connection. actuatorName - The name of the actuator.

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 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: connectionHandle - Handle for control unit connection.

Returns: The measurement value groups. Throws: DiagException - If an error occurs while calling this function or this function is called for a KWP

control unit.

getShortNamesOfMeasurements public List 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: connectionHandle - Handle for control unit connection.

measurementGroup - The measurement group in order to get the available ODX short names for

this group. 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

Creates a descriptor for measurements. Can be used .e.g. to provide a list of measurements to be read. Parameters: ecuAddress - Address of the control unit for the new descriptor. measurementGroup - The measurement group.

For KWP this should be the block number. measurementParam - The measurement parameter.

For KWP this should be the position number. Returns: The newly created descriptor. Throws: DiagException - If an error occurs while calling this function.

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: connectionHandle - Handle for control unit connection. 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: IDiagResultMeasurement with measurement values.

Throws: DiagException - If an error occurs while calling this function.

readMeasurements public List readMeasurements( List 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: measurementDescriptors - - Holding information on the measurements to be read.

Returns: IDiagResultMeasurement with measurement values.

Throws: DiagException - If an error occurs while calling this function.

getShortNamesOfSoftwareCompositions public List 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: connectionHandle - Handle for control unit connection of the master.

Returns: The subsytem short names with ident type as list. Throws: DiagException - If an error occurs while reading the short names or the operation was called for a

KWP control unit.

getShortNamesOfIdentificationDatas public List 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: connectionHandle - Handle for control unit connection. subsytem - Name of the subsystem for which the values will be returned.

Returns: The identification values Throws: DiagException - If an error occurs while calling this function or this function is called for a KWP

control unit.

readIdentificationSoftwareCompositions public List readIdentificationSoftwareCompositions(IConnectionHandl e connectionHandle)  throws DiagException

Reads software compositions identification data from the currently selected control unit. Parameters: connectionHandle - Handle for control unit connection.

Returns: The identification data of the master and its software compositions and software components.

Throws: DiagException - If an error occurs while reading the identification data.

readIdentification public List 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: connectionHandle - Handle for control unit connection.

Returns: The identification data. Throws: DiagException - If an error occurs while reading the identification data.

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: connectionHandle - Handle for control unit connection. identDataIdentifier - Identifier to specify the data which shall be to read.

Returns: The identification data which was read.

Throws: DiagException - If an error occurs while reading the identification data.

sendRawService public byte[] sendRawService( IConnectionHandle connectionHandle, byte[] requestPdu) throws DiagException

Writes raw hex data. Parameters: connectionHandle - Handle for control unit connection. requestPdu - The raw data to send.

Returns: Answer of the request as byte array. Throws: DiagException - If an error occurs while processing the request.

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: connectionHandle - Handle for control unit connection. requestPduString - Raw data to send as a String value.

Returns: Answer of request. Throws: DiagException - If an error occurs while processing request.

Not available for web service.

sendRawServiceWithoutConnectionCheck public byte[] sendRawServiceWithoutConnectionCheck( String logicalLink, byte[] requestPdu) throws DiagException

Writes raw hex data with suppressed connection check via "tester present". Parameters: logicalLink - Name of the logical link to write hex data. requestPdu - The raw data to send.

Returns: Answer of the request as byte array. Throws: DiagException - If an error occurs while processing the request.

sendRawServiceFunctional public IDiagResultRawService sendRawServiceFunctional(byte[] requestPdu, String logicalLink)  throws DiagException

Writes raw hex data functional. Parameters: requestPdu - The raw data to send. logicalLink - Name of the logical link to write hex data.

Returns: Answer of the request as result object. Throws: DiagException - If an error occurs while processing request.

sendRawServiceFunctional public IDiagResultRawService sendRawServiceFunctional(String requestPduString, String logicalLink)  throws DiagException

Writes raw hex data functional.

Parameters: requestPduString - Raw data to send. logicalLink - Name of the logical link to write hex data.

Returns: Answer of the request as result object. Throws: DiagException - If an error occurs while processing request.

Not available for web service.

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: connectionHandle - Handle for control unit connection. startAddress - The start address. numberOfMemoryCells - The number of bytes to read.

Returns: memory The read memory. 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: connectionHandle - Handle for control unit connection. startAddress - The start address. numberOfMemoryCells - The number of bytes to read.

Returns: memory The read memory. 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: connectionHandle - Handle for control unit connection. startAddress - The start address. numberOfMemoryCells - The number of bytes to read.

Returns: memory The read memory. Throws: DiagException - If an error occurs while processing request.

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: connectionHandle - Handle for control unit connection. startAddress - The start address. numberOfAddressBytes - The number of address bytes. numberOfMemoryCells - The number of bytes to read.

Returns: memory The read memory. Throws: DiagException - If an error occurs while processing request.

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: connectionHandle - Handle for control unit connection. startAddress - The start address. numberOfMemoryCells - The number of bytes to read.

Returns: memory The read memory. 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: connectionHandle - Handle for control unit connection. startAddress - The start address. memoryCellData - The memory to write.

Returns: General response. Throws: DiagException - If an error occurs while processing request.

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: connectionHandle - Handle for control unit connection. startAddress - The start address. numberOfAddressBytes - The number of address bytes. memoryCellData - The memory to write.

Returns: General response. Throws: DiagException - If an error occurs while processing request.

writeEEPROMSerial public IDiagResult writeEEPROMSerial( IConnectionHandle connectionHandle, Integer startAddress, byte[] memoryCellData) throws DiagException

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: connectionHandle - Handle for control unit connection. startAddress - The start address. memoryCellData - The memory to write.

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

Configures a setting of the tester with a key value combination. Key Multilink. MaxNumberOfLogicalLinks Multilink. ConsiderRestrictionsOfVRTVPT Trace. CANBusTracingActive Trace. CANPVTracingActive Trace. KLineBusTracingActive Trace. KLinePVTracingActive Trace. JobTracingActive Trace. DoIPBusTracingActive

Value type

Description

Integer [1,...]

Maximum number of logical links.

'TRUE', 'FALSE' 'TRUE', 'FALSE' 'TRUE', 'FALSE' 'TRUE', 'FALSE' 'TRUE', 'FALSE' 'TRUE', 'FALSE' 'TRUE', 'FALSE'

Consider restictions of VRT/VPT table when using multilinks. Enablement of CAN bus tracing. The key is no longer supported. No action is performed. Enablement of KLine bus tracing. The key is no longer supported. No action is performed. Enablement of job tracing. Enablement of DoIP tracing.

'TI', ODXTexts. 'TIWithID', DisplayType 'LongNames', 'ShortNames' ODXTexts. 'TRUE', DisplayEmptyCustomerTextsHierarchical 'FALSE' DiagnosisCommunication. Integer [0, SchedulerTimeoutInSeconds 10000] DiagnosisCommunication. 'TRUE', DisplayPartialResults 'FALSE' DiagEntrance. 'TRUE', ReadVINOnProjectEntry 'FALSE' DiagEntrance. 'TRUE', DayCounter 'FALSE' DiagEntrance. 'TRUE', LastClearDateOfFunctionalEventMemory 'FALSE' DiagEntrance. 'TRUE', Mileage 'FALSE' DiagEntrance. 'TRUE', OnboardTime 'FALSE' DiagEntrance. 'TRUE', WarmupCycleCounter 'FALSE' DiagEntrance. Integer [0, TimeoutForVehicleSearchInSeconds 1000] DiagEntrance. 'TRUE', GatewayComponentList 'FALSE'

DiagnosisData. CustomerSpecificOperationMode

'TRUE', 'FALSE'

Flashing. StopCoordinatedFlashProcessOnError

'TRUE', 'FALSE'

SFD.EndToEndProtectionModeOffline

'TRUE', 'FALSE'

Display kind of ODX texts. Display of empty customer text (flat or hierarchical). Timeout for scheduler in seconds. Display parts of incorrect control unit response. Read vin after selecting a project. Read day counter. Read the date of last functional clear of event memory. Read onboard mileage. Read onboard time. Read warmup cycle (unlearn) counter. Timeout for vehicle search in seconds. Use the busmaster coding list for vehicle functions. If TRUE use customer specific data (projects, VRT/VPT, DIDB) from installation else use this data from the location defined in administration under storage->diagnosis data. See admin setting general->diagnosis data->ODX projects. A change is only done if no project is loaded. Stops the coordinated flashing process at the first error. Flag if following SFD End-To-End coverage operations take place offline or online. The Flag is valid for the duration of the session or until it is changed by this parameter.

Parameters: paramKey - The key of the setting. paramValue - The new value of the setting.

Throws: DiagException - If an error occurs while setting the key value.

setLocale public void setLocale(String language, String country)  throws DiagException

Setting the locale for all diagnostic functions. Parameters: language - The language like de. country - The country like DE.

Throws: DiagException - If an error occurs while setting the locale.

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

Setting the API trace level for all diagnostic functions. Parameters: level - The trace level.

Throws: DiagException - If an error occurs while setting trace level.

Not available for web service.

setCommunicationTrace public void setCommunicationTrace(IConfigurationInterface.TRACE_STATE traceState)  throws DiagException

Starts or stops the tracing of BUS, DoIP or JOB traces. Which traces are affected is configured within configureSetting. Parameters: traceState - The state for tracing.

Throws: DiagException - If an error occurs while setting trace.

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: Versions of the used modules. Throws: DiagException - If an error occurs while initializing the version info.

getODXVersions public List 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: DiagException - If an error occurs while processing the request.

closeConnection public void closeConnection(IConnectionHandle connectionHandle)  throws DiagException

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: connectionHandle - Handle for control unit connection.

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: connectionHandle - Handle for control unit connection.

Throws: DiagException - If an error occurs while setting the internal flag.

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 86 89

Update programming Developper mode Standard selfdiagnostics

Parameters: connectionHandle - Handle for control unit connection. session - Diagnostic session to switch to.

Returns: General response. Throws: DiagException - If an error occurs while switching session.

disableTransportMode public void disableTransportMode() throws DiagException

Reactivation of a vehicle after a long time of idleness e.g. storage or transport. Throws: DiagException - If an error occures while deactivating the transport mode.

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: DiagException - If an error occures while activating the transport mode.

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: connectionHandle - Handle for control unit connection

Returns: True, if current control unit is in principle flashable. Throws: DiagException - If the call fails.

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: connectionHandle - Handle for control unit connection. containerFileName - Name of the container file with full path. sessionName - The session name to flash. A null value is allowed.

Returns: True if the current control unit is flashable with the containerFileName content. Throws: DiagException - If call fails.

checkFlashPreConditions public List checkFlashPreConditions( IConnectionHandle connectionHand le) throws DiagException

Checks the flashing preconditions for the current control unit and delivers the list of unfulfilled conditions.

Parameters: connectionHandle - Handle for control unit connection.

Returns: The list of unfulfilled preconditions or an empty list if all conditions are fulfilled. Throws: DiagException - If call fails.

flashProgramming public IDiagResultFlashSession flashProgramming(IConnectionHandle connectionHandle, String containerFileName, String sessionName, Boolean checkSessionWithEcu)  throws DiagException

Update programming with an update container. Parameters: connectionHandle - Handle for control unit connection. containerFileName - Name of the container file with full path. 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: The result of the update programming Throws: DiagException - If call fails.

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: ecuAddress - The ecu address of the control unit. containerFilePath - The file path of the flash container sessionName - The name of the selected session. 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: The created flash session descriptor. Throws: DiagException - If ecu, flash container or session are not available

flashProgrammingParallel public IDiagResultFlashProgramming flashProgrammingParallel(List  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: The result of the update programming Throws: DiagException - If call fails.

flashProgrammingCoordinated public IDiagResultFlashProgramming flashProgrammingCoordinated(List flashSessionDescriptors,  List 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: The result of the update programming Throws: DiagException - If call fails.

Not available for web service.

flashProgrammingCoordinated public IDiagResultFlashProgramming flashProgrammingCoordinated( List 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: The result of the update programming Throws: DiagException - If call fails.

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: coordinationZipFilePath - the path of the zip archive.

Returns: The result of the update programming

Throws: DiagException - If call fails.

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: flashControlFilePath - the path of the control file checkExpectedIdents - Switch to enable the check of expected idents. Maybe null, than default

TRUE is used. Returns: The result of the update programming Throws: DiagException - If call fails.

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: connectionHandle - Handle for control unit connection. containerFileName - Name of container file with full path. 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: The names of the flash sessions in the container; may be empty.

Throws: DiagException - If call fails.

createBasicSetting2 public IDiagDescriptor2WithParametersAndMeasurements createBasicSetting2( String basicSettingN ame, Map parameters, List 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: basicSettingName - The basic setting name. parameters - Parameters for the basic setting. measurements - The configured measurements.

Returns: The diag basic setting object. Throws: DiagException - If an error occurs while calling this function.

createBasicSetting public IDiagDescriptorWithParametersAndMeasurements createBasicSetting( String basicSettingNam e, Map parameters, List 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: basicSettingName - The basic setting name. parameters - Parameters for the basic setting. measurements - The configured measurements.

Returns: The diag basic setting object. Throws: DiagException - If an error occurs while calling this function.

basicSettingCheck public List basicSettingCheck( IConnectionHandle connectionHandle, List basicSettings) throws DiagException

Starts the basic setting diagnosis check for: the specified settings (UDS control units). the setting specified in basicSettingInit (KWP control units) Parameters: connectionHandle - Handle for control unit connection basicSettings -

UDS: The basic settings to check. KWP: No basic settings to specify. Returns: The state and measurement values if set. Throws: DiagException - If an error occures while calling this function.

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: connectionHandle - Handle for control unit connection

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 basicSettings, List 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: connectionHandle - Handle for control unit connection. basicSettings - The basic settings to init. 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: DiagException - If an error occures while calling this function.

basicSettingInit public void basicSettingInit( IConnectionHandle connectionHandle, List basicSettings, List 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: connectionHandle - Handle for control unit connection. basicSettings - The basic settings to init. 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: DiagException - If an error occures while calling this function.

basicSettingStart public List basicSettingStart( IConnectionHandle connectionHandle, List basicSettings) throws DiagException

Starts the basic setting diagnosis for: the specified settings (UDS control units). the setting specified in basicSettingInit (KWP control units) Parameters: connectionHandle - Handle for control unit connection 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: DiagException - If an error occures while calling this function.

basicSettingStop public List basicSettingStop(IConnectionHandle connectionHandle, List basicSettings)  throws DiagException

Stops the basic setting diagnosis for: the specified settings (UDS control units). the setting specified in basicSettingInit (KWP control units) Parameters: connectionHandle - Handle for control unit connection basicSettings -

UDS: The basic settings to stop. KWP: No basic settings to specify. Returns: The status of the stop operation. Throws: DiagException - If an error occures while calling this function.

basicSettingNext public List 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: connectionHandle - Handle for control unit connection

Returns: The status of the operation and measurement values if set. Throws: DiagException - If an error occurs while calling this function or the function is called for a KWP

control unit.

basicSettingSwitch public List 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: connectionHandle - Handle for control unit connection

Returns: The status of the operation and measurement values if set. 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 basicSettingWaitUntilNotRunning(IConnectionHandle connectionHan dle,  List 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: connectionHandle - Handle for control unit connection basicSettings -

UDS: The basic settings for which the measurement values will be read. KWP: No basic settings to specify. timeout - Time out in ms for stopping process.

Returns: The status information. Throws: DiagException - If an error occurs while calling this function.

Not available for web service.

getShortNamesOfBasicSettings public List 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: connectionHandle - Handle for control unit connection

Returns: The measurement values. Throws: DiagException - If an error occurs while calling this function or the function is called for a KWP

control unit.

getShortNamesOfStartParametersForBasicSettings public List 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: connectionHandle - Handle for control unit connection basicSettingName - The name of the basic setting.

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 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: connectionHandle - Handle for control unit connection

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 immediateRoutineParameters) throws DiagException

Starts the immediate routine with the provided parameters for the specified control unit. Parameters: connectionHandle - - Handle for control unit connection immediateRoutineName - - The name of the immediate routine to be started.

Returns: The status of the start operation. Throws: DiagException - If an error occurs while calling this function.

getShortNamesOfStartParametersForImmediateRoutine public List getShortNamesOfStartParametersForImmediateRoutine(IConnectionHandle connec tionHandle, String immediateRoutineName)  throws DiagException

Returns the ODX short names of all available start parameters from the specified immediate routine. Parameters: connectionHandle - Handle for control unit connection immediateRoutineName - The name of the immediate routine.

Returns: The parameters. Throws: DiagException - If an error occurs while calling this function.

getShortNamesOfImmediateRoutines public List 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: connectionHandle - Handle for control unit connection

Returns: The immediate routine short names. 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: connectionHandle - Handle for control unit connection. xmlFilePath - Absolute path to the xml file or zip-archive.

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: DiagException - If an error occurs while processing the request.

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: listNumber - The list number of the entry. listPosition - The list position. nodeId - The node id. isCoded - Flag to indicate if the entry is coded.

Returns: The component list entry. Throws: DiagException - If an error occurs while calling this function.

Not available for web service.

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: listNumber - The list number of the entry.

isCoded - Flag to indicate if the entry is coded.

Returns: The component list entry. Throws: DiagException - If an error occurs while calling this function.

Not available for web service.

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: ecuId - The ecu address of the entry. listPosition - The list position of the antry. nodeId - The node address of the entry. isCoded - Flag to indicate if the entry is coded.

Returns: The component list entry. Throws: DiagException - If an error occurs while calling this function.

Not available for web service.

createComponentListEntry public IDiagComponentListEntry createComponentListEntry(int ecuId, boolean isCoded)  throws DiagException

Creates an component list entry for writing the gateway component list.

Parameters: ecuId - The ecu address of the entry. isCoded - Flag to indicate if the entry is coded.

Returns: The component list entry. Throws: DiagException - If an error occurs while calling this function.

Not available for web service.

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: connectionHandle - Handle for control unit connection.

Returns: The gateway component list. Throws: DiagException - If an error occurs while calling this function.

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: connectionHandle - Handle for control unit connection.

Returns: The subsystem component list.

Throws: DiagException - If an error occurs while calling this function.

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: connectionHandle - Handle for control unit connection.

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 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: connectionHandle - Handle for control unit connection. componentList - The subsystem components.

Returns: General response. Throws: DiagException - If an error occurs while calling this function.

updateSubsystemComponentList public IDiagResultComponentList updateSubsystemComponentList( IConnectionHandle connectionHand le) throws DiagException

Updates the subsystem component list of the currently selected control unit (only for macro api). Parameters: connectionHandle - Handle for control unit connection.

Returns: The updated subsystem component list. Throws: DiagException - If an error occurs while calling this function.

Not available for web service.

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: connectionHandle - Handle for control unit connection.

Returns: The software composition component list. Throws: DiagException - If an error occurs while calling this function.

createSoftwareCompositionComponentCodingDescriptor public IDiagMultiSoftwareCompositionComponentCodingDescriptor createSoftwareCompositionCompone ntCodingDescriptor( IMultilinkEcuHandle controlUnit, List compositionComponents) throws DiagException

Description copied from interface: ISoftwareCompositionComponentListInterface Creates an coding descriptor to code software composition components with multilink. Parameters: controlUnit - - the control unit to gets its components coded compositionComponents - - the composition component entries

Returns: the created constructor. Throws: DiagException - If an error occurs while calling this function.

writeMultilinkSoftwareCompositionComponentList public List writeMultilinkSoftwareCompositionComponentList( List codingDescriptors) throws DiagException

Description copied from interface: ISoftwareCompositionComponentListInterface Writes the specified software composition components to the corresponding control unit with multilink. Parameters: codingDescriptors - composition component coding descriptors

Returns: General response. Throws: DiagException - If an error occurs while calling this function.

readMultilinkSoftwareCompositionComponentList public List readMultilinkSoftwareCompositionCompo nentList( List ecuList) throws DiagException

Description copied from interface: ISoftwareCompositionComponentListInterface Reads the software composition component list for all specified control units.

Parameters: ecuList - - handles of all control units to be read

Returns: The software composition component lists for all specified control units. Throws: DiagException - If an error occurs while calling this function.

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: connectionHandle - Handle for control unit connection.

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 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: connectionHandle - Handle for control unit connection. componentList - The software composition components.

Returns: General response. Throws: DiagException - If an error occurs while calling this function.

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: connectionHandle - Handle for control unit connection.

Returns: The updated software composition component list. Throws: DiagException - If an error occurs while calling this function.

Not available for web service.

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: connectionHandle - Handle for control unit connection.

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 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: connectionHandle - Handle for control unit connection. componentList - The gateway components.

Returns: General response. Throws: DiagException - If an error occurs while calling this function.

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: connectionHandle - Handle for control unit connection. componentListBinary - Component list as binary array.

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 adaptationPresets, List measurementPresets, List identificationPresets, List additionalPresets) throws DiagException

Creates VDS/BZD protocol. Closes all connections after running. Parameters: vin - VIN maybe null, than current vin is used vehicleNumber - Vehicle number. readEventMemory - Read event memory before creating protocol userName - User name used for login. Maybe null, than user name of looged in user of computer is

used. mileage - Optional (null allowed) mileageUnit - Optional (null allowed) adaptationPresets - Optional (null allowed) measurementPresets - Optional (null allowed) identificationPresets - Optional (null allowed) additionalPresets - Optional (null allowed)

Returns: Name / id of the generated protocol Throws: DiagException - If creation fails

createProtocolVDSBZD public String createProtocolVDSBZD(String vin,  String vehicleNumber,  boolean readEventMemory,  String userName,  String measuringLocation,  String measuringType,  Long mileage,  ITotalSystemsInterface.MileageUnit mileageUnit,  List adaptationPresets,  List measurementPresets,  List identificationPresets,  List additionalPresets,  Boolean useGatewayComponentList) throws DiagException

Creates VDS/BZD protocol. Closes all connections after running. Parameters: vin - VIN maybe null, than current vin is used vehicleNumber - Vehicle number. readEventMemory - Read event memory before creating protocol userName - User name used for login. Maybe null, than user name of looged in user of computer is

used. mileage - Optional (null allowed) mileageUnit - Optional (null allowed) adaptationPresets - Optional (null allowed) measurementPresets - Optional (null allowed) identificationPresets - Optional (null allowed) additionalPresets - Optional (null allowed) useGatewayComponentList - Optional, used to define if gateway component list or the complete

component list must be used. (null allowed, to use administration settings) Returns: Name / id of the generated protocol Throws: DiagException - If creation fails

getAvailableProtocols public List getAvailableProtocols()  throws DiagException

Gets a list of generated protocols. Returns: List of names / ids of generated protocols Throws: DiagException - If retrieving list fails

getAvailableAdaptationPresets public List getAvailableAdaptationPresets()  throws DiagException

Gets the list of available adaptation presets. Returns: List of available adaptation presets Throws: DiagException - If retrieving list fails

getAvailableMeasurementPresets public List getAvailableMeasurementPresets() throws DiagException

Gets the list of available measurement presets. Returns: List of available measurement presets Throws: DiagException - If retrieving list fails

getAvailableIdentificationPresets public List getAvailableIdentificationPresets()  throws DiagException

Gets the list of available identification presets. Returns: List of available identification presets Throws: DiagException - If retrieving list fails

getAvailableAdditionalPresets public List getAvailableAdditionalPresets()  throws DiagException

Gets the list of available addtional presets. Returns: List of available addtional presets Throws: DiagException - If retrieving list fails

loginService42 public void loginService42( String user, String password) throws DiagException

Login to the Volkswagen-Integration-Infrastructure (DMS-BB) via diagnostic session service. Parameters: user - User to connect to the Volkswagen-Integration-Infrastructure password - Password for connection

Throws: DiagException - If login fails

logoutService42 public void logoutService42()  throws DiagException

Logout from the Volkswagen-Integration-Infrastructure (DMS-BB) via diagnostic session service. Throws: DiagException - If logout fails

readAvailableCarportBrands public List readAvailableCarportBrands() throws DiagException

Read teh available brands that may be used when sending protocols to carport (see ITotalSystemsInterface.sendProtocolsToCarport(List, String, String)). Returns: the available brands. Throws: DiagException - If Brands can not be determined.

sendProtocolsToCarport public IDiagResultProtocolTransfer sendProtocolsToCarport(List protocolNames, String taskCode, String brand)  throws DiagException

Sends protocols to carport system. Parameters: protocolNames - Identifier of protocol to send. See TotalSystemsInterfaceImpl.getAvailableProtocols( de.volkswagen.odis.vaudas.vehicl efunction.automation.TotalSystemsInterfaceImpl.ProtocolType) and TotalSystemsInterfaceImpl.createProtocolVDSBZD(String, String, boolean, String, String, String, Long, MileageUnit, List, List List). 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: Result object of protocol transfer

Throws: DiagException - If sending fails

sendProtocolsToFileServer public IDiagResultProtocolTransfer sendProtocolsToFileServer( List protocolNames, String destinationPath) throws DiagException

Sends protocols to the specified file server.

Parameters: protocolNames - - Identifiers of protocols to send. destinationPath - - The fully qualified path to a target directory;

Returns: Result object of protocol transfer. Throws: DiagException - If errors occur while sending.

sendProtocolsToVDS public IDiagResultProtocolTransfer sendProtocolsToVDS(List protocolNames)  throws DiagException

Sends protocols to the VDS system.

Parameters: protocolNames - - Identifiers of protocols to send.

Returns: Result object of protocol transfer. Throws: DiagException - If errors occur while sending.

sendProtocolsToAVx public IDiagResultProtocolTransfer sendProtocolsToAVx(List protocolNames)  throws DiagException

Sends protocols to the AVx system.

Parameters: protocolNames - - Identifiers of protocols to send.

Returns: Result object of protocol transfer. Throws: DiagException - If errors occur while sending.

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: logicalLink - The link for which the parameters can be set. name - The parameter to set. value - The value to set.

Throws: DiagException - If an error occurs while writting the parameter.

setCommParameters public void setCommParameters(String logicalLink, Map 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: logicalLink - The link for which the parameters can be set.

Throws: DiagException - If an error occurs while writting the parameter.

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. name - The parameter to get.

Returns: The communication parameter. Throws: DiagException - If an error occurs while reading the parameter.

getCommParams public List 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: The list of the communication parameters. Throws: DiagException - If an error occurs while reading the parameters.

getCommParamGroup public List getCommParamGroup(IConnectionHandle connectionHandle, List 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. paramNames - The parameters to get.

Returns: The communication parameters, may be empty if no matching parameter exists. Throws: DiagException - If an error occurs while reading the parameters.

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: logicalLink - The link for which the parameters can be get. name - The parameter to get.

Returns: The communication parameter.

Throws: DiagException - If an error occurs while reading the parameter.

getCommParamsDefault public List 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: logicalLink - The link for which the parameters can be get.

Returns: The list of the default communication parameters. Throws: DiagException - If an error occurs while reading the parameters.

getCommParamGroupDefault public List getCommParamGroupDefault( String logicalLink, List 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: logicalLink - The link for which the parameters can be get. paramNames - The parameters to get.

Returns: The communication parameters, may be empty if no matching parameter exists. Throws: DiagException - If an error occurs while reading the parameter.

getCommParamConfig public IDiagResultCommParam getCommParamConfig( String logicalLink, String name) throws DiagException

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: logicalLink - The link for which the parameters can be get. name - The parameter to get.

Returns: The communication parameter. Throws: DiagException - If an error occurs while reading the parameter.

getCommParamsConfig public List 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: logicalLink - The link for which the parameters can be get.

Returns: The list of the modified communication parameters. Throws: DiagException - If an error occurs while reading the parameters.

getCommParamGroupConfig public List getCommParamGroupConfig(String logicalLink, List 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: logicalLink - The link for which the parameters can be get. paramNames - The parameters to get.

Returns: The communication parameters, may be empty if no matching parameter exists. Throws: DiagException - If an error occurs while reading the parameter.

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: logicalLink - The link for the parameters to reset.

Throws: DiagException - If an error occurs while setting the parameter.

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: logicalLink - The link for the parameter to reset. name - Name of the parameter.

Throws: DiagException - If an error occurs while reading the parameter.

resetAllCommParameters public void resetAllCommParameters() throws DiagException

Resets all communication parameters to their initial values. Like setCommParameter changes will not take effect until reopening the logical link. Throws: DiagException - If an error occurs while resetting the parameters.

setBaudrate public void setBaudrate(IConfigureCommParamInterface.Baudrate baudrate)  throws DiagException

Set control unit independent baud rate. Parameters: baudrate - Desired baudrate for all control units

Throws: DiagException - If an error occurs while setting baudrate.

getLockedConnections public List getLockedConnections()  throws DiagException

Returns currently locked connections. Returns: The locked connections. Throws: DiagException - If an error occurs while getting the lock state.

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: connectionHandle - Connection handle to set the lock for.

Throws: DiagException - If an error occurs while setting the lock.

unlockConnection public void unlockConnection( IConnectionHandle connectionHandle) throws DiagException

Removes the lock for the specified connection. Parameters: connectionHandle - The connection handle to remove the lock for.

Throws: DiagException - If an error occurs while removing the lock.

getDoIPVCIs public List getDoIPVCIs()  throws DiagException

Gets the current DoIP VCIs without refreshing. Returns: The result list of DoIP VCIs. If no VCI is available the list is empty. Throws: DiagException - If an error occures while getting the DoIP VCIs

searchDoIPVCIs public List searchDoIPVCIs( String ipAddress) throws DiagException

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: DiagException - If an error occures while searching the DoIP VCIs

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: projectName - The project name.

Throws: DiagException - If an error occurs while setting the vehicle project.

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: projectMode - The project mode to control the kind of project determination

Returns: the project name 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. projectName - The project name.

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. projectMode - The project mode to control the kind of project determination

Returns: the project name

Throws: 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: toSet - TRUE /FALSE to switch ON / OFF

Throws: DiagException - If an error occurs while set / unset the activation line.

unloadProject public void unloadProject()  throws DiagException

Unloads the vehicle project. Throws: DiagException - if vehicle project cannot be unloaded

getClamp15State public String getClamp15State()  throws DiagException

Returns the current clamp 15 (ignition) state. Returns: the clamp 15 state. Possible values are "on", "off", "not available". Throws: DiagException - if an error occurs while processing the request.

getClamp30State public String getClamp30State()  throws DiagException

Returns the current clamp 30 (battery) state. Returns: the clamp 30 state. Possible values are "on", "off", "not available". Throws: DiagException - if an error occurs while processing the request.

checkVciState public String checkVciState()  throws DiagException

Returns the current VCI state. Returns: the VCI state. Possible values are "connected", "not connected", "not available". Throws: DiagException - if an error occurs while processing the request.

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: basicSettingName - - The basic setting name (channel).

Throws: DiagException - - If an error occurs while calling this function.

engineGroupSwitch public List engineGroupSwitch() throws DiagException

Switches the mode of operation for engine group. Two operation modes are availalble: "Fahrzeugsystem in Grundeinstellung" or "Fahrzeugsystem nicht in Grundeinstellung". Returns: The status of the operation and measurement values if set. Throws: DiagException - - If an error occurs while calling this function.

engineGroupCheck public List engineGroupCheck()  throws DiagException

Starts the engine group diagnosis check for the setting specified in enginGroupInit. Returns: The state and measurement values if set. Throws: DiagException - - If an error occurs while calling this function.

engineGroupStart public List engineGroupStart()  throws DiagException

Starts the engine group diagnosis for the setting specified in enginGroupInit. Returns: The status of the start operation and the measurement values if set. Throws: DiagException - -If an error occurs while calling this function.

engineGroupStop public List engineGroupStop() throws DiagException

Stops the engine group diagnosis for: the setting specified in enginGroupInit. Returns: The status of the stop operation. Throws: DiagException - - If an error occurs while calling this function.

initProtocol public void initProtocol() throws DiagException

Inits protocol. Throws: DiagException - If an error occurs while calling this function.

startProtocol public void startProtocol()  throws DiagException

Starts protocol. Throws: DiagException - If an error occurs while calling this function.

stopProtocol public void stopProtocol() throws DiagException

Stops protocol.

Throws: DiagException - If an error occurs while calling this function.

saveProtocol public void saveProtocol() throws DiagException

Saves protocol. Throws: DiagException - If an error occurs while calling this function.

discardProtocol public void discardProtocol()  throws DiagException

Discards protocol. Throws: DiagException - If an error occurs while calling this function.

executeMacro public boolean executeMacro(String macroName)  throws DiagException

Executes a macro. Parameters: macroName - The absolute path name of the macro.

Returns: TODO Throws: DiagException - If an error occurs during macro ececution.

requestSecAccessASM public int requestSecAccessASM( IConnectionHandle connectionHandle) throws DiagException

Requests security access to the ecu for reading ASM data. Parameters: connectionHandle - the ecu connection

Returns: 0 for granted access, 0x7F otherwise Throws: DiagException - If an error occurs while processing request.

Not available for web service.

Package de.volkswagen.odis.vaudas.vehiclefunction.automation Package for common issues of automation.

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

public class 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: getLocalizedMessage in class Throwable

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: Language independent id of exception.

Enum IConfigurationInterface.TRACE_STATE Enum Constant Summary OFF

133

State OFF.

ON

133 State ON.

Enum IConfigureCommParamInterface.Baudrate Enum Constant Summary PROJECT

134

Use baudrate configured in project settings.

RATE_100KBIT

134

Use 100 kBit.

RATE_1MBIT

134

Use 1 MBit.

RATE_500KBIT Use 500 kBit.

134

Interface ITotalSystemsInterface de.volkswagen.odis.vaudas.vehiclefunction.automation

All Known Implementing Classes: DiagnosticInterfaceImpl

public interface ITotalSystemsInterface

Interface for handling data creation and transfer of ecu state informaton.

Method Summary List

readAvailableCarportBrands() Read teh available brands that may be used when sending protocols to carport (see sendProtocolsToCarport(List, String, String)).

List

readEventMemories(List

controlUnitList, List adaptationPresets, List measurementPresets, List identificationPresets, List additionalPresets)

Reads the event memory entries of the specified control unit list. void

1 3 7 1 3 6

resetEventMemories(Boolean

clearOBD, Boolean clearFunctional, Boolean clearNotErasedECUsPhysical, Integer timeBeforePhysicalClear, List unitListForPhysicalDeletion)

Tries to delete the event memories in the vehicle by sending a sequence of diagnostic services.

Method Detail resetEventMemories void resetEventMemories(Boolean clearOBD, Boolean clearFunctional, Boolean clearNotErasedECUsPhysical, Integer timeBeforePhysicalClear, List 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 UDSservice 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.

1 3 5

Parameters: clearOBD - Switch for obd deletion (OBD-Service 0x04 functional). clearFunctional - Switch for functional deletion (TP2.0-broadcast and UDS-Service 0x14). clearNotErasedECUsPhysical - Switch for physically deletion of all defined units, which KD-Bit is

set in the gateway component list. timeBeforePhysicalClear - Waiting time in seconds between functional clear and reading of

fitment list for physical clear. 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: DiagException - If an error occurs while deleting the event memories.

readEventMemories List readEventMemories(List controlUnitList,  List adaptationPresets,  List measurementPresets,  List identificationPresets,  List 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: controlUnitList - the control unit list adaptationPresets - the preset names for the additional adaptations measurementPresets - the preset names for the additional measurements identificationPresets - the preset names for the additional identifications additionalPresets - the preset names for special measurements and adaptations

Returns: the event memory entries of the read control units. Throws: DiagException - If reading fails

readAvailableCarportBrands List readAvailableCarportBrands()  throws DiagException

Read teh available brands that may be used when sending protocols to carport (see sendProtocolsToCarport(List, String, String)). Returns: the available brands. Throws: DiagException - If Brands can not be determined.

Enum ITotalSystemsInterface.MileageUnit Enum Constant Summary KM

138

Kilometres.

MILES Miles.

Package de.volkswagen.odis.vaudas.vehiclefunction.automation.types Return types and input types of automation interface functions.

See: Description

Package de.volkswagen.odis.vaudas.vehiclefunction.automation.types Description Return types and input types of automation interface functions.

138

Interface IConnectionHandle de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IConnectionHandle

Handle for all single ECU dependent calls.

Method Summary Long getHandle() Return the handle for identifying a connection.

Method Detail getHandle Long getHandle()

Return the handle for identifying a connection. Returns: The connection handle.

1 3 9

Interface IDiagComponentListEntry de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagComponentListEntry

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() Return the diagnostic address of the entry. int

getListPosition() Returns the list position in the gateway component list of this entry.

long

getNodeId() Returns the node address of this entry.

boolean

isCoded() Checks if the state of this entry is coded.

boolean

isListPositionAvailable() Is the value for list position available and can be used..

boolean

isNodeIdAvailable() Is the value for node id available and can be used..

void

setCoded(boolean

coded)

Sets the coded state for this entry.

Method Detail getEcuId int getEcuId()

Return the diagnostic address of the entry. Returns: The address of this entry.

1 4 0 1 4 1 1 4 1 1 4 2 1 4 1 1 4 1 1 4 2

getNodeId long getNodeId()

Returns the node address of this entry. Returns: The node address.

isNodeIdAvailable boolean isNodeIdAvailable()

Is the value for node id available and can be used.. Returns: If the value for node is available and can be used.

getListPosition int getListPosition()

Returns the list position in the gateway component list of this entry. Returns: The list position.

isListPositionAvailable boolean isListPositionAvailable()

Is the value for list position available and can be used.. Returns: If the value for list position is available and can be used.

isCoded boolean isCoded()

Checks if the state of this entry is coded. Returns: True if the entry is coded otherwise false.

setCoded void setCoded(boolean coded)

Sets the coded state for this entry. Parameters: coded - The coded state to set.

Interface IDiagDescriptor2WithParametersAndMeasurements de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagDescriptor2WithParametersAndMeasurements

Interface for gathering the information for an actuator or setting.

Method Summary List

getMeasurements() Returns the list of configured measurements.

Map

getParameters() Returns the parameter list.

String

getShortName() Returns the short name of the descriptor.

Method Detail getShortName String getShortName()

Returns the short name of the descriptor. Returns: The short name

getParameters Map getParameters()

Returns the parameter list. Returns: The parameter list.

1 4 4 1 4 3 1 4 3

getMeasurements List getMeasurements()

Returns the list of configured measurements. Returns: The list of configured measurements.

Interface IDiagDescriptorWithParametersAndMeasurements de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagDescriptorWithParametersAndMeasurements

Interface for gathering the information for an actuator.

Method Summary List getMeasurements() Returns the list of configured measurements. Map

getParameters() Returns the parameter list.

String

getShortName() Returns the short name of the descriptor.

Method Detail getShortName String getShortName()

Returns the short name of the descriptor. Returns: The short name

getParameters Map getParameters()

Returns the parameter list. Returns: The parameter list.

1 4 6 1 4 5 1 4 5

getMeasurements List getMeasurements()

Returns the list of configured measurements. Returns: The list of configured measurements.

Interface IDiagFlashSessionDescriptor de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagFlashSessionDescriptor

Interface for gathering the information for a flash session.

Method Summary IConnectionHandle getConnectionHandle() Delivers the handle to identify connection. String

getContainerPath() Delivers the flash container file path of this descriptor.

String

getSessionName() Delivers the session name of this descriptor.

Boolean

isCheckSessionWithEcu() State of switch if check is activated for UDS on expected idents and for KWP on part number and software version.

Method Detail getConnectionHandle IConnectionHandle getConnectionHandle()

Delivers the handle to identify connection. Returns: the handle to identify connection.

getContainerPath String getContainerPath()

Delivers the flash container file path of this descriptor. Returns: The flash container file path.

1 4 7 1 4 7 1 4 8 1 4 8

getSessionName String getSessionName()

Delivers the session name of this descriptor. Returns: The session name.

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: Value of switch for check.

Interface IDiagMeasurementDescriptor de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagMeasurementDescriptor

Interface for gathering the information for a measurement.

Method Summary long getEcuAddress() Retrieves the address of this descriptor's control unit. String

getGroup() Retrieves this despriptor's measurement group.

String

getParameter() Retrieves this despriptor's measurement parameter.

Method Detail getEcuAddress long getEcuAddress()

Retrieves the address of this descriptor's control unit. Returns: The address.

getGroup String getGroup()

Retrieves this despriptor's measurement group. 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: The measurement group.

1 4 9 1 4 9 1 5 0

getParameter String getParameter()

Retrieves this despriptor's measurement parameter. For UDS this is the ODX short name of the measurement value, for KWP this is the position number, given as string: .i.e. oneof "1" to "4". Returns: The measurement parameter.

Interface IDiagMultiAdaptionDescriptor de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagMultiAdaptionDescriptor

Interface to describe a adaptation.

Method Summary String getAdaption() Retrieves this despriptor's adaption name. IMultilinkEcuHandl e

getMultilinkEcuHandle() Retrieves the handle of this descriptor's control unit.

Method Detail getMultilinkEcuHandle IMultilinkEcuHandle getMultilinkEcuHandle()

Retrieves the handle of this descriptor's control unit. Returns: The address.

getAdaption String getAdaption()

Retrieves this despriptor's adaption name. Returns: The name of the adaption(-channel).

1 5 1 1 5 1

Interface IDiagMultiAdaptionValueDescriptor de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagMultiAdaptionValueDescriptor

Interface to describe a adaptation value for writing.

Method Summary Map

getAdaptationValues() Retrieves the adaptation values which shall be written.

IDiagMultiAdaptionDescriptor

getAdaptionDescriptor() Retrieves the descriptor for the adaptation.

Method Detail getAdaptionDescriptor IDiagMultiAdaptionDescriptor getAdaptionDescriptor()

Retrieves the descriptor for the adaptation. Returns: The descriptor for the adaptation.

getAdaptationValues Map getAdaptationValues()

Retrieves the adaptation values which shall be written. Returns: the adaptation values which shall be written.

1 5 2 1 5 2

Interface IDiagMultiCodingValueDescriptor de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagMultiCodingValueDescriptor

Interface for gathering the information for a coding.

Method Summary String

getByteCoding() Return the coding value as byte coding value.

IDiagResultValue.ValueType

getByteCodingValueType() Returns the value type of the byte coding.

IMultilinkEcuHandle

getMultilinkEcuHandle() Retrieves the handle of this descriptor's control unit.

String

getSystemName() Returns the system name of the control unit.

Map

getTextCoding() Returns a plain text representation of the coding value.

Boolean

isEcuReset() Checks the execution of a ecu reset after coding process.

Method Detail getMultilinkEcuHandle IMultilinkEcuHandle getMultilinkEcuHandle()

Retrieves the handle of this descriptor's control unit. Returns: The address.

1 5 4 1 5 5 1 5 3 1 5 4 1 5 4 1 5 4

isEcuReset Boolean isEcuReset()

Checks the execution of a ecu reset after coding process. Returns: true if the reset should be performed after coding.

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: The (sub)system name.

getTextCoding Map 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: The plain text representation of the coding value.

getByteCoding String getByteCoding()

Return the coding value as byte coding value. Is valid for kwp and uds control units. Returns: The byte representation of the coding value.

getByteCodingValueType IDiagResultValue.ValueType getByteCodingValueType()

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: Value type of the byte coding.

Interface IDiagMultiMeasurementDescriptor de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagMultiMeasurementDescriptor

Interface for gathering the information for a measurement.

Method Summary String getGroup() Retrieves this despriptor's measurement group. IMultilinkEcuHandl e

getMultilinkEcuHandle() Retrieves the handle of this descriptor's control unit.

String

getParameter() Retrieves this despriptor's measurement parameter.

Method Detail getMultilinkEcuHandle IMultilinkEcuHandle getMultilinkEcuHandle()

Retrieves the handle of this descriptor's control unit. Returns: The address.

getGroup String getGroup()

Retrieves this despriptor's measurement group. 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: The measurement group.

1 5 6 1 5 6 1 5 7

getParameter String getParameter()

Retrieves this despriptor's measurement parameter. For UDS this is the ODX short name of the measurement value, for KWP this is the position number, given as string: .i.e. oneof "1" to "4". Returns: The measurement parameter.

Interface IDiagMultiSoftwareCompositionComponentCodingDescriptor de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagMultiSoftwareCompositionComponentCodingDescriptor

Interface for gathering the information to code software composition components.

Method Summary List

getCodingList() Retrieves the composition components that should be coded.

IMultilinkEcuHandle

getMultilinkEcuHandle() Retrieves the handle of this descriptor's control unit.

Method Detail getMultilinkEcuHandle IMultilinkEcuHandle getMultilinkEcuHandle()

Retrieves the handle of this descriptor's control unit. Returns: The address.

getCodingList List getCodingList()

Retrieves the composition components that should be coded. Returns: The composition components

1 5 8 1 5 8

Interface IDiagResult de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Known Subinterfaces: IDiagResultAdaptation, IDiagResultCoding, IDiagResultDatasetDownload, IDiagResultDtcSnapshot, IDiagResultDtcSnapshotList, IDiagResultEventMemory, IDiagResultFlashProgramming, IDiagResultFlashSession, IDiagResultMeasurement, IDiagResultMemoryCells, IDiagResultMulti, IDiagResultSFD, IDiagResultSFDStatus, IDiagResultSpecialCoding, IDiagResultStatus, IDiagResultTable

public interface IDiagResult

Standard result object to handel negative responses from an ecu. *

Method Summary IDiagResultNegativeResponse

void

getNegativeResult()

1 5 9

setNegativeResult(IDiagResultNegativeResponse

1 5 9

negativeResult)

Sets the negative response object..

Method Detail getNegativeResult IDiagResultNegativeResponse getNegativeResult()

Returns: The negative response result value.

setNegativeResult void setNegativeResult(IDiagResultNegativeResponse negativeResult)

Sets the negative response object.. Parameters: negativeResult - The response object to set.

Interface IDiagResultAdaptation de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult, IDiagResultTable

public interface IDiagResultAdaptation extends IDiagResultTable, IDiagResult

Interface for handling the results of reading adaptation values.

Method Summary List

long

getAdaptationValues()

1 6 1

getEcuAddress()

1 6 0

Retrieves the address of the control unit for which this result holds the values. String

getErrorMessage() Returns a message of the error occured while reading the adaptation using readMultilinkAdaptation.

String

getLogicalLinkname()

String

getRecordDataIdentifier()

1 6 1

1 6 Retrieves the logical linkname of the control unit for which this result holds 1 the values.

Returns the record data identifier of the executed service.

Method Detail getEcuAddress long getEcuAddress()

Retrieves the address of the control unit for which this result holds the values.

1 6 1

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: The error message or an empty string.

getRecordDataIdentifier String getRecordDataIdentifier()

Returns the record data identifier of the executed service. Returns an empty string if no record data identifier is available. Returns: the record data identifier.

getAdaptationValues List getAdaptationValues()

Returns: Adaptation values.

Interface IDiagResultAdaptationValue de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultAdaptationValue

Interface for handeling the results of reading adaptation values.

Method Summary IDiagResultValue getAdaptationValue() Returns the read adaption value. List

String

1 6 3

getMeasuredValues()

1 6 Returns the list of measured values returned from the control unit while reading the 3 adaptation value. getRecordDataIdentifier() Returns the record data identifier of the executed service.

Method Detail getAdaptationValue IDiagResultValue getAdaptationValue()

Returns the read adaption value. Returns: The adaptation value.

getMeasuredValues List getMeasuredValues()

Returns the list of measured values returned from the control unit while reading the adaptation value. Returns: The list of measured values

1 6 4

getRecordDataIdentifier String getRecordDataIdentifier()

Returns the record data identifier of the executed service. Returns an empty string if no record data identifier is available. Returns: the record data identifier.

Interface IDiagResultCoding de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

public interface IDiagResultCoding 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() Return the coding value as byte coding value.

IDiagResultValue.ValueType

getByteCodingValueType() Returns the value type of the byte coding.

long

getEcuAddress() Returns the address of the control unit.

String

getErrorMessage()

String

getLogicalLinkname()

getSystemName() The system name of the control unit.

Map

1 6 7 1 6 6

1 6 Returns the message of the error occured while reading the coding values using 7 readMultilinkCoding.

Returns the logical linkname of the control unit. String

1 6 6

getTextCoding() Returns a plain text representation of the coding value.

1 6 6 1 6 6 1 6 7

Method Detail getEcuAddress long getEcuAddress()

Returns the address of the control unit.

Returns: The address.

getLogicalLinkname String getLogicalLinkname()

Returns the logical linkname of the control unit. 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: The (sub)system name.

getByteCoding String getByteCoding()

Return the coding value as byte coding value. Is valid for kwp and uds control units. Returns: The byte representation of the coding value.

getErrorMessage String getErrorMessage()

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: The error message or an empty string.

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: Value type of the byte coding.

getTextCoding Map 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: The plain text representation of the coding value.

Interface IDiagResultCommParam de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultCommParam

Represents the result of a communication parameter.

Method Summary String getParamName() Delivers the name of the communication parameter. String

getParamValue() Delivers the value of the communication parameter.

Method Detail getParamValue String getParamValue()

Delivers the value of the communication parameter. Returns: the value of the communication parameter.

getParamName String getParamName()

Delivers the name of the communication parameter. Returns: the name of the communication parameter.

1 6 8 1 6 8

Interface IDiagResultComponentList de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultComponentList

Gateway component list.

Method Summary byte[]

List

getByteCoding()

1 6 9

getComponentListEntries()

1 6 9

Returns the list component entries.

Method Detail getByteCoding byte[] getByteCoding()

Returns: The component list as byte array.

getComponentListEntries List getComponentListEntries()

Returns the list component entries. Returns: The list of component entries.

Interface IDiagResultComponentListEntry de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultComponentListEntry

Represents an entry from the gateway component list.

Method Summary IDiagResultValue

getBusIdentifier() Returns the ODX information for the bus identifier (0x2A2D).

IDiagResultValue

getCodedState() Returns the ODX information for the coded bit (0x04A3).

IDiagResultValue

getDtcInfo() Returns the ODX information for the dtc bit (0x2A28).

int

getEcuId() Return the diagnostic address of the entry.

IDiagResultValue

getEcuIdInformation() Returns the ODX information for the ecu id.

IDiagResultComponentListEntry.EntryType

getEntryType() Gets type of the entry.

int

long

IDiagResultValue

IDiagResultValue

getListPosition()

1 7 7 1 7 4 1 7 5 1 7 2 1 7 2 1 7 7

1 7 Returns the list position in the gateway component list of this entry. 3 getNodeId() 1 7 Returns the node address of this entry. 2 getNodeIdInformation() 1 7 Returns the ODX information for the node id. 3 getPresentState() 1 7 Returns the ODX information for the present bit (0x2A26). 4

List

getProtocolInformation() Returns the ODX information for the protocol entry (0x2A29).

IDiagResultValue

getSleepBit() Returns the ODX information info for the sleep bit (0x2A27).

IDiagResultValue

getTPIdentifier() Returns the ODX information for the TP-CAN-Identifier (0x2A2C).

boolean

isBusIdentifierAvailable() Returns if the bus identifier is available.

boolean

isCoded() Checks if the state of this entry is coded.

boolean

isCodedStateAvailable() Returms if the coded state information is available.

boolean

isDtcInfoAvailable() Checks if the dtc information is available.

1 7 6 1 7 5 1 7 6 1 7 7 1 7 4 1 7 4 1 7 5

boolean

isEcuIdInformationAvailable()

1 7 2

boolean

isListPositionAvailable()

1 7 3

Checks if the list position is available for this entry. boolean

isNodeIdAvailable() Checks if a node id is available for this entry.

boolean

isPresentStateAvailable() Returns if present state information is available.

boolean

isProtocolInformationAvailable() Checks if the protocol information is available.

boolean

isSleepBitAvailable() Checks if the sleep bit is available for this entry.

boolean

isTPIdentifierAvailable() Returns if the tp identifier is available.

1 7 3 1 7 4 1 7 6 1 7 5 1 7 6

Method Detail getEcuId int getEcuId()

Return the diagnostic address of the entry. Returns: The address of this entry.

isEcuIdInformationAvailable boolean isEcuIdInformationAvailable()

Returns: If call of getEcuIdInformation() returns valid information.

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: Value of the ecu id.

getNodeId long getNodeId()

Returns the node address of this entry. Returns: The node address.

isNodeIdAvailable boolean isNodeIdAvailable()

Checks if a node id is available for this entry. Returns: True if a node id is available.

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: Value of the ecu id.

getListPosition int getListPosition()

Returns the list position in the gateway component list of this entry. Returns: The list position.

isListPositionAvailable boolean isListPositionAvailable()

Checks if the list position is available for this entry. Returns: True if list position is available.

isCoded boolean isCoded()

Checks if the state of this entry is coded. Returns: True if the entry is coded otherwise false.

getCodedState IDiagResultValue getCodedState()

Returns the ODX information for the coded bit (0x04A3). Returns: Value of the coded state

isCodedStateAvailable boolean isCodedStateAvailable()

Returms if the coded state information is available. Returns: If the coded state information is available.

getPresentState IDiagResultValue getPresentState()

Returns the ODX information for the present bit (0x2A26). Returns: Value of the is present bit.

isPresentStateAvailable boolean isPresentStateAvailable()

Returns if present state information is available. Returns: If present state information is available.

getSleepBit IDiagResultValue getSleepBit()

Returns the ODX information info for the sleep bit (0x2A27). Returns: Value of the sleep bit.

isSleepBitAvailable boolean isSleepBitAvailable()

Checks if the sleep bit is available for this entry. Returns: True if sleep bit is available.

isDtcInfoAvailable boolean isDtcInfoAvailable()

Checks if the dtc information is available. Returns: True if dtc information is available.

getDtcInfo IDiagResultValue getDtcInfo()

Returns the ODX information for the dtc bit (0x2A28).

Returns: Value of the dtc bit.

isProtocolInformationAvailable boolean isProtocolInformationAvailable()

Checks if the protocol information is available. Returns: True if protocol information is available.

getProtocolInformation List getProtocolInformation()

Returns the ODX information for the protocol entry (0x2A29). Returns: Value of the protocol information.

isTPIdentifierAvailable boolean isTPIdentifierAvailable()

Returns if the tp identifier is available. Returns: If the tp identifier is available.

getTPIdentifier IDiagResultValue getTPIdentifier()

Returns the ODX information for the TP-CAN-Identifier (0x2A2C). Returns: Value of the TP identifier.

isBusIdentifierAvailable boolean isBusIdentifierAvailable()

Returns if the bus identifier is available. Returns: If the bus identifier is available.

getBusIdentifier IDiagResultValue getBusIdentifier()

Returns the ODX information for the bus identifier (0x2A2D). Returns: Value of the bus identifier.

getEntryType IDiagResultComponentListEntry.EntryType getEntryType()

Gets type of the entry. Returns: Type of the entry.

Enum IDiagResultComponentListEntry.EntryType Enum Constant Summary BUSMASTER_COMPONENT_ENTRY

178

Busmaster entry.

SOFTWARE_CLUSTER_ENTRY

178

Software cluster entry.

SUBSYSTEM_COMPONENT_ENTRY Subsystem entry.

178

Interface IDiagResultConnectEcu de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultConnectEcu

Result object for connection data of a control unit.

Method Summary String

getActiveEcuVariant() Returns the detected odx variant of this control unit.

IConnectionHandle

getConnectionHandle() Returns handle for following control unit dependent calls.

IDiagResultConnectEcu.DiagnosticProtocol

getDiagnosticProtocol() Returns the used protocol.

String

getEcuId() Returns diagnostic address of the connected control unit as a hexadecimal string.

String

getEcuName() Retuns the translated control unit name of the connect ecu.

String

getLogicalLinkname() Retuns the logical linkname of the connect ecu.

Method Detail getConnectionHandle IConnectionHandle getConnectionHandle()

Returns handle for following control unit dependent calls. Returns: Handle for following control unit dependent calls.

1 8 0 1 7 9 1 8 1 1 8 0 1 8 0 1 8 0

getEcuName String getEcuName()

Retuns the translated control unit name of the connect ecu. Returns: Name of the control unit.

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: The address of the control unit.

getActiveEcuVariant String getActiveEcuVariant()

Returns the detected odx variant of this control unit. Returns: The detected variant.

getLogicalLinkname String getLogicalLinkname()

Retuns the logical linkname of the connect ecu. Returns: Logical linkname of the control unit.

getDiagnosticProtocol IDiagResultConnectEcu.DiagnosticProtocol getDiagnosticProtocol()

Returns the used protocol. Returns: The used protocol.

Enum IDiagResultConnectEcu.DiagnosticProtocol Enum Constant Summary KWP1281

182

KWP1281.

KWP2000

182

KWP2000.

UDS

182 UDS.

UNKNOWN Unknown.

182

Interface IDiagResultDatasetDownload de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

public interface IDiagResultDatasetDownload extends IDiagResult

Represents the result of the container verification and the dataset download.

Method Summary long getEcuAddress() Delivers the address of the control unit. String

getErrorID() Delivers the error-id of the occurred error.

String

getErrorMessage() Delivers the translated message of the occurred error.

String

getLogicalLinkname() Delivers the logical linkname of the control unit.

boolean

isErrorOccured() Checks for an occured error.

Method Detail getEcuAddress long getEcuAddress()

Delivers the address of the control unit.

Returns: The address.

1 8 3 1 8 4 1 8 4 1 8 4 1 8 4

getLogicalLinkname String getLogicalLinkname()

Delivers the logical linkname of the control unit. Returns: The address.

getErrorMessage String getErrorMessage()

Delivers the translated message of the occurred error. Returns: The error message or an empty string.

getErrorID String getErrorID()

Delivers the error-id of the occurred error. 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 Returns: The error id or an empty string.

isErrorOccured boolean isErrorOccured()

Checks for an occured error. Returns: true if an error occured, otherwise false

Interface IDiagResultDtcSnapshot de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

public interface IDiagResultDtcSnapshot extends IDiagResult

Represents the result of an event memory snapshot record.

Method Summary int

getDtcValue() Returns the dtc value of this snapshot record.

int

getEcuId() Returns the id of the control unit from which the event memory was read.

String

getEcuName() Returns the name of the control unit from which the event memory was read.

String

getErrorMessage() Returns a message of the error occured while reading the snapshot records using readEventMemorySnapshots.

String

getLogicalLinkname() Returns the logical linkname of the control unit from which the event memory was read.

int

getSnapshotRecordNumber() Returns the number of this snapshot record.

List

getSnapshotValues() Returns the (measurement) values of this snapshot record.

1 8 8 1 8 7 1 8 7 1 8 7 1 8 7 1 8 8 1 8 8

Method Detail getEcuId int getEcuId()

Returns the id of the control unit from which the event memory was read. Returns: The ecu id.

getEcuName String getEcuName()

Returns the name of the control unit from which the event memory was read. Returns: The ecu name.

getLogicalLinkname String getLogicalLinkname()

Returns the logical linkname of the control unit from which the event memory was read. Returns: Logical linkname of the control unit.

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: The error message or an empty string.

getSnapshotValues List getSnapshotValues()

Returns the (measurement) values of this snapshot record. Returns: the (measurement) values of this snapshot record.

getDtcValue int getDtcValue()

Returns the dtc value of this snapshot record. Returns: the dtc value of this snapshot record.

getSnapshotRecordNumber int getSnapshotRecordNumber()

Returns the number of this snapshot record. Returns: the number of this snapshot record.

Interface IDiagResultDtcSnapshotList de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

public interface IDiagResultDtcSnapshotList extends IDiagResult

DTC snapshot record list.

Method Summary List

getDtcSnapshotRecords() Returns the list of snapshot records.

Method Detail getDtcSnapshotRecords List getDtcSnapshotRecords()

Returns the list of snapshot records. Returns: The list of snapshot records.

1 8 9

Interface IDiagResultDtcState de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultDtcState

DTC state bit information.

Method Summary int getBitPosition() Return the position of the bit beginning with 0. String

getBitPositionText() Return the position as String which is displayed in the GUI.

String

getBitValueText() Return the value as String which is displayed in the GUI.

boolean

isBitSet() Return the value as boolean.

Method Detail getBitPosition int getBitPosition()

Return the position of the bit beginning with 0. Returns: The position of the bit beginning with 0.

getBitPositionText String getBitPositionText()

Return the position as String which is displayed in the GUI. Returns: The position as String which is displayed in the GUI.

1 9 0 1 9 0 1 9 1 1 9 1

isBitSet boolean isBitSet()

Return the value as boolean. Returns: The value as boolean.

getBitValueText String getBitValueText()

Return the value as String which is displayed in the GUI. Returns: The value as String which is displayed in the GUI.

Interface IDiagResultEnvironmentData de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultEnvironmentData

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

getMeasurements() Returns the list of measurement value conditions.

List

getSnapshotRecords() Returns the list of snapshot records.

List

getStandardData() Returns the list of standard environment conditions.

Method Detail getStandardData List getStandardData()

Returns the list of standard environment conditions. Returns: The list of environment conditions.

getMeasurements List getMeasurements()

Returns the list of measurement value conditions. Returns: The list of environment conditions.

1 9 2 1 9 3 1 9 2

getSnapshotRecords List getSnapshotRecords()

Returns the list of snapshot records. Returns: The list of snapshot records.

Interface IDiagResultEventInfo de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResultValue

public interface IDiagResultEventInfo extends IDiagResultValue

Implementation for detailed information on an event memory entry. Holds information on the type of the event memory.

Method Summary IDiagResultEventInfo.EventInfoType

getEventInfoType() Retrurns the type of this event info.

Method Detail getEventInfoType IDiagResultEventInfo.EventInfoType getEventInfoType()

Retrurns the type of this event info. Returns: The type of this event info.

1 9 4

Enum IDiagResultEventInfo.EventInfoType Enum Constant Summary ERROR_CODE

195

ERROR_CODE.

ERROR_TYPE_1

195

ERROR_TYPE1.

ERROR_TYPE_2

195

ERROR_TYPE2.

PCODE PCODE.

195

Interface IDiagResultEventMemory de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

public interface IDiagResultEventMemory 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

String

getEcuId()

1 9 Returns the id of the control unit from which the event memory was read. 6 getEcuName() 1 Returns the name of the control unit from which the event memory was read.

String

List

getErrorMessage()

1 9 Returns a message of the error occured while reading the event memory 7 using readAllEventMemories. getEventMemoryEntries() Returns the list of event memory entries from the ecu.

String

9 7

getLogicalLinkname() Returns the logical linkname of the control unit from which the event memory was read.

Method Detail getEcuId int getEcuId()

Returns the id of the control unit from which the event memory was read.

1 9 7 1 9 7

Returns: The ecu id.

getEcuName String getEcuName()

Returns the name of the control unit from which the event memory was read. Returns: The ecu name.

getLogicalLinkname String getLogicalLinkname()

Returns the logical linkname of the control unit from which the event memory was read. Returns: Logical linkname of the control unit.

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: The error message or an empty string.

getEventMemoryEntries List 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: The list of event memory entries.

Interface IDiagResultEventMemoryEntry de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultEventMemoryEntry

Represents a single event memory entry of a control unit. Since: 26-Mrz-2010 12:51:13

Method Summary String

getDevMemorySelection() The memory selection for a developer DTC.

List

getDtcStates() Returns the interpreted state record byte.

IDiagResultEnvironmentData

getEnvironmentData() Returns the environment conditions of this event memory entry.

List

long

1 9 9 2 0 0

getEventInfos()

2 0 Returns a list of detailed information about the event memory entry, for example 0 the event code and the event text. getUdsState() The uds-specific dtc-state.

boolean

2 0 1

isDevDTCEntry() The flag 'developer DTC'.

Method Detail getDtcStates List 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: The state record list.

2 0 0 2 0 0

getEnvironmentData IDiagResultEnvironmentData getEnvironmentData()

Returns the environment conditions of this event memory entry. Returns: The environment conditions.

getEventInfos List getEventInfos()

Returns a list of detailed information about the event memory entry, for example the event code and the event text. Returns: The list of event memory information.

getUdsState long getUdsState()

The uds-specific dtc-state. Returns: The udsState.

isDevDTCEntry boolean isDevDTCEntry()

The flag 'developer DTC'. 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

public interface IDiagResultFlashProgramming extends IDiagResult

Represents the result of a "flash" operation.

Method Summary List

getSessionResultList() Delivers the result list of all flashed sessions.

Method Detail getSessionResultList List getSessionResultList()

Delivers the result list of all flashed sessions. Returns: the result list of all flashed sessions.

2 0 2

Interface IDiagResultFlashSession de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

public interface IDiagResultFlashSession extends IDiagResult

Represents the result of a flash session.

Method Summary String

getContainerPath() Delivers the file path of the flash container.

long

getContainerSize() Delivers the file size of the flash container (bytes).

long

getDuration() Delivers the duration of the running flash process (seconds).

int

getEcuId() Delivers the ecu-id (address) of the flashed control unit.

String

getErrorMessage() Delivers the error message or an empty string.

List

getNotCompliedPreConditions() Delivers the not complied preconditions of a kwp flash process.

String

getSessionName() Delivers the session name.

boolean

isErrorOccurred() Delivers the result of the flash process.

2 0 4 2 0 5 2 0 5 2 0 4 2 0 5 2 0 4 2 0 4 2 0 5

Method Detail getEcuId int getEcuId()

Delivers the ecu-id (address) of the flashed control unit. Returns: the ecu-id (address) of the flashed control unit.

getContainerPath String getContainerPath()

Delivers the file path of the flash container. Returns: the file path of the flash container.

getSessionName String getSessionName()

Delivers the session name. Returns: the session name.

getNotCompliedPreConditions List getNotCompliedPreConditions()

Delivers the not complied preconditions of a kwp flash process. Returns: the text identifiers of not complied preconditions

getErrorMessage String getErrorMessage()

Delivers the error message or an empty string. Returns: the error message or an empty string.

isErrorOccurred boolean isErrorOccurred()

Delivers the result of the flash process. Returns: true, if an error has occurred during the execution

getDuration long getDuration()

Delivers the duration of the running flash process (seconds). Returns: the duration of the running flash process (seconds).

getContainerSize long getContainerSize()

Delivers the file size of the flash container (bytes). Returns: the file size of the flash container (bytes).

Interface IDiagResultIdentification de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultIdentification

Result object for the identification data.

Method Summary Long

getEcuAddress() Returns diagnostic address of the currently control unit.

String

getErrorMessage()

List

getExtendedData()

2 0 Returns a message of the error occured while reading the event memory using readMultilinkIdentification. 8

Returns a list of extended identification data. IDiagResultIdentification.IdentificationDataType

getIdentificationDataType() Returns type of identification data.

String

getLogicalLinkname() Retuns the logical linkname of the currently control unit.

List

getSoftwareComponentData() Returns a list of software component identification data.

List

getStandardData() Returns the standard identification data read from the system.

String

getSystemName() The system name of the control unit.

Method Detail getSystemName String getSystemName()

2 0 7

2 0 8 2 0 7 2 0 7 2 0 8 2 0 7 2 0 6

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: The (sub)system name.

getIdentificationDataType IDiagResultIdentification.IdentificationDataType getIdentificationDataType()

Returns type of identification data. Returns: The type of identification data.

getEcuAddress Long getEcuAddress()

Returns diagnostic address of the currently control unit. Returns: The address of the control unit.

getLogicalLinkname String getLogicalLinkname()

Retuns the logical linkname of the currently control unit. Returns: Logical linkname of the control unit.

getStandardData List getStandardData()

Returns the standard identification data read from the system.

Returns: List of identification data.

getExtendedData List getExtendedData()

Returns a list of extended identification data. Returns: List of extended identification data.

getSoftwareComponentData List getSoftwareComponentData()

Returns a list of software component identification data. Returns: List of software component identification data.

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: The error message or an empty string.

Enum IDiagResultIdentification.IdentificationDataType Enum Constant Summary MASTER

209

Master.

SLAVE

209

Slave.

SW_CLUSTER

209

Cluster.

SW_COMPONENT

209

Software component.

SW_COMPOSITION

209

Software composition.

UNKNOWN Not defined.

209

Interface IDiagResultIdentificationShortName de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultIdentificationShortName

Container for shortname ident type combination.

Method Summary IDiagResultIdentification.IdentificationDataType

String

getIdentificationDataType()

2 1 0

getShortName()

2 1 0

Method Detail getIdentificationDataType IDiagResultIdentification.IdentificationDataType getIdentificationDataType()

Returns: Type of identification data.

getShortName String getShortName()

Returns: Short name.

Interface IDiagResultMeasurement de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult, IDiagResultTable

public interface IDiagResultMeasurement extends IDiagResultTable

Interface for handling measurements.

Method Summary long getEcuAddress() Retrieves the address of the control unit for which this result holds the values. String

getErrorMessage() Returns a message of the error occured while reading the measurement using readMultilinkMeasurement.

String

getLogicalLinkname() Retrieves the logical linkname of the control unit for which this result holds the values.

String

getMeasurementGroup() Retrieves the measurement group for which this result holds the values.

List

String

2 1 1 2 1 3 2 1 2 2 1 2

getMeasurements()

2 1 2

getRecordDataIdentifier()

2 1 2

Returns the record data identifier of the executed service.

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: The measurement group.

getMeasurements List 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: the record data identifier.

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: The error message or an empty string.

Interface IDiagResultMemoryCells de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

public interface IDiagResultMemoryCells extends IDiagResult

Result object to return the read memory.

Method Summary byte[] getMemoryCells() Returns the list of memory cells.

Method Detail getMemoryCells byte[] getMemoryCells()

Returns the list of memory cells. Returns: The read memory.

2 1 4

Interface IDiagResultMulti de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

public interface IDiagResultMulti extends IDiagResult

Standard result object for a multilink diagnostic call.

Method Summary Long getEcuAddress()

2 1 6

String

getErrorMessage()

2 1 6

String

getFunctionName()

2 1 6

String

getLogicalLinkname()

2 1 5

getTimestamp()

2 1 6

Long

Method Detail getLogicalLinkname String getLogicalLinkname()

Returns: The logical linkname of the corresponding control unit.

getEcuAddress Long getEcuAddress()

Returns: The ecu address of the corresponding control unit.

getErrorMessage String getErrorMessage()

Returns: The error message or an empty string.

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: The execution timestamp.

Interface IDiagResultNegativeResponse de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultNegativeResponse

Result interface to handle negative responses from an ecu.

Method Summary int getNRC()

int

String

boolean

2 1 7

getSID()

2 1 7

getTranslatedMessage()

2 1 8

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: True if the ecu has returned a negative response, otherwise false.

Interface IDiagResultODXVersion de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultODXVersion

Interface for returning the result of ODX version operation.

Method Summary String getDate() Date of the last change in ISO-8601 format or yyyy-MM-dd'T'HH:mm:ss. String

getErrorFlag() Returns error code of a project entry.

String

getName() Returns name of the ODX project / name of directory.

String

getRevision() Returns revision number of ODX file.

String

getState() Returns state of get ODX version operation.

Method Detail getName String getName()

Returns name of the ODX project / name of directory. Returns: Name of the ODX project.

getDate String getDate()

2 1 9 2 2 0 2 1 9 2 2 0 2 2 0

Date of the last change in ISO-8601 format or yyyy-MM-dd'T'HH:mm:ss. Example: 2010-0118T12:38:23.000+01:00 Returns: Date of the last change in ISO-8601 format.

getRevision String getRevision()

Returns revision number of ODX file. Returns: Revision number of ODX file.

getState String getState()

Returns state of get ODX version operation. E.g. RELEASE Returns: State of get ODX version operation.

getErrorFlag String getErrorFlag()

Returns error code of a project entry. The following values are possible:



OK: Valid project



INDEX_XML_MISSING: Project directory does not contain index file



INVALID_INDEX_XML: Project directory contains invalid index file

Returns: String value of ErrorFlag

Enum IDiagResultODXVersion.ErrorFlag Enum Constant Summary INDEX_XML_MISSING

221

File index.xml is missing for the project.

INVALID_INDEX_XML

221

Error within index.xml for a project.

OK

221 Everything ok.

Interface IDiagResultParameterValue de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultParameterValue

Represents the result of a parameter value.

Method Summary String getTranslation() Delivers the translated text of the parameter value. String

getValue() Delivers the value of the object as string.

String

getValueId() Delivers the value as a translatable text id.

Method Detail getValue String getValue()

Delivers the value of the object as string. Returns: The value.

getValueId String getValueId()

Delivers the value as a translatable text id. Returns: The text id of the parameter value.

2 2 3 2 2 2 2 2 2

getTranslation String getTranslation()

Delivers the translated text of the parameter value. Returns: The translated text of the parameter value.

Interface IDiagResultPreCondition de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultPreCondition

Represents the result of a precondition.

Method Summary String getTextID() Delivers the text-id of the precondition. String

getTranslatedText() Delivers the translated text of the precondition.

int

getValue() Delivers the value of the precondition.

Method Detail getValue int getValue()

Delivers the value of the precondition. Returns: the value of the precondition.

getTranslatedText String getTranslatedText()

Delivers the translated text of the precondition. Returns: the translated text of the precondition.

2 2 5 2 2 4 2 2 4

getTextID String getTextID()

Delivers the text-id of the precondition. Returns: the text-id of the precondition.

Interface IDiagResultProtocolTransfer de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultProtocolTransfer

Result of protocol transfer to VDS and Service 42.

Method Summary List

getProtocolTransferEntries()

Method Detail getProtocolTransferEntries List getProtocolTransferEntries()

Returns: List of results of protocol transfer TotalSystemsInterfaceImpl.sendProtocolsToCarport(List, String)

2 2 6

Interface IDiagResultProtocolTransferEntry de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultProtocolTransferEntry

Item of IDiagResultProtocolTransfer.

Method Summary String

getMessage()

2 2 8

String

getProtocolName()

2 2 7

getResultState()

2 2 7

IDiagResultProtocolTransferEntry.TransferResultState

Method Detail getProtocolName String getProtocolName()

Returns: Associated protocol name of send request.

getResultState IDiagResultProtocolTransferEntry.TransferResultState getResultState()

Returns: Result state of the protocol transfer.

getMessage String getMessage()

Returns: Message of the protocol transfer.

Enum IDiagResultProtocolTransferEntry.TransferResultState Enum Constant Summary ERROR

229

Error.

SUCCESS

229

Success.

UNKNOWN

229

Unknown.

WARNING Warning.

229

Interface IDiagResultRawService de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultRawService

Represents the result of a functional raw service operation.

Method Summary List

getRawServiceResponses() Returns the list of ecu responses.

Method Detail getRawServiceResponses List getRawServiceResponses()

Returns the list of ecu responses. Returns: The list of ecu responses.

2 3 0

Interface IDiagResultRawServiceResponse de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultRawServiceResponse

Represents a single ecu response of a functional raw service operation.

Method Summary byte[] getResponsePDU() Returns the response of the ecu. String

getVariantName() Returns the variant name of the responding ecu.

Method Detail getResponsePDU byte[] getResponsePDU()

Returns the response of the ecu. Returns: The response of the ecu.

getVariantName String getVariantName()

Returns the variant name of the responding ecu. Returns: The variant name of the responding ecu.

2 3 1 2 3 1

Interface IDiagResultRollModeEntry de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultRollModeEntry

Represents a single roll mode entry; i.e. the roll mode information on a single ecu.

Method Summary String

getAdditionalText() Text holding aditional information.

int

getEcuId() Return the diagnostic address of this entry's ecu.

String

getEcuName() Return the translated name of this entry's ecu.

IDiagResultRollModeEntry.RollModeState

getState() Return this entry's roll mode state.

long

getTimestamp() Retrieves the date / time of this entry's latest modification.

boolean

isAdditionalTextError() Checks if the additional normal" info.

boolean

text describes an error or just

isNRCSignaled() Returns if this entry's ECU has responded with an NRC lately.

Method Detail getEcuId int getEcuId()

Return the diagnostic address of this entry's ecu.

2 3 3 2 3 2 2 3 3 2 3 3 2 3 4 2 3 3 2 3 4

Returns: The ecu address.

getEcuName String getEcuName()

Return the translated name of this entry's ecu. Returns: The ecu name.

getState IDiagResultRollModeEntry.RollModeState getState()

Return this entry's roll mode state. Returns: The state.

getAdditionalText String getAdditionalText()

Text holding aditional information. Returns: The info text.

isAdditionalTextError boolean isAdditionalTextError()

Checks if the additional text describes an error or just normal" info. Returns: true if the additional text} describes an error, else false.

isNRCSignaled boolean isNRCSignaled()

Returns if this entry's ECU has responded with an NRC lately. Returns: true if NRC was answered, else false.

getTimestamp long getTimestamp()

Retrieves the date / time of this entry's latest modification. 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 Rollmode is UNKNOWN; e.g. has not been tried to detect.

235

Interface IDiagResultSFD de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

All Known Subinterfaces: IDiagResultSFDStatus

public interface IDiagResultSFD extends IDiagResult

Represents the result of a sfd execution.

Method Summary long getEcuAddress() Delivers the address of the control unit. String

getErrorID() Delivers the error-id of the occurred error.

String

getErrorMessage() Delivers the translated message of the occurred error.

String

getLogicalLinkname() Delivers the logical linkname of the control unit.

boolean

isError() Checks for an occured error.

boolean

isNrc() Checks for a negative response (NRC).

Method Detail getEcuAddress long getEcuAddress()

2 3 6 2 3 7 2 3 7 2 3 7 2 3 8 2 3 8

Delivers the address of the control unit. Returns: The address.

getLogicalLinkname String getLogicalLinkname()

Delivers the logical linkname of the control unit. Returns: The address.

getErrorMessage String getErrorMessage()

Delivers the translated message of the occurred error. Returns: The error message or an empty string.

getErrorID String getErrorID()

Delivers the error-id of the occurred error. Potential Error-IDs: - ODS1003E: no backend connection - ODS1007E: negative server response - ODS2003E: unsupported access method - ODS6912E: no functional response - ODS6913E: incorrect sfd Result - ODS6914E: incorrect sfd role - ODS6915E: incorrect sfd unlock - ODS6916E: incorrect sfd reset - ODS6917E: no sfd offline token found - ODS6918E: token name contains no timestamp - ODS6924E: invalid sfd replay protection

Returns: The error id or an empty string.

isError boolean isError()

Checks for an occured error. Returns: true if an error occured, otherwise false.

isNrc boolean isNrc()

Checks for a negative response (NRC). Returns: true if the ecu has returned a negative response, otherwise false.

Interface IDiagResultSFDStatus de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult, IDiagResultSFD

public interface IDiagResultSFDStatus extends IDiagResultSFD

Represents the unlock information of a control unit (SFD).

Method Summary IDiagResultParameterValue

getDuration() Delivers the duration of sfd protection.

IDiagResultParameterValue

getRole() Delivers the role for sfd protection.

IDiagResultParameterValue

getStatus() Delivers the status of sfd protection.

IDiagResultParameterValue

getType() Delivers the type of sfd protection.

Method Detail getRole IDiagResultParameterValue getRole()

Delivers the role for sfd protection. Returns: the role for protection.

2 4 0 2 3 9 2 4 0 2 4 0

getType IDiagResultParameterValue getType()

Delivers the type of sfd protection. Returns: the type of protection.

getStatus IDiagResultParameterValue getStatus()

Delivers the status of sfd protection. Returns: the status of protection.

getDuration IDiagResultParameterValue getDuration()

Delivers the duration of sfd protection. Returns: the duration of protection.

Interface IDiagResultSoftwareCompositionComponentList de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultSoftwareCompositionComponentList

Software component list.

Method Summary List

getComponentListEntries() Returns the list component entries.

Long

getEcuAddress() Returns diagnostic address of the currently control unit.

String

getErrorMessage() Returns a message of the occured error while reading the software composition component list.

String

getLogicalLinkname() Retuns the logical linkname of the currently control unit.

Method Detail getComponentListEntries List getComponentListEntries()

Returns the list component entries. Returns: The list of component entries.

getEcuAddress Long getEcuAddress()

Returns diagnostic address of the currently control unit.

2 4 1 2 4 1 2 4 2 2 4 2

Returns: The address of the control unit.

getLogicalLinkname String getLogicalLinkname()

Retuns the logical linkname of the currently control unit. Returns: Logical linkname of the control unit.

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: The error message or an empty string.

Interface IDiagResultSoftwareCompositionComponentListEntry de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultSoftwareCompositionComponentListEntry

Software component list entry.

Method Summary List getComponentSystemNames() Returns list of software components with its system name. String

getListNumber() Returns the list number which is the key of the entry.

int

getListPosition() Returns the list position in the software composition list.

long

getNodeId() Returns the node address of this entry.

String

getSystemeName() Returns the system name of this entry.

boolean

isCoded() Returns coded state.

Method Detail getListNumber String getListNumber()

Returns the list number which is the key of the entry. Returns: The list number.

2 4 4 2 4 3 2 4 4 2 4 4 2 4 4 2 4 4

getListPosition int getListPosition()

Returns the list position in the software composition list. Returns: The list position.

getNodeId long getNodeId()

Returns the node address of this entry. Returns: The node address.

getSystemeName String getSystemeName()

Returns the system name of this entry. Returns: The system name.

isCoded boolean isCoded()

Returns coded state. Returns: True if the entry is coded otherwise false.

getComponentSystemNames List getComponentSystemNames()

Returns list of software components with its system name. Returns: List of software components with its system name.

Interface IDiagResultSpecialCoding de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

public interface IDiagResultSpecialCoding extends IDiagResult

Represents the result of a "read special coding" operation.

Method Summary IDiagResultValue getParameter(IDiagResultSpecialCoding.Parameter Type parameterType) Retrieves the current value for the specified parameterType.

Method Detail getParameter IDiagResultValue getParameter(IDiagResultSpecialCoding.ParameterType parameterType)

Retrieves the current value for the specified parameterType. Parameters: parameterType - - The type of the desired value.

Returns: The current value for the specified type.

2 4 6

Enum IDiagResultSpecialCoding.ParameterType Enum Constant Summary BRAND

247

Part "brand" of special coding.

DERIVATE

247

Part "derivate" of special coding.

DOORS

247

Part "doors" of special coding.

WHEEL Part "wheel" of special coding.

247

Interface IDiagResultStandardEnvironmentCondition de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResultValue

public interface IDiagResultStandardEnvironmentCondition extends IDiagResultValue

Represents the standard environment condition data of an event memory entry.

Method Summary IDiagResultStandardEnvironmentCondition.StandardEnvironmentC onditionType

getStandardEnvironmentConditionTy 2 pe() 4 Returns the type ("meaning") of this standard 8 environment condition.

Method Detail getStandardEnvironmentConditionType IDiagResultStandardEnvironmentCondition.StandardEnvironmentConditionType getStandardEnvironmen tConditionType()

Returns the type ("meaning") of this standard environment condition. Returns: The type ("meaning") of this standard environment condition.

Enum IDiagResultStandardEnvironmentCondition.StandardEnvironment ConditionType Enum Constant Summary DATE

249

date.

ERROR_COUNTER

249

error counter.

LIFECYCLE_COUNTER

249

lifecycle counter.

MILEAGE

249

mileage.

PRIORITY

249

priority.

STATE

249

state.

UNKNOWN

249

Actually no "meaning" known...

UNLEARN_COUNTER unlearn counter.

249

Interface IDiagResultStatus de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult, IDiagResultTable

public interface IDiagResultStatus extends IDiagResultTable

Interface for returning the result of a check operation.

Method Summary IDiagResultValue

IDiagResultStatus.EKWPResultState

getDiagResultStatus()

2 5 Returns the status from the actuator diagnostic or basic setting as DiagResultValue to distinguish between translated or shortname status. 1 getKwpResultState() Returns the status from the actuator diagnostic or basic setting.

List

getMeasuredValues() Returns a list of measured values read during the operation.

String

getName() Returns the name of the executed basic setting or actuator diagnosis.

String

getRecordDataIdentifier() Returns the record data identifier of the executed service.

String

getStatus() Returns the status from the actuator diagnostic or basic setting.

Method Detail getName String getName()

2 5 2 2 5 1 2 5 0 2 5 2 2 5 1

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: The name of the actuator or basic setting group.

getStatus String getStatus()

Returns the status from the actuator diagnostic or basic setting. Returns: The status message.

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: The status information.

getMeasuredValues List getMeasuredValues()

Returns a list of measured values read during the operation. Returns: List of measured value.

getRecordDataIdentifier String getRecordDataIdentifier()

Returns the record data identifier of the executed service. Returns an empty string if no record data identifier is available. Returns: the record data identifier.

getKwpResultState IDiagResultStatus.EKWPResultState getKwpResultState()

Returns the status from the actuator diagnostic or basic setting. Returns: The origin status message.

Enum IDiagResultStatus.EKWPResultState Enum Constant Summary ACTUATOR_ABORT

253

Actuator diagnosis was aborted.

ACTUATOR_FINISHED

253

Actuator diagnosis was finished by ecu.

ACTUATOR_NOT_RUNNING

253

ONLY for KWP 2000 possible: actuator diagnosis is not running.

ACTUATOR_RUNNING

253

Actuator diagnosis is running.

ACTUATOR_RUNNING_NOT_ABORTABLE

253

ONLY for KWP 2000 relevant possible: actuator diagnosis is running, can not be aborted.

ACTUATOR_RUNNING_WITHOUT_CODE

253

ONLY for kwp1281: actuator diagnosis is running but the actuator code is not relevant as response.

ACTUATOR_UNDEFINED

253

ACTUATOR Unknown.

BASICSETTINGS_ABORTED

253

Routine is aborted - safety reason.

BASICSETTINGS_FINISHED

253

Routine is finished correctly.

BASICSETTINGS_OFF

253

Routine is not running.

BASICSETTINGS_ON

253

Routine is running.

BASICSETTINGS_SWITCH

253

Ecu is switched in eg. basic settings.

BASICSETTINGS_TIMEOUT

253

Routine is finished - timeout detected.

BASICSETTINGS_UNDEFINED

253

State of routine is unknown.

UDS

253 Only use for UDS.

UNKNOWN Unknown.

253

Interface IDiagResultTable de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Superinterfaces: IDiagResult

All Known Subinterfaces: IDiagResultAdaptation, IDiagResultMeasurement, IDiagResultStatus

public interface IDiagResultTable extends IDiagResult

Interface for handling table data.

Method Summary String getTableKey()

String

getTableKeyText()

Method Detail getTableKey String getTableKey()

Returns: ODX table key.

getTableKeyText String getTableKeyText()

Returns: The text for the key.

2 5 5 2 5 5

Interface IDiagResultValue de.volkswagen.odis.vaudas.vehiclefunction.automation.types

All Known Subinterfaces: IDiagResultEventInfo, IDiagResultStandardEnvironmentCondition

public interface IDiagResultValue

Represents a value returned by a diagnostic function.

Method Summary List

getChildren() Returns the list of child result values for this result.

String

getName() Returns the ODX name of this value.

IDiagResultValue

getParent() Returns the parent result object of this result.

IDiagResultValue.RangeInfo

getRangeInfo() Returns the range info of this result

String

getRangeInfo().

getRecordDataIdentifier() Returns the record data identifier of the executed service.

String

getTranslatedName() Returns the translated name of this value.

String

getTranslatedValue() Returns the value in its textual representation for this result.

IDiagResultValue.ValueType

getType() Returns the type of this result's value.

String

getUnit() Returns the unit of this value.

2 5 9 2 5 7 2 5 9 2 5 8 2 5 9 2 5 7 2 5 8 2 5 8 2 5 7

String

getValue() Returns the value in its textual representation for this result.

boolean

isValid() Returns if the information is valid and can be used.

Method Detail getName String getName()

Returns the ODX name of this value. Returns an empty string if no name is available. Returns: The name of this value.

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: The translated name

getUnit String getUnit()

Returns the unit of this value. If no unit is available an empty string will return. Returns: The unit of this value.

getValue String getValue()

2 5 7 2 5 8

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: The value of this result.

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: The value of this result.

getRangeInfo IDiagResultValue.RangeInfo getRangeInfo()

Returns the range info of this result getRangeInfo(). Returns: The range info.

getType IDiagResultValue.ValueType getType()

Returns the type of this result's value. Returns: The type.

isValid boolean isValid()

Returns if the information is valid and can be used. Returns: If the information is valid and can be used.

getChildren List getChildren()

Returns the list of child result values for this result. Returns an empty list if this result object has no children. Returns: The list of child result values.

getParent IDiagResultValue getParent()

Returns the parent result object of this result. Returns null if this result has no parent. Returns: The parent result object or null.

getRecordDataIdentifier String getRecordDataIdentifier()

Returns the record data identifier of the executed service. Returns an empty string if no record data identifier is available. Returns: the record data identifier.

Enum IDiagResultValue.RangeInfo Enum Constant Summary NO_RANGE_INFO

260

no range info.

NOT_AVAILABLE

260

not available.

NOT_CODABLE

260

not codable.

NOT_DEFINED

260

not defined.

NOT_INITIALIZED

260

not initialzed.

NOT_VALID

260

invalid.

UNKNOWN

260

unknown.

VALUE_VALID value valid.

260

Enum IDiagResultValue.ValueType Enum Constant Summary BYTEFIELD

261

byte field.

DATETIME

261

date and time.

FLOAT

261

float.

HEX

261 hexadecimal.

INT

261 integer.

STRING string.

261

Interface IDiagResultVersions de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagResultVersions

Versions of used modules.

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: ODIS product version.

getAutomationAPIVersion String getAutomationAPIVersion()

Returns: Version of automation interface.

getMCDServerVersion String getMCDServerVersion()

Returns: MCD server version.

getMCDServerAPIVersion String getMCDServerAPIVersion()

Returns: MCD server API version.

getPDUAPIVersion String getPDUAPIVersion()

Returns: PDU API version.

getPDUVersion String getPDUVersion()

Returns: PDU version.

getECFVersion String getECFVersion()

Returns: ECF version.

Interface IDiagSoftwareCompositionComponentListEntry de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDiagSoftwareCompositionComponentListEntry

Input parameter object for settting the coding state of a software composition.

Method Summary long getNodeId() Returns the node address of this entry. boolean

isNodeIdAvailable() Is the value for node id available and can be used..

void

setCoded(boolean

coded)

Sets the coded state for this entry.

Method Detail getNodeId long getNodeId()

Returns the node address of this entry. Returns: The node address.

isNodeIdAvailable boolean isNodeIdAvailable()

Is the value for node id available and can be used.. Returns: If the value for node is available and can be used.

2 6 5 2 6 5 2 6 6

setCoded void setCoded(boolean coded)

Sets the coded state for this entry. Parameters: coded - The coded state to set.

Interface IDoIPVCI de.volkswagen.odis.vaudas.vehiclefunction.automation.types

public interface IDoIPVCI

Represents a 'DoIP' VCI.

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

public interface IMacroEngine

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)

start execution of a macro. if no macro is running, the macro specified is loaded and started. IMacroEngine.EngineState

getEngineState() Returns the current engine state.

double

getInterval() returns the execution interval.

int

getLineNumber() gets the number of the currently executed line in the macro.

String

getMacrofile() returns the name of the macro file.

String

BlockingQueue

IMacroEngine.EngineState

getPythonError()

2 7 0 2 7 2 2 7 2 2 7 2 2 7 1

2 7 Delivers the python error string, or null, if no error was detected. 3 getStateQueue() 2 7 Delivers the blocking queue of engine states. 3 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)

sets the debug mode. void

setInterval(double

2 7 1

interval)

sets the execution interval. void

setMacroEngineListener(IMacroEngineListener

listener)

Sets the listener to be informed about changes of states, modes and data. void

triggerStep() triggers the execution of one macro statement.

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: macro - - Path of the macro to execute. debug - - Set true to debug the macro or false form execution without debuging.

Returns: resulting state of the macro engine

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.

2 7 2

2 7 0 2 7 1

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: the resulting engine state

triggerStep void triggerStep()

triggers the execution of one macro statement.

setInterval void setInterval(double interval)

sets the execution interval. Parameters: interval - the execution interval to set.

getMacrofile String getMacrofile()

returns the name of the macro file. Returns: the name of the macro file

setDebugMode void setDebugMode(IMacroEngine.DebugMode debugMode)

sets the debug mode. Parameters: debugMode - the debug mode to set.

getEngineState IMacroEngine.EngineState getEngineState()

Returns the current engine state. Returns: the current engine state.

getInterval double getInterval()

returns the execution interval. Returns: the execution interval.

getLineNumber int getLineNumber()

gets the number of the currently executed line in the macro. Returns: number of current line or zero, if not available

getStateQueue BlockingQueue getStateQueue()

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: a blocking queue which provides the state changes.

getPythonError String getPythonError()

Delivers the python error string, or null, if no error was detected. Returns: the error string.

Enum IMacroEngine.DebugMode Enum Constant Summary ANIMATE

274

Debugger is in animation mode.

SINGLE_STEP Debugger is in single step mode.

274

Enum IMacroEngine.EngineState Enum Constant Summary DEBUGGING

275

Engine is running in debug mode.

PAUSED

275

Engine is paused.

RUNNING

275

Engine is running in normal mode.

STOPPED

275

Engine is stopped (idle).

UNINITIALIZED Engine is uninitialized.

275

Class IMacroEngine.Factory de.volkswagen.odis.vaudas.vehiclefunction.automation.types

java.lang.Object de.volkswagen.odis.vaudas.vehiclefunction.automation.types.IMacroEngine.Factory

Enclosing class: IMacroEngine

public static class IMacroEngine.Factory extends Object

Factory class giving access to the singleton macro engine.

Constructor Summary Factory() Method Summary static getInstance() IMacroEngine Delivers the singleton macro engine.

Constructor Detail Factory public Factory()

Method Detail getInstance public static IMacroEngine getInstance()

Delivers the singleton macro engine. Returns: the instance

276

2 7 6