VW: ODIS¶
Bisheriger/interner Bezeichner: ODIS
Herstellerinformationen
Hersteller |
Webseite |
Produktname |
Version |
|---|---|---|---|
Volkswagen AG |
Offboard Diagnostic Information System Engineering |
ab 7.1.3, getestet bis 17.0.1 |
Kategorien
MDL 🛈 |
APL 🛈 |
BAN 🛈 |
BMA 🛈 |
SVC 🛈 |
DGN 🛈 |
FIU 🛈 |
EES 🛈 |
FCT 🛈 |
DBG 🛈 |
IMG 🛈 |
AUDIO 🛈 |
ENVSIM 🛈 |
ENVCOM 🛈 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
✓ |
Plattform
Betriebssystem |
Unterstützung |
|---|---|
Windows |
✓ |
Linux |
Ports¶
Eigenschaften 🛈¶
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
Port des ODIS WebServices |
‚8081‘ |
string |
|||
Projektmodus |
‚SERVICE‘ |
[‚SERVICE‘, ‚ENGINEERING‘] |
string |
Legt fest, ob ODIS für die automatische Projektbestimmung den Service- oder Engineeringmodus verwenden soll. |
|
Fahrzeugprojekt beim Start laden |
☑ |
bool |
Lade Automatisch das Fahrzeugprojekt beim Start der Konfiguration (Default=True). |
||
Fahrzeugprojekt |
Fahrzeugprojekt beim Start laden: ‚True‘ |
string |
Name des Fahrzeugprojekts in ODIS |
||
Pfad der WebService Konfigurationsdatei ❲relativ zum Installationsverzeichnis❳ |
‚configuration\webservice.ini‘ |
string |
|||
Timeout für eine Antwort von ODIS |
600 |
int |
Maximale Zeitspanne in Sekunden in der auf eine Antwort von ODIS gewartet wird |
||
Verbindungsart |
Fahrzeugprojekt beim Start laden: ‚True‘ |
CAN |
[CAN, CANFD, DOIP] |
string |
CAN, CAN-FD oder DoIP |
DoIP-Adresse |
Fahrzeugprojekt beim Start laden: ‚True‘ » Verbindungsart: ‚DOIP‘ |
string |
IP-Adresse für den DoIP-Verbindungsaufbau |
||
DoIP-VIN |
Fahrzeugprojekt beim Start laden: ‚True‘ » Verbindungsart: ‚DOIP‘ |
string |
VIN für den DoIP-Verbindungsaufbau |
||
Aktiviere DoIPActivationLine |
Fahrzeugprojekt beim Start laden: ‚True‘ » Verbindungsart: ‚DOIP‘ |
☐ |
bool |
Aktiviert die DoIPActivationLine wenn True. |
|
Authentisierungsmethode |
NONE |
[NONE, PKI, SoftPSE] |
string |
Authentisierungmethode: PKI-Karte oder SoftPSE-Zertifikat. |
|
Zertifikatname |
Authentisierungsmethode: ‚SoftPSE‘ |
string |
CommonName SoftPSE-Zertifikat |
||
Technischer Nutzer |
Authentisierungsmethode: ‚SoftPSE‘ |
string |
Technischer Nutzer |
||
Benutzer |
Authentisierungsmethode: ‚SoftPSE‘ |
string |
Benutzer |
||
Timeout für Toolzugriffe ❲in Sek.❳ |
‚600‘ |
string |
Zeit nach der eine Anfrage an das Tool abgebrochen wird. |
Jobs 🛈¶
ActuatorDiagnosticsInit¶
Initialisiert die Aktordiagnose mit den angegebenen Aktoren. Die Initialisierung muss aufgerufen werden um die Aktordiagnose zu starten.
Für UDS-Steuergeräte können Einstellungen und Messwerte konfiguriert werden, die durch eine Prüfoperation für jede Grundeinstellung gelesen werden.
Für KWP-Steuergeräte sind die Einstellungen auf ein Objekt limitiert und Messwerte werden ignoriert. Stellt sicher, dass die folgende Operation über die gleiche Diagnoseverbindung durchgeführt wird.
ODIS setzt voraus, dass die ECU-Verbindung mit ConnectToEcuAndOpenConnection hergestellt wurde.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
actuators |
[] |
object |
Die zu initialisierenden Aktoren als Python-Dict. Struktur: {shortName1: { parameters: {param1:value1, param2:value2, …},
measurements: [mParam1,mParam2]},
shortName2: …} |
||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
measurements |
object |
Die Messwerte in einer Liste. Kann None sein. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ActuatorDiagnosticsStart¶
Startet die Aktordiagnose für die angegebenen Aktoren (UDS-Steuergeräte) oder den in actuatorDiagnosticsInit angegebenen Aktor (KWP-Steuergeräte).
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
actuators |
object |
Liste mit Shortnames der zu startenden Aktoren. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Der Status des Startvorgangs. |
ActuatorDiagnosticsStop¶
Stoppt die Aktordiagnose für die angegebenen Aktoren (UDS-Steuergeräte) oder den in actuatorDiagnosticsInit angegebenen Aktor (KWP-Steuergeräte).
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
actuators |
object |
Liste mit Shortnames der zu startenden Aktoren. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Der Status des Stoppvorgangs. |
BasicSetting2Init¶
Initialisiert die Grundeinstellungsdiagnose mit den angegebenen Einstellungen. Die Initialisierung muss aufgerufen werden, um die Grundeinstellungsdiagnose zu starten.
Für UDS-Steuergeräte kann eine Liste von Einstellungen und eine Liste von Messwerten angegeben werden. Diese werden für jede Grundeinstellung durch den Check-Aufruf gelesen. Die angegebenen Messwerte können für verschiedene Steuergeräte konfiguriert werden.
Für KWP-Steuergeräte darf die Liste der Einstellungen nur ein Element enthalten und die Liste der Messwerte wird ignoriert.
Stellt sicher, dass die folgenden Aufrufe über die gleiche Diagnoseverbindung laufen. Nachdem diese Funktion aufgerufen wurden, darf nicht zu einem anderen Steuergerät gewechselt werden. Für UDS-Steuergeräte wird dieser Zustand durch Aufruf von „basicSettingAbort“ verlassen.
ODIS setzt voraus, dass die ECU-Verbindung mit ConnectToEcuAndOpenConnection hergestellt wurde.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
basicSettings |
{} |
object |
Die zu initialisierende Grundeinstellung als Python-Dict. Struktur: {shortName1: { parameters: {param1:value1, param2:value2, …},
measurements: [mParam1,mParam2]},
shortName2: …} |
||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
measurements |
None |
object |
Die Messwerte in einer Liste. Kann None sein. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
BasicSettingCheck¶
Startet die Grundeinstellungsprüfung für die spezifizierten Einstellungen (UDS-Steuergeräte) oder die Einstellungen die in „basicSetting2Init“ konfiguriert wurden (KWP-Steuergeräte).
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
basicSettings |
[] |
object |
Liste mit Shortnames der zu prüfenden Grundeinstellungen. |
||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Der Status des Startvorgangs. |
BasicSettingStart¶
Startet die Grundeinstellungsdiagnose für die angegebenen Einstellungen. (UDS-Steuergeräte) oder die Einstellungen die in „basicSetting2Init“ konfiguriert wurden (KWP-Steuergeräte).
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
basicSettings |
[] |
object |
Liste mit Shortnames der zu startenden Grundeinstellungen. |
||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Der Status des Startvorgangs. |
BasicSettingStop¶
Stoppt die Grundeinstellungsdiagnose für die angegebenen Einstellungen. (UDS-Steuergeräte) oder die Einstellungen die in „basicSetting2Init“ konfiguriert wurden (KWP-Steuergeräte).
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
basicSettings |
[] |
object |
Liste mit Shortnames der zu startenden Grundeinstellungen. |
||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Der Status des Stoppvorgangs. |
CheckFlashProgramming¶
Prüft, ob die ECU prinzipiell flashbar ist.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
[False, True] |
bool |
Liefert True, wenn die ECU prinzipiell fllashbar ist. Liefert auch True, wenn keine Information verfügbar ist. |
CheckFlashProgrammingWithFlashContainer¶
Prüft, ob die ECU mit dem Inhalt des containerFileName und dem angegebenen sessionName flashbar ist.
UDS: Überprüfung anhand EXPECTED IDENTS (beinhaltet die Überprüfung von Teilenummer und Softwareversion.
KWP: Überprüfung von Teilenummer und SOftwareversion
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
containerFileName |
string |
Kompletter Dateipfad zum Flash-Container. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
sessionName |
‚None‘ |
string |
Der Session-Name des Flashvorgangs. Der Parameter kann ‚None‘ sein. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
[False, True] |
bool |
Liefert True, wenn die ECU mit dem Inhalt des containerFileName fllashbar ist. |
CheckVciState¶
Gibt den Status der VCI zurück.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Mögliche Rückgabewerte: ‚connected‘, ‚not connected‘ und ‚not available‘ |
CloseConnection¶
Beendet die Verbindung zur ECU und wechselt zum CLOSE_CONNECTION_BEHAVIOUR.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ConfigureSetting¶
Konfiguriert eine Einstellung des VCI-Testers.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
paramKey |
string |
Name der Einstellung. |
|||
paramValue |
string |
Neuer Wert der Einstellung. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ConnectToEcu¶
Verbindet sich mit dem Steuergerät mit der angegebenen Adresse.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ConnectToEcuAndOpenConnection¶
Verbindet sich mit dem Steuergerät mit der angegebenen Adresse und und wechselt zum STAY_CONNECTED_BEHAVIOUR.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
CreateProtocolVDSBZD¶
Erzeugt VDS/BZD Dokumentation.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
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 |
Fehlerspeicher lesen. |
||
userName |
string |
Benutzername. Wenn leer wird der aktuell angemeldete Benutzer verwendet. |
|||
vehicleNumber |
string |
Fahrzeugnummer. |
|||
vin |
string |
Wenn leer wird die aktuelle VIN verwendet. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
DataSetDownload¶
Schreibt einen Datensatz mit XML-Inhalt in das aktuelle Steuergerät.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
xmlFilePath |
string |
Absoluter Pfad zur XML- oder ZIP-Datei, einschließlich Dateiname und Suffix. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Allgemeine Antwort. DiagException - Wenn ein Fehler während der Requestverarbeitung auftritt. |
DisableTransportMode¶
Reaktivierung eines Fahrzeugs aus dem Transportmodus.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
DiscardProtocol¶
Verwirft das Protokoll.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
EnableTransportMode¶
Aktivierung des Transportmode eines Fahrzeugs, um den Energieverbrauch zu minimieren.
Dies geschieht, wenn ein längerer Stillstand z.B. bei Lagerung oder Transport bevorsteht. Als Voraussetzung ist keine Verbindung zum Steuergerät notwendig.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ExecuteMacro¶
Führt ein Macro aus.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
macroName |
string |
Vollständiger Dateipfad zum Macro. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
FlashProgramming¶
Flashen mit einem Updatecontainer.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
checkSessionWithEcu |
None |
[False, True] |
bool |
Überprüfung der EXPECTED IDENTS bei UDS bzw. Teilenummer und Softwareversion bei KWP. Kann None sein, dann wird als Defaultwert ‚True‘ genutzt. |
|
containerFileName |
string |
Kompletter Dateipfad zum Flash-Container. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
sessionName |
‚None‘ |
string |
Der Session-Name des Flashvorgangs. Der Parameter kann ‚None‘ sein. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
ByteStream |
GetFlashSessions¶
Gibt die Namen aller Flash Sessions zurück, die im aktuellen Flash-Container enthalten sind.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
checkSessionWithEcu |
None |
[False, True] |
bool |
[True/False] True: Überpüfung der Flashbarkeit anhand EXPECTED IDENTS (UDS) bzw. anhand Teilenummer und Softwareversion (KWP). Kann None sein, dann wir der Defaultwert ‚True‘ verwendet. |
|
containerFileName |
string |
Kompletter Dateipfad zum Flash-Container. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
GetProjectEcuAddressList¶
Gibt die Steuergeräteadressen des Fahrzeugprojektes zurück.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
GetSFDLinkNames¶
Liefert eine Liste aller erreichbaren Steuergeräte, welche SFD unterstützen.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Liste aller SFD-Steuergeräte |
GetShortNamesOfAccessModes¶
Liefert die ODX-Shortname-Liste aller verfügbaren Zugriffsmodi für UDS-Steuergeräte. Bei KWP-Steuergeräten wird einen Exception geworfen.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
GetShortNamesOfActuators¶
Liefert die ODX-Shortnames aller verfügbaren Aktoren des ausgewählten Steuergeräts. Für ein KWP-Steuergerät wirft diese Funktion eine Exception.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Liste mit den Shortnames aller Aktoren. |
GetShortNamesOfAdaptationChannels¶
Liefert die ODX-Shortname-Liste aller verfügbaren Anpassungskanäle für UDS-Steuergeräte. Bei KWP-Steuergeräten wird einen Exception geworfen.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
GetShortNamesOfAdaptationValues¶
Liefert die ODX-Shortname-Liste aller möglichen Eingabewerte eines Anpassungskkanals für UDS-Steuergeräte. Bei KWP-Steuergeräten wird einen Exception geworfen.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
adaptationChannel |
int |
The adaptation channel from which the adaptation values shall be retrieved. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
GetShortNamesOfBasicSettings¶
Liefert die ODX-Shortnames aller verfügbaren Grundeinstellungen des ausgewählten Steuergeräts. Für ein KWP-Steuergerät wirft diese Funktion eine Exception.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Liste mit den Shortnames aller Grundeinstellungen. |
GetShortNamesOfCodingValues¶
Liest die Kodierungsnamen vom aktiven Steuergerät.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Die Shortnames der Ergebnisse. |
GetShortNamesOfDiagnosticSessions¶
Liefert die ODX-Shortname-Liste aller verfügbaren Diagnosesessions für UDS-Steuergeräte. Bei KWP-Steuergeräten wird einen Exception geworfen.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
GetShortNamesOfIdentificationDatas¶
Liefert die ODX-Shortnames aller Identifikationsdaten des angegebenen Subsystems. Für ein KWP-Steuergerät wirft diese Funktion eine Exception.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
subsystem |
string |
Name des Subsystems, für das die Werte ausgegeben werden. Wenn der Name des Subsystems leer ist, werden die Shortnames für die Master ECU zurückgegeben. - String |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
GetShortNamesOfMeasurementGroups¶
Liefert die ODX-Shortname-Liste aller verfügbaren Messwertgruppen für das ausgewählte Steuergerät. Für KWP-Steuergeräte wirft diese Funktion eineException.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Die Messwertgruppen |
GetShortNamesOfMeasurements¶
Liefert die ODX-Shortnames aller verfügbaren Messwerte der angegebenen Messwertgruppe. Für KWP-Steuergeräte wirft diese Funktion eine Exception.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
measurementGroup |
string |
Die Messwertgruppe, deren verfügbare ODX-Shortnames ermittelt werden sollen. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Die ODX-Shortnames aller verfügbaren Messwerte der angegebenen Messwertgruppe |
GetShortNamesOfMeasurementsForBasicSettings¶
Liefert die ODX-Shortnames aller Messwerte für die Grundeinstellung. Für ein KWP-Steuergerät wirft diese Funktion eine Exception.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Liste mit den Shortnames aller Messwerte der Grundeinstellungen. |
GetShortNamesOfStartParametersForActuator¶
Liefert die ODX-Shortnames aller verfügbaren Parameter des angegebenen Aktors. Für ein KWP-Steuergerät wirft diese Funktion eine Exception.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
actuatorName |
int |
Der Name des Aktors. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Liste mit den Shortnames aller Aktorparameter. |
GetShortNamesOfStartParametersForBasicSettings¶
Liefert die ODX-Shortnames aller verfügbaren Parameter der angegebenen Grundeinstellung. Für ein KWP-Steuergerät wirft diese Funktion eine Exception.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
basicSettingName |
int |
Der Name der Grundeinstellung. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Liste mit den Shortnames aller Grundeinstellungsparameter. |
GetShortNamesOfSubSystems¶
Gibt eine Liste der Subsystemnamen der aktiven ECU zurück.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
GetT15State¶
Gibt den Status der Klemme 15 zurück.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Mögliche Rückgabewerte: ‚on‘, ‚off‘ und ‚not available‘ |
GetT30State¶
Gibt den Status der Klemme 30 zurück.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Mögliche Rückgabewerte: ‚on‘, ‚off‘ und ‚not available‘ |
InitProtocol¶
Initialisiert das Protokoll.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
LockConnection¶
Sperrt die Verbindung zur angegebenen ECU.
Die Sperre garantiert, dass die Verbindung zur ECU offen bleibt während an anderen Verbindungen gearbeitet wird.
Funktionsaufrufe zu einer anderen ECU werfen eine Exception, wenn keine andere parallele Verbindung parallel geöffnet werden kann.
Falls keien Sperre gesetzt ist, kann die Verbindung jederzeit geschlossen werden, abhängig von der konfigurierten Anzahl an möglichen parallelen Verbindungen.
Um die Sperre zu setzen, ist es notwendig zuvor in das STAY_CONNECTED_BEHAVIOUR zu wechseln. Dafür bitte den Job ‚ConnectToEcuAndOpenConnection‘ nutzen.
Eine Sperre kann mit dem Job ‚UnlockConnection‘ wieder aufgehoben werden.
Folgende Jobs heben die Sperre außerdem auf: ‚CloseConnection‘, ‚SetVehicleProject‘
Außerdem heben einzelne multiple Funktionen die Sperre auf (z.B. ‚ReadAllEventMemories‘ oder ‚CreateProtocolBZD‘)
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ReadAdaptation¶
Liefert die Istwerte eines Anpassungskkanals als Liste.
KWP: Listenlänge = 1.
UDS: Listenlänge = n (entspricht den Werten aus ‚getShortNamesofAdaptionGroups‘.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
adaptationChannel |
string |
The adaptation channel from which the adaptation values shall be retrieved. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ReadAllEventMemories¶
Liest Ereignisspeicher aller Steuergeräte aus
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
ReadCoding¶
Liest Kodierung der ausgewählten ECU aus.
UDS: Klartextcodierung und Binärcodierung wird gelesen.
KWP: Nur Binärcodierung.
UDS und KWP: Falls die ECU Slaves besitzt, wird jede Slavecodierung gelesen und zurückgegeben.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
ReadDevEventMemory¶
Liest die Entwicklerereignisspeicher von der ausgewählten ECU einschließlich aller Umgebungsbedingungen. Bei UDS-Steuergeräten werden nur die Ereignisspeicher mit der angegebenen Statusmaske gelesen. Der Maskenparameter wirkt sich nicht auf KWP-Steuergeräte aus.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
dtcStatusMask |
0xFF |
int |
Spezifiziert die Filter-Maske für den Status der zurückgegebenen Einträge. Default: 0xFF |
||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
memorySelections |
[] |
object |
Auswahl der zu lesenden Speicher. Wenn leer, werden alle verfügbaren Speicher verwendet. Format: Liste von Strings. |
||
readSnapshotRecord |
False |
[False, True] |
bool |
Gibt an, ob DTC-Snapshots gelesen werden sollen. Default: False |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ReadEEPROMSerial¶
Liest (seriell) die angegebene Nummer an Speicherbytes vom ECU-EEPROM, beginnend bei der startAddress.
Diese Methode wird nur von KWP1281-Steuergeräten unterstützt.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
numberOfMemoryCells |
string |
Anzahl der zu lesenden Speicherzellen. |
|||
startAddress |
string |
Startadresse |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
ByteStream |
ReadEventMemory¶
Liest Ereignisspeicher des Steuergerätes aus
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ReadEventMemoryWithMask¶
Liest die Ereignisspeicher der ausgewählten ECU einschließlich aller Umgebungsbedingungen. Bei UDS-Steuergeräten werden nur die Ereignisspeicher mit der angegebenen Statusmaske gelesen. Der Maskenparameter wirkt sich nicht auf KWP-Steuergeräte aus. Zusätzlich kann das Auslesen der Snapshot Records mit dem Parameter readSnapshotRecords aktiviert werden.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
dtcStatusMask |
0xFF |
int |
Spezifiziert die Filter-Maske für den Status der zurückgegebenen Einträge. Default: 0xFF |
||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
readSnapshotRecords |
False |
[False, True] |
bool |
Gibt an, ob DTC-Snapshots gelesen werden sollen. Default: False |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ReadGatewayComponentList¶
Liest die Gatewaytabelle.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ReadIdentification¶
Identifikation des Steuergerätes
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
ReadIdentificationData¶
Liest einzelne Identifikationsdaten aus der aktuell ausgewählten Master-Steuereinheit aus und gibt sie zurück. Einzelne Identifikationsdaten können für UDS- und KWP2000 Service 22-Steuereinheiten gelesen werden und müssen durch einen Identifier ausgewählt werden. Für UDS-Steuergeräte muss einer der von getShortNamesOfIdentificationDatas zurückgegebenen Shortnames verwendet werden. Für KWP-Kontrolleinheiten muss ebenfalls ein UDS-Shortname verwendet werden, um die Identifikationsdaten anzugeben. Der Shortname wird auf einen geeigneten Data Identifier abgebildet. Eine Liste der zugeordneten Shortnames finden Sie in der Automatisierungsparameter-Mapping-Datei. Wenn ein angegebener Bezeichner nicht verfügbar ist oder nicht zugeordnet werden kann, gibt die Funktion ein Ergebnis mit einer entsprechenden Fehlermeldung als Wert zurück.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
identDataIdentifier |
[] |
object |
Shortname der zu lesenden Identifikationsdaten. - String |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
ReadMeasurement¶
Liest die Messwerte vom ausgwählten Steuergerät.
Liest alle Werte der angegebenen Messwertgruppe oder - falls angegeben - einen bestimmten Messwert aus dieser Gruppe.
Für KWP-Steuergeräte wird das Lesen von Blocknummer und -position unterstützt.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
measurementGroup |
string |
Der ODX-Shortname der Messwertgruppe oder die KWP-Blocknummer. |
|||
measurementParam |
‚None‘ |
string |
Der ODX-Shortname der Messung oder die KWP-Positionsnummer. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Dict mit Messwerten. |
ReadMultilinkIdentification¶
Liest die Identifikationsdaten des angegebenen Steuergeräts mit den aktuellen Multilink-Einstellungen. Wenn das Flag readExtendedIdent aktiviert ist, wird die erweiterte Identifikation gelesen. Anderenfalls wird nur die Standardidentifikation ermittelt. Wenn das Flag readSubSystems aktiviert ist, werden zusätzlich auch die Subsysteme gelesen. Achtung! Nur UDS-Steuergeräte werden unterstützt. Das Ergebniselement eines KWP-Steuergeräts enthält eine Fehlermeldung. Nach der Ausführung werden alle Verbindungen geschlossen.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuList |
object |
Liste aller Steuergeräteadressen (hex oder dezimal), die gelesen werden sollen. |
|||
readExtendedIdent |
[False, True] |
bool |
Flag zum (De-)Aktivieren des Lesens erweiterter Identifikationswerte |
||
readSubSystems |
[False, True] |
bool |
Flag zum (De-)Aktivieren des Lesens von Subsystemen |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Die Identifikationsdaten aller angegebenen Steuergeräte |
ResetAllEventMemoriesSequential¶
Löscht Ereignisspeicher aller Steuergeräte
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ResetEventMemories¶
Löscht Ereignisspeicher aller Steuergeräte.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
clearFunctional |
[False, True] |
bool |
Schalter für funktionales Löschen. False wenn leer. |
||
clearNotErasedECUsPhysical |
[False, True] |
bool |
Schalter für physikalsches Löschen aller definierten Steuergeräte, deren KD-Bit in der Gateway-Komponentenliste gesetzt ist. False wenn leer. |
||
clearOBD |
[False, True] |
bool |
Schalter für das Löschen der OBD Steuergeräte.True wenn leer. |
||
controlUnitList |
[] |
object |
Liste der Steuergeräte-IDs deren Fehlerspeicher gelöscht werden soll. Wenn leer, werden alle Steuergeräte gelöscht. |
||
timeBeforePhysicalClear |
int |
Wartezeit in Sekunden zwischen funktionalem Löschen und Lesen der Liste für physisches Löschen. Wenn leer wird der Wert aus den ODIS Einstellungen verwendet. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
ResetEventMemory¶
Löscht Ereignisspeicher des Steuergerätes
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
SaveProtocol¶
Speichert das Protokoll.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
SearchDoIPVCIs¶
Sucht nach verfügbaren DoIP-VCIs. Falls der Parameter für die IP-Adresse (ip) None oder ein Leerstring ist, wird mit einem Broadcast gesucht. Ansonsten wird die Suche über die angegebeneIP-Adresse ausgeführt.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ip |
string |
IP-Adresse zu der die Verbindung hergestellt werden soll. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Gefundene DOIP VCIs (VIN und IP-Adresse). |
SecurityAccess¶
Führt eine Sicherheitszugriffsoperation auf dem Steuergerät unter Verwendung des angegebenen Login-Codes und Zugriffsmodus durch.
KWP2000-Zugriffsmodi: automatic, level34, level56, coding2
KWP1281-Zugriffsmodi: automatic
UDS-Zugriffsmodi: Login, System Specific
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
accessMode |
string |
Der Zugriffsmodus. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
loginCode |
string |
Der Login-Code. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
SecurityAccessSFDAllEcuLock¶
Führt einen SecurityAccess-Sperrvorgang auf allen unterstüzten Steuergeröten aus. Auf allen Steuergeräte wird vor der Ausführung die extented-Diagnosesitzung über einen funktionalen Diagnose-Aufruf hergestellt.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Das Ergebnis des SFD-Sperrvorgangs |
SecurityAccessSFDAllOnline¶
Führt einen SecurityAccess-Freischaltvorgang mit Hilfe eines SFD-Online-Tokens auf allen unterstüzten Steuergeröten aus. Der SFD-Online-Tokens wird vom SFD-Backend angefragt.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
accessMethod |
[‚PKI‘, ‚SoftPSE‘, ‚TBT_TOKEN‘] |
string |
Authentifizierungsmethode für das SFD-Backend |
||
duration |
[‚SHORT‘, ‚LONG‘, ‚UNLIMITED‘] |
string |
Dauer für den SFD-Freischaltvorgang |
||
role |
[‚EPTI‘, ‚BASIC‘, ‚EXTENDED‘, ‚SUPERUSER‘, ‚PRODUCTION‘, ‚OTA‘] |
string |
Rolle für den SFD-Freischaltvorgang |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Liste der Ergebnisse aller SFD-Freischaltvorgänge |
SecurityAccessSFDCheckStatus¶
Liest den SecurityAccess-Freischaltstatus aus.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
SecurityAccess-Freischaltstatus |
SecurityAccessSFDEcuLock¶
Führt einen SecurityAccess-Sperrvorgang aus.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Das Ergebnis des SFD-Sperrvorgangs |
SecurityAccessSFDOffline¶
Führt einen SecurityAccess-Freischaltvorgang mit Hilfe eines SFD-Offline-Tokens aus. Dafür wird keine Verbindung zum SFD-Backend benötigt. Ein SFD-Offline-Token muss für das spezifizierte Steuergerät, die gewählte Rolle und Dauer im SFD-Token-Verzeichnis liegen (siehe ODIS-Admin).
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
duration |
[‚SHORT‘, ‚LONG‘, ‚UNLIMITED‘] |
string |
Dauer für den SFD-Freischaltvorgang |
||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
role |
[‚EPTI‘, ‚BASIC‘, ‚EXTENDED‘, ‚SUPERUSER‘, ‚PRODUCTION‘, ‚OTA‘] |
string |
Rolle für den SFD-Freischaltvorgang |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Das Ergebnis des SFD-Freischaltvorgangs |
SecurityAccessSFDOnline¶
Führt einen SecurityAccess-Freischaltvorgang mit Hilfe eines SFD-Online-Tokens aus. Der SFD-Online-Token wird vom SFD-Backend angefragt.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
accessMethod |
[‚PKI‘, ‚SoftPSE‘, ‚TBT_TOKEN‘] |
string |
Authentifizierungsmethode für das SFD-Backend |
||
duration |
[‚SHORT‘, ‚LONG‘, ‚UNLIMITED‘] |
string |
Dauer für den SFD-Freischaltvorgang |
||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
role |
[‚EPTI‘, ‚BASIC‘, ‚EXTENDED‘, ‚SUPERUSER‘, ‚PRODUCTION‘, ‚OTA‘] |
string |
Rolle für den SFD-Freischaltvorgang |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Das Ergebnis des SFD-Freischaltvorgangs |
SecurityAccessSFDReset¶
Führt einen SecurityAccess-Resetvorgang mit Hilfe eines SFD-Online-Tokens aus. Dieser Vorgang setzt das Steuergerät auf die initialen Schutzwerte zurück und darf nur von der Rolle SUPERUSER ausgeführt werden. Der SFD-Online-Token wird vom SFD-Backend angefragt.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
accessMethod |
[‚PKI‘, ‚SoftPSE‘, ‚TBT_TOKEN‘] |
string |
Authentifizierungsmethode für das SFD-Backend |
||
duration |
[‚SHORT‘, ‚LONG‘, ‚UNLIMITED‘] |
string |
Dauer für den SFD-Freischaltvorgang |
||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
role |
[‚EPTI‘, ‚BASIC‘, ‚EXTENDED‘, ‚SUPERUSER‘, ‚PRODUCTION‘, ‚OTA‘] |
string |
Rolle für den SFD-Freischaltvorgang |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Das Ergebnis des SFD-Resetvorgangs |
SecurityAccessSFDSetTBTToken¶
Setzt einen neuen TBT-Token für den nächsten SecurityAccess-Zugriff über die Methode „OnlineAccessMethod.TBT_TOKEN“. Jeder Token ist nur für einen Zugriff gültig und wird danach verworfen.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
tbtToken |
object |
Neuer TBT-Token |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
SendRawService¶
Sendet Rohdiagnose-Daten (HEX).
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
requestPdu |
ByteStream |
Rohdiagnose-Daten (PDU) als Bytestream, Bsp.: ‚ByteStream(‚20:FF:FF:FF‘) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
SendRawServiceFunctional¶
Funktionales Senden von Rohdiagnose-Daten (PDU) als Bytestream.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
logicalLink |
string |
Name des LogicalLink. |
|||
requestPdu |
ByteStream |
Rohdiagnose-Daten (PDU) als Bytestream, Bsp.: ‚ByteStream(‚20:FF:FF:FF‘) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
SetCanFDVehicleProject¶
Setzt und lädt ein CAN-FD-Fahrzeugprojekt für das Diagnoseinterface. Ein Fahrzeugprojekt zu laden, ist Voraussetzung für die Verbindung zum Steuergerät.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
projectName |
string |
Der Projektname. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
SetDoIPActivationLine¶
Aktiviert oder deaktiviert die DoIP-ActivationLine, wenn ein VCI ausgewählt ist, welches DoIP unterstützt.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
toSet |
[False, True] |
bool |
True|False, um die ActivationLine AN|AUS zu schalten. |
SetDoIPVehicleProject¶
Setzt und lädt ein DoIP-Fahrzeugprojekt für das Diagnoseinterface. Ein Fahrzeugprojekt zu laden, ist Voraussetzung für die Verbindung zum Steuergerät.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
identifier |
string |
VIN zu der die Verbindung hergestellt werden soll. |
|||
ip |
string |
IP-Adresse zu der die Verbindung hergestellt werden soll. |
|||
projectName |
string |
Der Projektname. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
SetVehicleProject¶
Setzt und lädt das Fahrzeugprojekt für das Diagnoseinterface. Ein Fahrzeugprojekt zu laden, ist Voraussetzung für die Verbindung zum Steuergerät.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
projectName |
string |
Der Projektname. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
StartProtocol¶
Startet das Protokoll.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
StopProtocol¶
Stoppt das Protokoll.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
SwitchSession¶
Für UDS-Steuergeräte wird der Shortname der Diagnosesitzung verwendet, um diejenige Sitzung zu identifizieren, zu der gewechselt werden soll.
Für KWP-Steuergeräte werden die folgenden Identifier verwendet:
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
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
session |
string |
Diagnosesitzung zu der gewechselt werden soll. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
UnloadProject¶
Entlädt das Fahrzeugprojekt.
UnlockConnection¶
Hebt die Sperre der Verbindung zur angegebenen ECU auf.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
WriteAdaptation¶
Schreibt Anpassungskanal in die angegebenen Anpassungskanäle. Der Anpassungskanal und zu schreibende Werte müssen für UDS und KWP unterschiedlich angegeben werden.
Für UDS ist der Anpassungskanal einer der Kanäle von getShortNamesOfAdaptationChannels und die verfügbaren Werte des Kanals sind über getShortNamesOfAdaptationValues ermittelbar.
Die zu schreibenden Anpassungswerte werden dieser Funktion als Schlüssel-Wert-Dictionary übergeben. Der Schlüssel gibt den Shortname des Anpassungswerts an und der Wert ist der zu schreibende Anpassungswerte.
Für KWP wird die Kanalnummer als Zeichenfolge angegeben - d.h. von ‚1‘ bis ‚255‘.
Der zu schreibende Anpassungswert muss als einziger Eintrag im Schlüssel-Wert-Dictionary angegeben werden, wobei der Anpassungskanal als Schlüssel dient.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
adaptationChannel |
string |
Der Anpassungskanal in den die Anpassungswerte geschrieben werden sollen. |
|||
adaptationValues |
object |
Die zu schreibenden Anpassungswerte. Beispiel eines Schlüssel/Wert-Paares: {‚Param_ActiveStartStopFunct‘: ‚active‘}. |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
WriteByteCoding¶
Schreibt Kodierungswerte für das gewählte (Sub-)System.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
codingValue |
string |
Kodierungswert, der geschrieben werden soll als String. Für KWP short coding muss der Wert ein Integer sein. Für KWP long coding und UDS binary coding: ByteStream / Byte Array . |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
systemName |
string |
(Sub-)Systemname. KWP Subsysteme setzen sich aus dem Präfix ‚subSys‘ und dem Index zusammen. Ist kein Subsystem vorhanden, dann ‚master‘ übergeben. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
ByteStream |
WriteTextCoding¶
Schreibt die Textkodierwerte für das angegebene System.
Die Funktion ist nur für UDS-Steuergeräte definiert.
Für den Systemnamen des Master-Steuergeräts kann die Konstante ‚master‘ oder der Shortname verwendet werden.
Für KWP-Steuergeräte wird eine Exception geworfen.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
codingValues |
object |
Ein Dictionary mit Kodierwerten im Klartext als Schlüssel/Wert-Paare. Schlüssel = ShortNamesOfCodingValue Wert = Kodierwert |
|||
ecuAddress |
int |
ECU-Adresse als Dezimal- oder Hexadezimalwert (beginnend mit 0x) |
|||
ecuReset |
[False, True] |
bool |
Soll nach dem Schreiben ein Reset durchgeführt werden? |
||
systemName |
string |
(Sub-)Systemname. KWP Subsysteme setzen sich aus dem Präfix ‚subSys‘ und dem Index zusammen. Ist kein Subsystem vorhanden, dann ‚master‘ übergeben. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |