Port BUSACCESS - CAN¶

HIRAIN-HW-Zugriff auf CAN

Stimulation¶

Dieser Port unterstützt alle in Stimulationssteuerung beschriebenen Funktionen.

Eigenschaften 🛈¶

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
Kanalnummer		‚1‘		string	Auswahl der Kanalnummer wenn mehrere Kanäle des gleichen Typs vorhanden sind.
Bitrate		‚500KB‘	[‚100KB‘, ‚125KB‘, ‚250KB‘, ‚500KB‘, ‚666.667KB‘, ‚800KB‘, ‚1000KB‘]	string	Bitrate
Abschlusswiderstand aktivieren		☐		bool	Aktiviert den internen 120-Ohm-Abschlusswiderstand
Modus		Standard	[Standard, Extended, All]	string	Adressierungs-Modus (Standard = 11bit, Extended = 29bit)
Listen only		☐		bool	Kontroller läuft im passiven Modus. Automatisches ACK ist deaktiviert und das Senden von CAN-Frames ist nicht möglich.
Empfange Error-Frames		☐		bool	Empfange Error-Frames
Aufnahmeformat		ASC	[ASC, MDF4, PCAPNG]	string	Standard-Dateiformat für Bus-Aufzeichnung. PCAPNG für Bus wird in der Traceanalyse nicht unterstützt
Bus-DB				string
Platzhalterwert für automatische E2E-Berechnung				int	Wenn für ein E2E-Signal (z.B. CRC) dieser Wert angegeben wird, ersetzt ecu.test diesen beim Senden automatisch durch den korrekten, berechneten Wert. Diese Option dient dazu, beliebige feste Werte (ungleich dem hier eingestellten Wert) senden zu können. Diese Option leer zu lassen deaktiviert die Funktion komplett. Für mehr Informationen siehe Toolkategorien - Automatische E2E-Berechnung in der Dokumentation.
J1939 Modus	Modus: ‚Extended‘	☐		bool	Ignoriere die drei höchstwertigen Bits der CAN-ID und der J1939-Quelladresse. Extrahiere Signale von J1939-TP und ISOBus-ETP.
Sendebestätigung		☐		bool	Aktiviert das bestätigte Senden. Bus-Schreiben-Testschritte und Sende-Tooljobs blockieren so lange, bis die Nachricht erfolgreich auf den Bus übertragen wurde oder das Sendebestätigungs-Timeout abgelaufen ist.
Timeout für Sendebestätigung		1000		int	Dauer in Millisekunden binnen der die Nachricht erfolgreich versendet worden sein muss. Anderenfalls wird ein Fehler erzeugt. (darf nicht größer als 64535ms sein). Wird nur bei aktivierter Sendebestätigung verwendet.

Jobs 🛈¶

ClearFrame¶

Löscht den Empfangspuffer des angegebenen Frames

Parameter

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
FrameId				int	Frame ID
isExtended		None	[False, True]	bool	Adressformat: True für 29 Bit, False für 11 Bit, None übernimmt die Einstellung „Modus“ aus der Testbenchkonfiguration

Rückgabewert

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
result				ByteStream	ByteStream

CloseIsoTpSession¶

Schließt die ISO-TP Session.

Rückgabewert

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
Return			[False, True]	bool	Session erfolgreich geschlossen

DeregisterFrameForInbox¶

Deregistriert ein Frame, das in die Inbox gestream wird

Parameter

Name	Standardwert	Gültige Werte	Typ	Beschreibung
FrameId			int	Frame ID
Inbox			object	Bestehende Inbox
isExtended	None	[False, True]	bool	Adressformat: True für 29 Bit, False für 11 Bit, None übernimmt die Einstellung „Modus“ aus der Testbenchkonfiguration

DeregisterStreamForInbox¶

Deregistriert eine ISO-TP Session.

Parameter

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
conId				int	Connection ID

DisableSendFrameCyclic¶

Zyklisches Senden einer Botschaft mit angegebener ID deaktivieren

Parameter

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
FrameId				int	Frame ID
isExtended		None	[False, True]	bool	Adressformat: True für 29 Bit, False für 11 Bit, None übernimmt die Einstellung „Modus“ aus der Testbenchkonfiguration

GetFirstValue¶

Gibt den ersten Wert des Signals zurück, der seit Testfallbeginn empfangen wurde.

Parameter

Name	Standardwert	Gültige Werte	Typ	Beschreibung
FrameName			string	Frame-Name
NodeName			string	Name des Steuergeräts
RawValue	False	[False, True]	bool	Wenn ‚True‘ wird der Raw-Wert zurückgegeben.
Reset	False	[False, True]	bool	Wenn ‚True‘‘ wird der erste empfangene Wert nach dem Lesen gelöscht
SignalName			string	Signalname

GetLastReceptionTimestamp¶

Liefert den Zeitstempel des letzten Empfangs in Sekunden

InitFrame¶

Registriert die Botschafts-ID für spätere Verwendung z.B. durch ReadFrame

Parameter

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
FrameId				int	Frame ID
isExtended		None	[False, True]	bool	Adressformat: True für 29 Bit, False für 11 Bit, None übernimmt die Einstellung „Modus“ aus der Testbenchkonfiguration

OpenIsoTpSession¶

Öffnet eine ISO-TP Session.

Parameter

Name	Standardwert	Typ	Beschreibung
addressByte		ByteStream	Netzwerk-Zieladresse bzw. Adress-Erweiterung (nur bei Extended- und Mixed-Adressierung relevant) - ByteStream der Länge 1
addressMode	0	int	Code des Adressierungsmodus - Integer (0: Standard Addressing \| 1: Extended Addressing)
blockSize	0	int	Anzahl (0 - 255) der CAN-Botschaften (Consecutive Frames), die ohne zwischengeschaltete Flow Control Botschaft empfangen werden können - Integer
fillByte		ByteStream	Byte zum Auffüllen von Nachrichten (optional) - ByteStream der Länge 1
flowControlAddressByte		ByteStream	Abweichende Netzwerk-Zieladresse bzw. Adress-Erweiterung für FlowControl (nur bei Extended- und Mixed-Adressierung relevant) - ByteStream der Länge 1
flowControlId		int	Message-ID für Flusskontroll-Botschaften (optional) - Hex (optional Integer)
isExtended	-1	int	Extended CAN ID-Format verwenden? (1=ja / 29 Bit; 0=nein / 11 Bit; -1 = Einstellung aus TBC verwenden)
maxFrameLength	0	int	Maximale Länge eines Frames in Byte (gilt sowohl für Start-, Consecutive- und LastFrames); Wenn dieser Wert auf 0 gesetzt wird, wird der im ISO 10681-2 beschriebene Maximalwert verwendet - Integer
requestId		int	Message-ID für Steuergeräteanfragen - Hex (optional Integer)
responseId		int	Message-ID für Steuergeräteantworten - Hex (optional Integer)
separationTime	0	int	Minimaler zeitlicher Abstand zwischen aufeinanderfolgenden Fragmenten 0x00..0x7F => 0..127ms, 0x80..0xf0 => reserviert, 0xf1..0xf9 => 100..900µs, 0xfa..0xff => reserviert - Integer

Rückgabewert

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
Return				int	Connection ID

ReadFrame¶

Liest die angegebene Frame ID (vorher InitFrame notwendig!)

Parameter

Name	Standardwert	Gültige Werte	Typ	Beschreibung
doDelete	False	[False, True]	bool	Löscht Frame nach dem Lesen wenn „True“
FrameId			int	Frame ID
isExtended	None	[False, True]	bool	Adressformat: True für 29 Bit, False für 11 Bit, None übernimmt die Einstellung „Modus“ aus der Testbenchkonfiguration

Rückgabewert

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
result				ByteStream	ByteStream

ReadFrameEx¶

Liest die angegebene Frame ID (vorher InitFrame notwendig!)

Parameter

Name	Standardwert	Gültige Werte	Typ	Beschreibung
doDelete	False	[False, True]	bool	Löscht Frame nach dem Lesen wenn „True“
FrameId			int	Frame ID
isExtended	None	[False, True]	bool	Adressformat: True für 29 Bit, False für 11 Bit, None übernimmt die Einstellung „Modus“ aus der Testbenchkonfiguration

Rückgabewert

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
result				object	CanFrame

RegisterFrameForInbox¶

Registriert ein Frame um in eine Inbox gestreamt zu werden.

Parameter

Name	Standardwert	Gültige Werte	Typ	Beschreibung
FrameId			int	Frame ID
Inbox			object	Bestehende Inbox
isExtended	None	[False, True]	bool	Adressformat: True für 29 Bit, False für 11 Bit, None übernimmt die Einstellung „Modus“ aus der Testbenchkonfiguration
saveAsCanFrame	False	[False, True]	bool	Wenn True wird das Frame als CanFrame-Objekt gespeichert, sonst als ByteStream

RegisterStreamForInbox¶

Registriert eine ISO-TP Session um in eine Inbox gestreamt zu werden.

Parameter

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
conId				int	Connection ID
inbox				object	Bestehende Inbox

ResetFirstValue¶

Löscht den ersten empfangenen Wert des angegebenen Signals

Parameter

Name	Typ	Beschreibung
FrameName	string	Frame-Name
NodeName	string	Name des Steuergeräts
SignalName	string	Signalname

SendFrame¶

Sendet eine Botschaft mit angegebener ID und Daten. Die Botschafts-ID muss vorher per Job „InitFrame“ registriert werden.

Parameter

Name	Standardwert	Gültige Werte	Typ	Beschreibung
DataByteStream			ByteStream	zu sendende Daten
FrameId			int	Frame ID
isExtended	None	[False, True]	bool	Adressformat: True für 29 Bit, False für 11 Bit, None übernimmt die Einstellung „Modus“ aus der Testbenchkonfiguration

SendFrameCyclic¶

Zyklisches Senden einer Botschaft mit angegebener ID und Daten. Die Botschafts-ID muss vorher per Job „InitFrame“ registriert werden.

Parameter

Name	Standardwert	Gültige Werte	Typ	Beschreibung
Count			int	Anzahl der Sendewiederholungen
DataByteStream			ByteStream	zu sendende Daten
FrameId			int	Frame ID
Interval			int	Zykluszeit in ms
isExtended	None	[False, True]	bool	Adressformat: True für 29 Bit, False für 11 Bit, None übernimmt die Einstellung „Modus“ aus der Testbenchkonfiguration

SendStream¶

Sende einen Datenstrom über ISO-TP.

Parameter

Name	Typ	Beschreibung
conId	int	Connection ID
data	object	Payload, der über ISO-TP gesendet werden soll
timeout	int	Timeout für das Senden der Nachricht in Millisekunden

SetFlowControlCTS¶

Aktiviert das Senden einer Flow Control „ContinueToSend“-Nachricht als Antwort auf eine segmentierte Anfrage. Außerdem können den internen Parametern BlockSize und SeparationTime neue Werte zugewiesen werden.

Parameter

Name	Typ	Beschreibung
BlockSize	int	Anzahl (0 - 255) der CAN-Botschaften (Consecutive Frames), die ohne zwischengeschaltete Flow Control Botschaft empfangen werden können - Integer Bei None wird die zuletzt gewählte Einstellung aus der Testkonfiguration, dem OpenDiagSession-Job oder einem vorherigen Aufruf von „SetFlowControlCTS“ beibehalten.
SeparationTime	int	Minimaler zeitlicher Abstand zwischen aufeinanderfolgenden Fragmenten 0x00..0x7F => 0..127ms, 0x80..0xf0 => reserviert, 0xf1..0xf9 => 100..900µs, 0xfa..0xff => reserviert - Integer Bei None wird die zuletzt gewählte Einstellung aus der Testkonfiguration, dem OpenDiagSession-Job oder einem vorherigen Aufruf von „SetFlowControlCTS“ beibehalten.
SessionId	object	Handle der Diagnosesitzung. Dieses kann entweder der in der TCF angegebene SUT Name oder ein durch den Job OpenDiagSession zurückgegebenes Handle sein. Wird None angegeben, wird automatisch der SUT Name verwendet.

SetFlowControlWait¶

Wenn ausgeführt, werden eingehende, segmentierte Botschaften, immer mit einer Flow Control „Wait“ Nachricht beantwortet. Beachte: Dadurch können keine segmentierten Botschaften mehr empfangen werden. Um dieses Verhalten zurückzusetzen, muss der Job SetFlowControlCTS ausgeführt werden.

Parameter

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
SessionId				object	Handle der Diagnosesitzung. Dieses kann entweder der in der TCF angegebene SUT Name oder ein durch den Job OpenDiagSession zurückgegebenes Handle sein. Wird None angegeben, wird automatisch der SUT Name verwendet.
WaitTimeInterval		0		int	Wartezeitintervall in ms. Bei einem Wert von 0 werden die Flow Control „Wait“-Nachrichten nur einmal als Antwort auf eine segmentierte Anfrage gesendet. Ist der Wert größer als 0, werden Flow Control „Wait“-Nachrichten in regelmäßigen Abständen mit dem angegebenen Intervall gesendet.

StartPlayback¶

Abspielen einer Aufnahme starten

Parameter

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
AscFile				uri	ASC-Datei

Rückgabewert

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
handle				int	Ein Handle, das zum Stoppen der Wiedergabe verwendet werden kann

StopPlayback¶

Laufendes Abspielen stoppen

Parameter

Name	Verfügbar wenn	Standardwert	Gültige Werte	Typ	Beschreibung
handle				int	Ein von StartPlayback erhaltenes Handle