Port BUSACCESS - FLX¶

VECTOR-HW access to FLX

Stimulation¶

This port supports all features described in Stimulation control.

Properties 🛈¶

Name	Default value	Valid values	Type	Description
Channel number	‘1’		string	Selection of channel number if there is more than one controller of same type.
Do not stop RBS	☐		bool	Restbus simulation stays active beyond test case execution.
Keep TimeMaster active	☐		bool	DMCS-TimeMaster stays active after test cases have finished. Will be shutdown together with the configuration
Bus-DB			string
Placeholder value for automatic E2E calculation			int	Whenever this value is specified for an E2E signal (e.g. CRC), upon transmission ecu.test automatically replaces it with the correct, calculated value. The purpose of this option is to allow transmission of arbitrary fixed values (unequal to the value chosen here). Leaving this option empty completely disables the feature.For more information see the documentation at Tool categories - Automatic E2E calculation
Automatic start/stop	‘Test execution’	[‘Test execution’, ‘Configuration start/stop’, ‘Never’]	string	This option affects whether the FlexRay controller will be started and stopped automatically. If ‘Never’ is chosen, the controller must be started and stopped explicitly using the port Job ‘SwitchBusState’. Caution: all timestamps (e.g. in ASC traces) are relative to the time of the controller start.
Reinitialize on loss of bus synchronization	☑		bool	If this option is set, the FlexRay controller will automatically be reinitialized when it loses synchronization to the bus. Caution: if necessary, the reinitialization is performed even if the option ‘Automatic start/stop’ is set.
Listen only	☐		bool	Controller is running in passive mode. Writing is not possible
Logging of events	☐		bool	The Events SCE, SE and EE will be written to the ASC file during recording
Configuration mode	‘Bus database’	[‘Bus database’]	string	If there are several methods to configure this port, the one to be used can be chosen here. The mode ‘configuration file’ requires a path in the corresponding setting. The mode ‘bus database’ extracts the required information from the bus database.
TX ECU names ❲bus database❳			string	Comma-separated list of control units, for whose messages tx buffers shall be configured. Only needed in the configuration mode ‘bus database’.
Cold-start node ❲bus database❳	‘<auto>’	[‘<auto>’, ‘no cold-start node’, ‘cold-start node’]	string	Decides whether the node shall participate in the cluster start. The setting <auto> takes the configuration for the first configured TX ECU from the bus database. Only needed in configuration mode ‘bus database’.
Transmission confirmation	☐		bool	Activates acknowledged sending. Bus-Write test steps and Send tool jobs block until the message was successfully transferred on the bus or the confirm timeout expired.
Timeout for transmission confirmation	1000		int	Period in miliseconds in which a message has to be sent successfully. Otherwise an error is created. (must not be larger than 64535ms). Is only used in active confirm mode.
Null frames	☐		bool	Null frames will be logged only if ‘True’
Cold start behavior	‘Leader’	[‘Leader’, ‘Follower’, ‘Both’]	string	Behavior of the port during cold start. If the port is to be ‘Leader’ and ‘Follower’, the option ‘Both’ can be selected. In this case the Vector Advanced XL driver library must be installed.
Spy mode	☐		bool	In this mode no writing is possible. Instead of the complete FlexRay configuration, only the baud rate is needed.
Baudrate ❲only relevant for spy mode❳	‘10 Mbit/s’	[‘10 Mbit/s’, ‘5 Mbit/s’, ‘2.5 Mbit/s’]	string

Jobs 🛈¶

ClearFrame¶

Erases the receiving buffer of given frame

Parameter

Name	Default value	Valid values	Type	Description
Channel	‘A’	[‘A’, ‘B’, ‘*’]	string	FlexRay Channel (A, B or *)
CycleRepetition			int	Cycle repetition
SlotId			int	Frame ID
StartCycle			int	Start cycle

CloseFrTpSession¶

Closes the FrTP session.

Return value

Name	Available if	Default value	Valid values	Type	Description
return			[False, True]	bool	Session successfully closed

DeregisterFrameForInbox¶

Ungeristers a frame that is being streamed to an inbox

Parameter

Name	Default value	Valid values	Type	Description
Channel	‘A’	[‘A’, ‘B’, ‘*’]	string	FlexRay Channel (A, B or *)
CycleRepetition			int	Cycle repetition
Inbox			object	Existing inbox
SlotId			int	Frame ID
StartCycle			int	StartCycle (cycle offset)

DeregisterStreamForInbox¶

Deregisters a FrTp session.

Parameter

Name	Available if	Default value	Valid values	Type	Description
conId				int	Connection ID

DisableSendFrameCyclic¶

Deactivate cyclic transmission of a message with given id

Parameter

Name	Default value	Valid values	Type	Description
Channel	‘A’	[‘A’, ‘B’, ‘*’]	string	FlexRay Channel (A, B or *)
CycleRepetition			int	Cycle repetition
SlotId			int	Frame ID
StartCycle			int	Start cycle

GetFirstValue¶

Reads the first received value of the given signal

Parameter

Name	Default value	Valid values	Type	Description
FrameName			string	Frame name
NodeName			string	Name of the electronic control unit
RawValue	False	[False, True]	bool	If ‘True’, the Raw value is returned.
reset	False	[False, True]	bool	If ‘True’ the first received value will be deleted after it has been read
SignalName			string	Signal name

GracefulShutdown¶

Shut down the bus the stated number of cycles after the last transmission of the message identified by the parameters. The actual message may have a more frequent cycle configuration, in which case a transmission matching the specified parameters is chosen as the final one. Optionally, a different payload can be specified for the final transmission. Uses driver support for delayed shutdown if available.

Parameter

Name	Default value	Valid values	Type	Description
Channel	‘A’	[‘A’, ‘B’, ‘*’]	string	FlexRay Channel (A, B or *)
CycleRepetition			int	Cycle repetition
NCycles			int	Number of cycles
PayloadForFinalTransmission			ByteStream	Different payload for final transmission. If specified, the final transmission will use this payload. If not, the final transmission will use the payload it would have used if this job hadn’t been called.
SlotId			int	Frame ID
StartCycle			int	StartCycle (cycle offset)

InitFrame¶

Initializes the given frame

Parameter

Name	Default value	Valid values	Type	Description
Channel	‘A’	[‘A’, ‘B’, ‘*’]	string	FlexRay Channel (A, B or *)
CycleRepetition			int	Cycle repetition
DataLength			int	Length in words
SlotId			int	Frame ID
StartCycle			int	StartCycle (cycle offset)

OpenFrTpSession¶

Opens a FlexRay TP session.

Parameter

Name	Default value	Valid values	Type	Description
acknowledged	False	[False, True]	bool	The acknowledge bit (C_CT communication type) signals whether the sender requires a confirmation of receipt (acknowledged, STFA) or not (unacknowledged, STFU). - Integer
blockSize	0		int	Block size in bytes; maximum number of bytes that may be transmitted in the following consecutive frames before the sender has to wait for another flow control frame. - Integer
fillByte			ByteStream	Byte to fill messages (optional) - ByteStream of length 1
flowControlAddr	-1		int	Different address of the control unit (ECU) for FlowControl - Hex (optional Integer)
maxFrameLength	0		int	Maximum length of a frame in bytes (applies to both start, consecutive and last frames); if this value is set to 0, the maximum value described in ISO 10681-2 is used - Integer
mnpc	0		int	MNPC specifies how many consecutive frames the receiver can process within one FlexRay cycle. With MNPC set to 0 the sender can utilize the maximum possible band width. - Integer
requestBaseCycle			int	Cycle offset in the application cycle window - Integer < RequestCycleRepetition
requestCycleRepetition			int	Cycle count after which the frame is sent periodically based on BaseCycle - Integer >= 1
requestSlotId			int	Frame-ID for requests sent to the ECU - 1 or 2 byte Hex (integer)
responseBaseCycle			int	Cycle offset in the application cycle window - Integer < ResponseCycleRepetition
responseCycleRepetition			int	Cycle count after which the frame is received periodically based on BaseCycle - Integer >= 1
responseSlotId			int	Frame-ID for ECU responses - 1 or 2 byte Hex (integer)
scExp	0		int	SC defines the minimum distance in cycles until the sender is allowed to send the next consecutive frame. SC = 2^SCexp - 1 - Integer
sourceAddr			int	Address of the tester (ecu.test) - Hex (integer)
targetAddr			int	Address of the ECU - Hex (integer)

Return value

Name	Available if	Default value	Valid values	Type	Description
return				int	Connection ID

ReadFrame¶

Reads the given frame (use InitFrame before!)

Parameter

Name	Default value	Valid values	Type	Description
Channel	‘A’	[‘A’, ‘B’, ‘*’]	string	FlexRay Channel (A, B or *)
CycleRepetition			int	Cycle repetition
doDelete	False	[False, True]	bool	Deletes the Frame after reading if “True”
SlotId			int	Frame ID
StartCycle			int	StartCycle (cycle offset)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				ByteStream	ByteStream

ReadFrameEx¶

Reads the given frame (use InitFrame before!)

Parameter

Name	Default value	Valid values	Type	Description
Channel	‘A’	[‘A’, ‘B’, ‘*’]	string	FlexRay Channel (A, B or *)
CycleRepetition			int	Cycle repetition
doDelete	False	[False, True]	bool	Deletes the Frame after reading if “True”
SlotId			int	Frame ID
StartCycle			int	StartCycle (cycle offset)

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	FlexRayFrame

RegisterFrameForInbox¶

Registers a frame to be streamed to an inbox.

Parameter

Name	Default value	Valid values	Type	Description
Channel	‘A’	[‘A’, ‘B’, ‘*’]	string	FlexRay Channel (A, B or *)
CycleRepetition			int	Cycle repetition
Inbox			object	Existing inbox
saveAsFlxFrame	False	[False, True]	bool	If True, the frame is saved as a FlexRayFrame object, else as a ByteStream
SlotId			int	Frame ID
StartCycle			int	StartCycle (cycle offset)

RegisterStreamForInbox¶

Registers a FrTp session to be streamed to an inbox.

Parameter

Name	Available if	Default value	Valid values	Type	Description
conId				int	Connection ID
inbox				object	Existing inbox

ResetFirstValue¶

Erases the first received value of the given signal

Parameter

Name	Type	Description
FrameName	string	Frame name
NodeName	string	Name of the electronic control unit
SignalName	string	Signal name

SendFrame¶

Sends the given frame ID. Frame ID must be registered in advance via the job “InitFrame”.

Parameter

Name	Default value	Valid values	Type	Description
Channel	‘A’	[‘A’, ‘B’, ‘*’]	string	FlexRay Channel (A, B or *)
CycleRepetition			int	Cycle repetition
Data			ByteStream	data to be send
SlotId			int	Frame ID
StartCycle			int	Start cycle

SendFrameCyclic¶

Cyclic transmission of a message with given ID and data. Message ID must be registered in advance via the job “InitFrame”.

Parameter

Name	Default value	Valid values	Type	Description
Channel	‘A’	[‘A’, ‘B’, ‘*’]	string	FlexRay Channel (A, B or *)
Count			int	Number of sending repetitions
CycleRepetition			int	Cycle repetition
DataByteStream			ByteStream	data to be send
Interval			int	Cycle time in ms; 0 for every cycle
SlotId			int	Frame ID
StartCycle			int	Start cycle

SendStream¶

Send a data stream via FrTp.

Parameter

Name	Type	Description
conId	int	Connection ID
data	object	Payload to be sent via FrTp
timeout	int	Timeout for sending the message in milliseconds

SetFlowControlCTS¶

Activates to always send a Flow Control “ContinueToSend” message in response to a segmented request. Also new values can be assigned to the internal parameters BlockSize, MNPC and SCexp.

Parameter

Name	Type	Description
BlockSize	int	Block size in bytes; maximum number of bytes that may be transmitted in the following consecutive frames before the sender has to wait for another flow control frame. - Integer If None the most recent setting from the test configuration, the OpenDiagSession job or the previous SetFlowControlCTS call is kept.
MNPC	int	MNPC specifies how many consecutive frames the receiver can process within one FlexRay cycle. With MNPC set to 0 the sender can utilize the maximum possible band width. - Integer If None the most recent setting from the test configuration, the OpenDiagSession job or the previous SetFlowControlCTS call is kept.
SCexp	int	SC defines the minimum distance in cycles until the sender is allowed to send the next consecutive frame. SC = 2^SCexp - 1 - Integer If None the most recent setting from the test configuration, the OpenDiagSession job or the previous SetFlowControlCTS call is kept.
SessionId	object	Handle of the diagnostic session. This can be either the name of the SUT specified in the TCF, the handle returned by the OpenDiagSession job or None (can only be used if there is one SUT specified).

SetFlowControlWait¶

Activates to always send a Flow Control “Wait” messages in response to a segmented request. Note: While activated no segmented message can be received. Use the Job SetFlowControlCTS to reset this behaviour.

Parameter

Name	Available if	Default value	Valid values	Type	Description
SessionId				object	Handle of the diagnostic session. This can be either the name of the SUT specified in the TCF, the handle returned by the OpenDiagSession job or None (can only be used if there is one SUT specified).
WaitTimeInterval		0		int	Wait time interval in ms. If set to 0, Flow Control “Wait” messages are only sent once, to respond to a segmented request. If set to a value greater than 0, Flow Control “Wait” messages will be sent periodically with the given interval in between.

StartTimeSyncMaster¶

Starts the time synchronization as TimeMaster via FlexRay - A maximum of one TimeMaster should be active on a bus at all times

Parameter

Name	Default value	Valid values	Type	Description
BaseCycle	0		int	BaseCycle for the sync frames
Channel	‘A’	[‘A’, ‘B’, ‘AB’]	string	Channel for the sync frames
CycleRepetition	1		int	CycleRepetition for the sync frames
HwTimstampOffset	0		int	Offset in nanoseconds (positive or negative) that gets added to hardware timestamps
SequenceCounterFreeze	False	[False, True]	bool	Freeze the SequenceCounter
SequenceCounterInit	0		int	Start value of SequenceCounter
SlotID			int	Slot ID for the sync frames
SyncDataId			object	Data ID for SYNC messages for identification during CRC calculation (list with 16 integers)
SyncInterval	900000000		int	Interval in nanoseconds between two Sync frames
TimeDomain			int	Specifies the time domain which should be synchronized
UserByte0	0x00		int	Optional byte of user data
UserByte1	0x00		int	Optional byte of user data

StopTimeSyncMaster¶

Stoppt die Zeitsynchronisation als TimeMaster über FlexRay

SwitchBusState¶

Switches the FlexRay controller on or off.

Caution: switching the controller on will reset the ASC timestamps. Recording during the stop and start of the controller may result in an ASC file which violates the monotony of timestamps.

Parameter

Name	Available if	Default value	Valid values	Type	Description
State		‘Off’	[‘Off’, ‘On’]	string	New state of the bus

UpdateTimeSyncMaster¶

Will update the parameters if the TimeMaster is running.

Parameter

Name	Default value	Valid values	Type	Description
BaseCycle	0		int	BaseCycle for the sync frames
Channel	‘A’	[‘A’, ‘B’, ‘AB’]	string	Channel for the sync frames
CycleRepetition	1		int	CycleRepetition for the sync frames
HwTimstampOffset	0		int	Offset in nanoseconds (positive or negative) that gets added to hardware timestamps
SequenceCounterFreeze	False	[False, True]	bool	Freeze the SequenceCounter
SequenceCounterInit	0		int	Start value of SequenceCounter
SlotID			int	Slot ID for the sync frames
SyncDataId			object	Data ID for SYNC messages for identification during CRC calculation (list with 16 integers)
SyncInterval	900000000		int	Interval in nanoseconds between two Sync frames
TimeDomain			int	Specifies the time domain which should be synchronized
UserByte0	0x00		int	Optional byte of user data
UserByte1	0x00		int	Optional byte of user data