VW: ODIS¶

Legacy/internal identifier: ODIS

Vendor information

Vendor	Web page	Product name	Version
Volkswagen AG	https://volkswagen-net.de/wikis/display/ODISENG	Offboard Diagnostic Information System Engineering	from 7.1.3, tested up to 17.0.1

Operating system	Support
Windows	✓
Linux

Ports¶

Port DIAGNOSTICS_JOBS - DEFAULT 🛈

Properties 🛈¶

Name	Available if	Default value	Valid values	Type	Description
Port of ODIS web service		‘8081’		string
Project mode		‘SERVICE’	[‘SERVICE’, ‘ENGINEERING’]	string	Specifies whether ODIS is to use service mode or engineering mode for automatic project selection.
Load vehicle project at startup		☑		bool	Automatically load the vehicle project at the start of the configuration (Default = True).
Vehicle project	Load vehicle project at startup: ‘True’			string	Name of the vehicle project in ODIS
Path to web service configuration file ❲relative to the ODIS installation directory❳		‘configuration\webservice.ini’		string
Timeout for a response from ODIS		600		int	Maximum time in seconds to wait for a response from ODIS
Connection type	Load vehicle project at startup: ‘True’	CAN	[CAN, CANFD, DOIP]	string	CAN, CAN-FD or DoIP
DoIP address	Load vehicle project at startup: ‘True’ » Connection type: ‘DOIP’			string	IP address for the DoIP connection
DoIP VIN	Load vehicle project at startup: ‘True’ » Connection type: ‘DOIP’			string	VIN for the DoIP connection
Activate DoIP-ActivationLine	Load vehicle project at startup: ‘True’ » Connection type: ‘DOIP’	☐		bool	Activates the DoIP-ActivationLine if True.
Authentication method		NONE	[NONE, PKI, SoftPSE]	string	Authentication method: PKI card or SoftPSE certificate.
Name of the certificate	Authentication method: ‘SoftPSE’			string	Common name SoftPSE-Zertifikat
Technical user	Authentication method: ‘SoftPSE’			string	Technical user
User	Authentication method: ‘SoftPSE’			string	User
Timeout for tool call ❲in sec.❳		‘600’		string	Timeout after which a tool call is aborted.

Jobs 🛈¶

ActuatorDiagnosticsInit¶

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.

ODIS requires that the ECU connection has been established with ConnectToEcuAndOpenConnection.

Parameter

Name	Default value	Type	Description
actuators	[]	object	The actuators to initialize as python dict. structure: {shortName1: { parameters: {param1:value1, param2:value2, …}, measurements: [mParam1,mParam2]}, shortName2: …}
ecuAddress		int	ECU address as decimal or hexadecimal value (starting with 0x)
measurements		object	The measurements values in a list. Can be None.

Name

Available if

Default value

Valid values

Type

Description

actuators

[]

object

The actuators to initialize as python dict.

structure:

{shortName1: {

parameters: {param1:value1, param2:value2, …},

measurements: [mParam1,mParam2]},

shortName2: …}

ecuAddress

int

ECU address as decimal or hexadecimal value (starting with 0x)

measurements

object

The measurements values in a list. Can be None.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ActuatorDiagnosticsStart¶

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

Parameter

Name	Available if	Default value	Valid values	Type	Description
actuators				object	List of the actuator shortNames to start.
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	The status of the start operation.

ActuatorDiagnosticsStop¶

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

Parameter

Name	Available if	Default value	Valid values	Type	Description
actuators				object	List of the actuator shortNames to start.
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	The status of the stop operation.

BasicSetting2Init¶

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.

ODIS requires that the ECU connection has been established with ConnectToEcuAndOpenConnection.

Parameter

Name	Default value	Type	Description
basicSettings	{}	object	The basic setting to be initialized as a Python dict. structure: {shortName1: { parameters: {param1:value1, param2:value2, …}, measurements: [mParam1,mParam2]}, shortName2: …}
ecuAddress		int	ECU address as decimal or hexadecimal value (starting with 0x)
measurements	None	object	The measurements values in a list. Can be None.

Name

Available if

Default value

Valid values

Type

Description

basicSettings

{}

object

The basic setting to be initialized as a Python dict.

structure:

{shortName1: {

parameters: {param1:value1, param2:value2, …},

measurements: [mParam1,mParam2]},

shortName2: …}

ecuAddress

int

ECU address as decimal or hexadecimal value (starting with 0x)

measurements

None

object

The measurements values in a list. Can be None.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

BasicSettingCheck¶

Starts the basic setting check for the specified settings (UDS control units) or the settings configured in “basicSetting2Init” (KWP control units).

Parameter

Name	Available if	Default value	Valid values	Type	Description
basicSettings		[]		object	List with shortnames of the basic settings to be checked.
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	The status of the start operation.

BasicSettingStart¶

Starts the basic setting diagnostics for the specified settings. (UDS control units) or the settings configured in “basicSetting2Init” (KWP control units).

Parameter

Name	Available if	Default value	Valid values	Type	Description
basicSettings		[]		object	List with shortnames of the basic settings to be started.
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	The status of the start operation.

BasicSettingStop¶

Stops the basic setting diagnosis for the specified settings. (UDS control units) or the settings configured in “basicSetting2Init” (KWP control units).

Parameter

Name	Available if	Default value	Valid values	Type	Description
basicSettings		[]		object	List with shortnames of the basic settings to be started.
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	The status of the stop operation.

CheckFlashProgramming¶

Checks if the current control unit is in principle flashable.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool	Checks if the current control unit is in principle flashable. If the information is not available the methods returns True.

CheckFlashProgrammingWithFlashContainer¶

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

UDS: Check over expected idents (contains checks of part number and software version)

KWP: Check of part number and software version

Parameter

Name	Default value	Type	Description
containerFileName		string	Name of the container file with full path.
ecuAddress		int	ECU address as decimal or hexadecimal value (starting with 0x)
sessionName	‘None’	string	The session name to use for the update programming. The parameter can be ‘None’.

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool	True if the current control unit is flashable with the containerFileName content.

CheckVciState¶

Returns the current VCI state.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	Possible return values: ‘connected’, ‘not connected’ and ‘not available’

CloseConnection¶

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 diagnostic operation.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ConfigureSetting¶

Configures a setting of the VCI tester.

Parameter

Name	Available if	Default value	Valid values	Type	Description
paramKey				string	The key of the setting.
paramValue				string	The new value of the setting.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ConnectToEcu¶

Connects to the control unit with the defined address.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ConnectToEcuAndOpenConnection¶

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 diagnostic operation. To change this behavior call closeConnection. The behavior also changes calling connectToEcu and setVehicleProject.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

CreateProtocolVDSBZD¶

Creates VDS/BZD protocol.

Parameter

Name	Default value	Valid values	Type	Description
adaptationPresets	[]		object	Optional.
additionalPresets	[]		object	Optional.
identificationPresets	[]		object	Optional.
measurementPresets	[]		object	Optional.
measuringLocation			string	Optional.
measuringType			string	Optional.
mileage			string	Optional.
mileageUnit		[‘KM’, ‘MILES’]	string	Optional.
readEventMemory		[False, True]	bool	Read event memory before creating protocol.
userName			string	User name for login. If empty, the user currently logged in to the computer will be used.
vehicleNumber			string	Vehicle number.
vin			string	If empty, the current VIN will be used.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

DataSetDownload¶

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

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)
xmlFilePath				string	Absolute path to the xml or zip file including file name and suffix.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	General response. DiagException - If an error occurs while processing the request.

Name

Available if

Default value

Valid values

Type

Description

result

string

General response.

DiagException - If an error occurs while processing the request.

DisableTransportMode¶

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

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

DiscardProtocol¶

Discards protocol.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

EnableTransportMode¶

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 necessary as precondition.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ExecuteMacro¶

Executes a macro.

Parameter

Name	Available if	Default value	Valid values	Type	Description
macroName				string	The absolute path name of the macro.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

FlashProgramming¶

Flashing with an update container.

Parameter

Name	Default value	Valid values	Type	Description
checkSessionWithEcu	None	[False, True]	bool	Switch if check is activated for UDS on expected idents and for KWP on part number and software version. Maybe None, than default ‘True’ is used.
containerFileName			string	Name of the container file with full path.
ecuAddress			int	ECU address as decimal or hexadecimal value (starting with 0x)
sessionName	‘None’		string	The session name to use for the update programming. The parameter can be ‘None’.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream

GetFlashSessions¶

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

Parameter

Name	Default value	Valid values	Type	Description
checkSessionWithEcu	None	[False, True]	bool	Switch if check is activated for UDS on expected idents and for KWP on part number and software version. Maybe None, than default True is used.
containerFileName			string	Name of the container file with full path.
ecuAddress			int	ECU address as decimal or hexadecimal value (starting with 0x)

Name

Available if

Default value

Valid values

Type

Description

checkSessionWithEcu

None

[False, True]

bool

Switch if check is activated for UDS on expected idents and for KWP on part number and software version.

Maybe None, than default True is used.

containerFileName

string

Name of the container file with full path.

ecuAddress

int

ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

GetProjectEcuAddressList¶

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

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

GetSFDLinkNames¶

Returns all reachable control units that support the security access by token (SFD).

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	The list of all SFD control units

GetShortNamesOfAccessModes¶

Returns the ODX-ShortNames of all available access modes for UDS control units. The function throws an exception for KWP control units.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

GetShortNamesOfActuators¶

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.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	List of all actuator shortnames.

GetShortNamesOfAdaptationChannels¶

Returns the ODX short names of all available adaptation channels for UDS control units. For KWP control unit the function throws an exception.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

GetShortNamesOfAdaptationValues¶

Returns the ODX short names of all available adaptation values from an adaptation channel. For KWP control units the function throws an exception.

Parameter

Name	Available if	Default value	Valid values	Type	Description
adaptationChannel				int	The adaptation channel from which the adaptation values shall be retrieved.
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

GetShortNamesOfBasicSettings¶

Returns the ODX shortnames of all available basic settings of the selected ECU. For a KWP ECU this function throws an exception.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	List with shortnames of all basic settings.

GetShortNamesOfCodingValues¶

Reads the coding names from the active control unit.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	The result short names.

GetShortNamesOfDiagnosticSessions¶

Returns the ODX-ShortName list of all available diagnostic sessions for UDS control units. The function throws an exception for KWP control units.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

GetShortNamesOfIdentificationDatas¶

Returns the ODX short names of all identification values for the specified subsystem. For a KWP control unit this function throws an exception.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)
subsystem				string	Name of the subsystem for which the values will be returned. If the subsystem name is empty the short names of the master ecu will be returned. - String

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object

GetShortNamesOfMeasurementGroups¶

Returns the list of short names of all available measurement value groups of the chosen ECU. For KWP-ECU this function throws an exception.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	The measurement value groups

GetShortNamesOfMeasurements¶

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

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)
measurementGroup				string	The measurement group in order to get the available ODX short names for this group.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	The ODX short names of all available measurements of the specified measurement group

GetShortNamesOfMeasurementsForBasicSettings¶

Returns the ODX shortnames of all measured values for the basic setting. For a KWP controller this function throws an exception.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	List with the shortnames of all measured values of the basic settings.

GetShortNamesOfStartParametersForActuator¶

Returns the ODX short names of all available parameters from the specified actuator. For a KWP control unit this function throws an exception.

Parameter

Name	Available if	Default value	Valid values	Type	Description
actuatorName				int	The name of the actuator.
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	List of all actuator parameter shortNames.

GetShortNamesOfStartParametersForBasicSettings¶

Returns the ODX shortnames of all available parameters of the specified basic setting. For a KWP controller this function throws an exception.

Parameter

Name	Available if	Default value	Valid values	Type	Description
basicSettingName				int	The name of the default setting.
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	List with shortnames of all basic settings parameters.

GetShortNamesOfSubSystems¶

Returns a list of subsystem names of the active ECU.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

GetT15State¶

Returns the current terminal 15 (ignition) state.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	Possible return values: ‘on’, ‘off’ and ‘not available’

GetT30State¶

Returns the current terminal 30 (battery) state.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	Possible return values: ‘on’, ‘off’ and ‘not available’

InitProtocol¶

Initializes protocol.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

LockConnection¶

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 necessary to switch into STAY_CONNECTED_BEHAVIOUR for the connection by calling the job ‘ConnectToEcuAndOpenConnection’.

A lock can be removed calling ‘UnlockConnection’.

Locks will also be removed when calling one of the following operations: ‘CloseConnection’, ‘SetVehicleProject’.

Any operation working with multiple control units in parallel such as ‘ReadAllEventMemories’, ‘ReadMeasurements’ or ‘CreateProtocolBZD’ will also remove the lock

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ReadAdaptation¶

Returns current read values of the specified adaptation channel as a list.

KWP: List length = 1.

UDS: List length = n (equals the values from ‘getShortNamesOfAdaptationGroups’).

Parameter

Name	Available if	Default value	Valid values	Type	Description
adaptationChannel				string	The adaptation channel from which the adaptation values shall be retrieved.
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ReadAllEventMemories¶

Reads the event memories of all conrol units in the vehicle

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object

ReadCoding¶

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.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object

ReadDevEventMemory¶

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.

Parameter

Name	Default value	Valid values	Type	Description
dtcStatusMask	0xFF		int	Specifies the status of the event memories which will be read. Default: 0xFF
ecuAddress			int	ECU address as decimal or hexadecimal value (starting with 0x)
memorySelections	[]		object	The memory selections. If empty, all available memory selections will be used. - List of Strings.
readSnapshotRecord	False	[False, True]	bool	Switch to activate the reading of snapshot records. Default: False

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ReadEEPROMSerial¶

Reads (serially) the specified number of memory bytes from the ECU-EEPROM, starting at the startAddress.

This method is only supported by KWP1281 ECUs.

Parameter

Name	Type	Description
ecuAddress	int	ECU address as decimal or hexadecimal value (starting with 0x)
numberOfMemoryCells	string	Number of cells to read.
startAddress	string	Start address

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream

ReadEventMemory¶

Reads the event memories from the selected control unit

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ReadEventMemoryWithMask¶

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

Parameter

Name	Default value	Valid values	Type	Description
dtcStatusMask	0xFF		int	Specifies the status of the event memories which will be read. Default: 0xFF
ecuAddress			int	ECU address as decimal or hexadecimal value (starting with 0x)
readSnapshotRecords	False	[False, True]	bool	Switch to activate the reading of snapshot records. Default: False

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ReadGatewayComponentList¶

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.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ReadIdentification¶

Identification of the control unit

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object

ReadIdentificationData¶

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.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)
identDataIdentifier		[]		object	Shortname to specify the data which shall be to read. - String

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object

ReadMeasurement¶

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.

Parameter

Name	Default value	Type	Description
ecuAddress		int	ECU address as decimal or hexadecimal value (starting with 0x)
measurementGroup		string	The ODX short name of the measurement group or the KWP block number.
measurementParam	‘None’	string	The ODX short name of the measurement or the KWP position number.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	Dict with measurement values.

ReadMultilinkIdentification¶

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.

Parameter

Name	Valid values	Type	Description
ecuList		object	List of all ECU adresses (hex or decimal) to be read.
readExtendedIdent	[False, True]	bool	Flag to de-/activate the reading of extended identification values
readSubSystems	[False, True]	bool	Flag to de-/activate the reading of subsystems

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string	The identification data of all specified control units

ResetAllEventMemoriesSequential¶

Deletes the event memories of all control units

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ResetEventMemories¶

Deletes the event memory of all ECUs.

Parameter

Name	Default value	Valid values	Type	Description
clearFunctional		[False, True]	bool	Switch for functional deletion. False if empty.
clearNotErasedECUsPhysical		[False, True]	bool	Switch for physically deletion of all defined units, which KD-Bit is set in the gateway component list. False if empty.
clearOBD		[False, True]	bool	Switch for OBD deletion. True if empty.
controlUnitList	[]		object	List of ECU IDs whose fault memory should be cleared. If empty, all ECUs will be cleared.
timeBeforePhysicalClear			int	Waiting time in seconds between functional clear and reading of fitment list for physical clear. If empty, the value from ODIS settings will be used.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

ResetEventMemory¶

Deletes the event memories of the selected control unit

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

SaveProtocol¶

Saves protocol.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

SearchDoIPVCIs¶

Searches for available DoIP-VCIs. If the parameter for the IP address (ip) is None or empty the request is broadcasted. Otherwise the search is done via the specified IP address.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ip				string	IP address to connect to.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	DOIP VCIs found (VIN and IP address).

SecurityAccess¶

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

Parameter

Name	Type	Description
accessMode	string	The access mode.
ecuAddress	int	ECU address as decimal or hexadecimal value (starting with 0x)
loginCode	string	The login code.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

SecurityAccessSFDAllEcuLock¶

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.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	The result of the SFD lock process

SecurityAccessSFDAllOnline¶

Executes the security access unlock operation on all supported control units by using an online token (SFD). The online tokens are requested from the sfd backend system.

Parameter

Name	Valid values	Type	Description
accessMethod	[‘PKI’, ‘SoftPSE’, ‘TBT_TOKEN’]	string	The online access method for the backend system
duration	[‘SHORT’, ‘LONG’, ‘UNLIMITED’]	string	The durations for the SFD unlock operation
role	[‘EPTI’, ‘BASIC’, ‘EXTENDED’, ‘SUPERUSER’, ‘PRODUCTION’, ‘OTA’]	string	The role for the SFD unlock operation

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	The result list of the SFD unlock operations

SecurityAccessSFDCheckStatus¶

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

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	The SFD unlock status

SecurityAccessSFDEcuLock¶

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

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	The result of the SFD lock process

SecurityAccessSFDOffline¶

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

Parameter

Name	Valid values	Type	Description
duration	[‘SHORT’, ‘LONG’, ‘UNLIMITED’]	string	The durations for the SFD unlock operation
ecuAddress		int	ECU address as decimal or hexadecimal value (starting with 0x)
role	[‘EPTI’, ‘BASIC’, ‘EXTENDED’, ‘SUPERUSER’, ‘PRODUCTION’, ‘OTA’]	string	The role for the SFD unlock operation

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	The result of the SFD unlock operation

SecurityAccessSFDOnline¶

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.

Parameter

Name	Valid values	Type	Description
accessMethod	[‘PKI’, ‘SoftPSE’, ‘TBT_TOKEN’]	string	The online access method for the backend system
duration	[‘SHORT’, ‘LONG’, ‘UNLIMITED’]	string	The durations for the SFD unlock operation
ecuAddress		int	ECU address as decimal or hexadecimal value (starting with 0x)
role	[‘EPTI’, ‘BASIC’, ‘EXTENDED’, ‘SUPERUSER’, ‘PRODUCTION’, ‘OTA’]	string	The role for the SFD unlock operation

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	The result of the SFD unlock operation

SecurityAccessSFDReset¶

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.

Parameter

Name	Valid values	Type	Description
accessMethod	[‘PKI’, ‘SoftPSE’, ‘TBT_TOKEN’]	string	The online access method for the backend system
duration	[‘SHORT’, ‘LONG’, ‘UNLIMITED’]	string	The durations for the SFD unlock operation
ecuAddress		int	ECU address as decimal or hexadecimal value (starting with 0x)
role	[‘EPTI’, ‘BASIC’, ‘EXTENDED’, ‘SUPERUSER’, ‘PRODUCTION’, ‘OTA’]	string	The role for the SFD unlock operation

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	The result of the SFD reset operation

SecurityAccessSFDSetTBTToken¶

Sets a new TBT-Token for the next security access operation via access-method ‘OnlineAccessMethod.TBT_TOKEN’. Each token is valid only for the next security access operation and is discarded afterwards.

Parameter

Name	Available if	Default value	Valid values	Type	Description
tbtToken				object	The new TBT-Token

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object

SendRawService¶

Writes raw hex data.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)
requestPdu				ByteStream	Raw diagnostic data (PDU) as Bytestream, e.g.: ‘ByteStream(‘20:FF:FF:FF’)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

SendRawServiceFunctional¶

Writes raw hex data functional.

Parameter

Name	Available if	Default value	Valid values	Type	Description
logicalLink				string	Name of the logical link.
requestPdu				ByteStream	Raw diagnostic data (PDU) as Bytestream, e.g.: ‘ByteStream(‘20:FF:FF:FF’)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

SetCanFDVehicleProject¶

Sets and loads the CAN-FD vehicle project for the diagnostic interface. Loading a project is a precondition for connecting to a control unit.

Parameter

Name	Available if	Default value	Valid values	Type	Description
projectName				string	The project name.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

SetDoIPActivationLine¶

Activates or deactivates the DoIP-ActivationLine if a VCI is selected that supports DoIP.

Parameter

Name	Available if	Default value	Valid values	Type	Description
toSet			[False, True]	bool	True\|False to switch the ActivationLine ON\|OFF.

SetDoIPVehicleProject¶

Sets and loads the DoIP vehicle project for the diagnostic interface. Loading a project is a precondition for connecting to a control unit.

Parameter

Name	Type	Description
identifier	string	VIN to connect to.
ip	string	IP address to connect to.
projectName	string	The project name.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

SetVehicleProject¶

Sets and loads the vehicle project for the diagnostic interface. Loading a project is a precondition for connecting to a control unit.

Parameter

Name	Available if	Default value	Valid values	Type	Description
projectName				string	The project name.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

StartProtocol¶

Starts protocol.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

StopProtocol¶

Stops protocol.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

SwitchSession¶

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 identifier are used:

00 VAS505x mode

83 End of line within volkswagen

84 End of line within control unit producer

85 Update programming

86 Developper mode

89 Standard selfdiagnostics

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)
session				string	Diagnostic session to switch to.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

UnloadProject¶

Unloads the vehicle project.

UnlockConnection¶

Removes the lock for the specified connection.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ecuAddress				int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

WriteAdaptation¶

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.

Parameter

Name	Type	Description
adaptationChannel	string	The adaptation channel to which the adaptation values shall be written.
adaptationValues	object	The adaptation values which shall be written. Example for a key/value pair: {‘Param_ActiveStartStopFunct’: ‘active’}.
ecuAddress	int	ECU address as decimal or hexadecimal value (starting with 0x)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

WriteByteCoding¶

Writes coding values for the specified (sub)system.

Parameter

Name	Type	Description
codingValue	string	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.
ecuAddress	int	ECU address as decimal or hexadecimal value (starting with 0x)
systemName	string	The (sub)system name. KWP subsystems start with prefix subSys followed by the index.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream

WriteTextCoding¶

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.

Parameter

Name	Valid values	Type	Description
codingValues		object	The plain text coding values as dictionary with Key/Value pairs. Key = ShortNamesOfCodingValue Value = Coding Value
ecuAddress		int	ECU address as decimal or hexadecimal value (starting with 0x)
ecuReset	[False, True]	bool	Do a reset after writing?
systemName		string	The (sub)system name. KWP subsystems start with prefix subSys followed by the index.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string