Port BUSACCESS - CAN¶

BluePiraT access to CAN

Stimulation¶

This port supports all features described in Stimulation control.

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

Erases the receiving buffer of given frame

Parameter

Name	Available if	Default value	Valid values	Type	Description
FrameId				int	Frame ID
isExtended		None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration

Return value

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

Deregisters a frame that is streamed to the inbox

Parameter

Name	Default value	Valid values	Type	Description
FrameId			int	Frame ID
Inbox			object	Existing inbox
isExtended	None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration

Returns the first value of the signal received since the test case started.

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

Get the last reception timestamp in seconds

Registers the message ID for later use, e.g. ReadFrame

Parameter

Name	Available if	Default value	Valid values	Type	Description
FrameId				int	Frame ID
isExtended		None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration

Reads the given frame ID (use InitFrame before!)

Parameter

Name	Default value	Valid values	Type	Description
doDelete	False	[False, True]	bool	Deletes the Frame after reading if “True”
FrameId			int	Frame ID
isExtended	None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration

Return value

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

Reads the given frame ID (use InitFrame before!)

Parameter

Name	Default value	Valid values	Type	Description
doDelete	False	[False, True]	bool	Deletes the Frame after reading if “True”
FrameId			int	Frame ID
isExtended	None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration

Return value

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

Registers a frame to be streamed to an inbox.

Parameter

Name	Default value	Valid values	Type	Description
FrameId			int	Frame ID
Inbox			object	Existing inbox
isExtended	None	[False, True]	bool	Address format: True for 29 bit, False for 11 bit, None uses the setting “Mode” from the test bench configuration
saveAsCanFrame	False	[False, True]	bool	If True, the frame is saved as a CanFrame object, else as a ByteStream

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