Port BUSACCESS - CAN-FD

BluePiraT access to CAN-FD

Stimulation

This port supports all features described in Stimulation control.

Name

Available if

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

ClearFrame

Erases the receiving buffer of given frame

Parameterization

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

DeregisterFrameForInbox

Deregisters a frame that is streamed to the inbox

Parameterization

Parameter

Name

Available if

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

GetFirstValue

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

Parameterization

Parameter

Name

Available if

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

GetLastReceptionTimestamp

Get the last reception timestamp in seconds

InitFrame

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

Parameterization

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

ReadFrame

Reads the given frame ID (use InitFrame before!)

Parameterization

Parameter

Name

Available if

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

ReadFrameEx

Reads the given frame ID (use InitFrame before!)

Parameterization

Parameter

Name

Available if

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

RegisterFrameForInbox

Registers a frame to be streamed to an inbox.

Parameterization

Parameter

Name

Available if

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

ResetFirstValue

Erases the first received value of the given signal

Parameterization

Parameter

Name

Available if

Default value

Valid values

Type

Description

FrameName

string

Frame name

NodeName

string

Name of the electronic control unit

SignalName

string

Signal name