Port DIAGNOSTICS_JOBS - DEFAULT¶
Stimulation¶
This port has no stimulus capabilities.
Properties 🛈¶
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
Automatically connect to ECU |
☑ |
bool |
Defines whether the connection to the ECU is established automatically or if it is established manually by using a port job |
||
ECU address |
0 |
int |
Address of the control unit |
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.
Parameterization
Parameter
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: …} |
||
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).
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
actuators |
object |
List of the actuator shortNames to start. |
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).
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
actuators |
object |
List of the actuator shortNames to start. |
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.
Parameterization
Parameter
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: …} |
||
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).
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
basicSettings |
[] |
object |
List with shortnames of the basic settings to be checked. |
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).
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
basicSettings |
[] |
object |
List with shortnames of the basic settings to be started. |
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).
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
basicSettings |
[] |
object |
List with shortnames of the basic settings to be started. |
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.
Parameterization
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
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
containerFileName |
string |
Name of the container file with full path. |
|||
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. |
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.
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
ConnectToEcu¶
Connects to the control unit with the defined address.
Parameterization
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.
Parameterization
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
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. |
FlashProgramming¶
Flashing with an update container.
Parameterization
Parameter
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. |
|||
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.
Parameterization
Parameter
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. |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
GetShortNamesOfAccessModes¶
Returns the ODX-ShortNames of all available access modes for UDS control units. The function throws an exception for KWP control units.
Parameterization
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.
Parameterization
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.
Parameterization
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
adaptationChannel |
int |
The adaptation channel from which the adaptation values shall be retrieved. |
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.
Parameterization
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.
Parameterization
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.
Parameterization
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
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.
Parameterization
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
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.
Parameterization
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
actuatorName |
int |
The name of the actuator. |
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
basicSettingName |
int |
The name of the default setting. |
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.
Parameterization
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
Parameterization
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’).
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
adaptationChannel |
string |
The adaptation channel from which the adaptation values shall be retrieved. |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
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.
Parameterization
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
dtcStatusMask |
0xFF |
int |
Specifies the status of the event memories which will be read. Default: 0xFF |
||
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
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
Parameterization
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
dtcStatusMask |
0xFF |
int |
Specifies the status of the event memories which will be read. Default: 0xFF |
||
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.
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
ReadIdentification¶
Identification of the control unit
Parameterization
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
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. |
ResetEventMemory¶
Deletes the event memories of the selected control unit
Parameterization
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
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
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
accessMode |
string |
The access mode. |
|||
loginCode |
string |
The login code. |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
SecurityAccessSFDCheckStatus¶
Reads the security access unlock status for the specified control unit (SFD).
Parameterization
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).
Parameterization
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).
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
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 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.
Parameterization
Parameter
Name |
Available if |
Default value |
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 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.
Parameterization
Parameter
Name |
Available if |
Default value |
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 of the SFD reset operation |
SendRawService¶
Writes raw hex data.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
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 |
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
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
session |
string |
Diagnostic session to switch to. |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
UnlockConnection¶
Removes the lock for the specified connection.
Parameterization
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
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’}. |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
string |
WriteByteCoding¶
Writes coding values for the specified (sub)system.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
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. |
|||
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.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
codingValues |
object |
The plain text coding values as dictionary with Key/Value pairs. Key = ShortNamesOfCodingValue Value = Coding Value |
|||
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 |