Port BUSACCESS - FLX¶

BluePiraT 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.
Bus-DB			string
Export format		[ONLINE]	string	Save signal recordings in this format

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

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)

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

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)

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)

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

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.

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