API for Signal Recordings¶

class SignalRecordingApi¶

Returned by

PackageApi.SignalRecordingApi

CreateFormatDetailsStringASC(medium='AUTO', channel='ALL', direction='RxTx')¶

Creates the format details string for ASC files. The information are needed to filter the medium, a specific channel and the direction.

Parameters:

medium : str¶

The medium to be read: “AUTO” (default), “CAN”, “CANFD”, “FlexRay” or “LIN”.

If medium is “AUTO” the parser tries to guess the medium by reading the header of the ASC file. Only frames of the guessed medium will be read.

channel : str¶

The channel(s) to read. Possible values: “ALL” or “01” up to “99”.
For medium “FlexRay” values are typically: “ALL”, “01”  or “02”.
For medium “LIN” values are “ALL” or “1” up to “64”

direction : str¶

The communication direction: “Rx”, “Tx” or “RxTx”.

Returns:

The newly created format details string.

Return type:

str

CreateFormatDetailsStringBLF(medium='AUTO', channel='ALL', direction='RxTx', port='30490')¶

Creates the format details string for BLF files. The information are needed to filter the medium, a specific channel, the direction and the Ethernet port (if necessary).

Parameters:

medium : str¶

The medium to be read: “AUTO” (default), “CAN”, “FlexRay”, or “Ethernet”.

channel : str¶

The channel(s) to read. Possible values: “ALL” or “01” up to “99”.

For medium “FlexRay” values are typically: “ALL”, “01” or “02”.

direction : str¶

The communication direction: “Rx”, “Tx” or “RxTx”.

port : str¶

The Ethernet port for reading Ethernet signals. Only used if medium is ‘Ethernet’.

Returns:

The newly created format details string.

Return type:

str

CreateFormatDetailsStringCSV(columnSeparator=';', decimalSeparator='.', thousandSeparator=',', headLineNumber=0, timeColumn=0)¶

Creates a format string for CSV files.

Parameters:

columnSeparator : str¶: The column separator.
decimalSeparator : str¶: The decimal separator.
thousandSeparator : str¶: The thousand separator.
headLineNumber : int¶: The line number of the header with signal names.
timeColumn : int¶: The column number of the time column.

Returns:

The newly created format details string.

Return type:

str

CreateFormatDetailsStringMatControlDesk(platformToModelNames)¶

Creates the format details string for MAT files created by ControlDeskNG. The devices in the file are named like the platforms defined in ControlDeskNG. To address signals via model values a dictionary with a mapping of platform names to your model names (in ecu.test) can be specified.

Parameters:

platformToModelNames : dict[string, string]¶: Mapping of platform names to model names (in ecu.test).

Returns:

The newly created format details string.

Return type:

str

CreateFormatDetailsStringMdf4ControlDesk(platformToModelNames)¶

Creates the format details string for MDF4 files created by ControlDeskNG. The devices in the file are named like the platforms defined in ControlDeskNG. To address signals via model values a dictionary with a mapping of platform names to your model names (in ecu.test) can be specified.

Parameters:

platformToModelNames : dict[string, string]¶: Mapping of platform names to model names (in ecu.test).

Returns:

The newly created format details string.

Return type:

str

CreateFormatDetailsStringMdfControlDesk(platformToModelNames)¶

Creates the format details string for MDF files created by ControlDesk. The devices in the file are named like the platforms defined in ControlDesk. To address signals via model values a dictionary with a mapping of platform names to your model names (in ecu.test) can be specified.

Parameters:

platformToModelNames : dict[string, string]¶: Mapping of platform names to model names (in ecu.test).

Returns:

The newly created format details string.

Return type:

str

CreateFormatDetailsStringPcap(port='30490')¶

Creates the format details string for PCAP files. The information is needed to filter the Ethernet port.

Parameters:

port : str¶: The Ethernet port for reading Ethernet signals.

Returns:

The newly created format details string.

Return type:

str

CreateFormatDetailsStringSTI(sampleRate=50.0)¶

Creates the format details string for STI files. The information simple provides the sample rate to generate concrete samples.

Parameters:

sampleRate : float¶: The sample rate. Default is 50.0.

Returns:

The newly created format details string.

Return type:

str

CreateFormatDetailsStringTTL(medium='CAN', channel='01', direction='RxTx', captureDevice='ANY', port='30490', tap='0')¶

Creates the format details string for TTL files.

The information are needed to filter the medium, a specific channel and the direction. Please note that the recording name (“Analog”, “CAN”, “FlexRay”, “LIN”, “Ethernet”) must be specified for the recording info, too. There are no format details for “Analog” signals.

Parameters:

medium : str¶

The medium to be read: “CAN” (default), “FlexRay”, “LIN” or “Ethernet”.

channel : str¶

The channel(s) to read. Possible values if “CAN” should be read: “01” up
to “24” for the main logger and “01” up to “15” for TAP devices.
If “LIN” possible values are: “01” up to “12” for the main logger and
“01” up to “15” for TAP devices.
If “FlexRay” possible values are: “1A”, “1B”, “1AB”, … ,”3AB” for the
main logger and “1A”, “1B”, “2A” and “2B” for TAP devices.
If “Ethernet” possible values are: “A” and “B” for the main logger and
all combinations from “1” to “6” with “A” and “B”,
i.e. “1A”, “1B”, “2A”, …, “6A”, “6B”, for TAP devices.

direction : str¶

The communication direction: “Rx”, “Tx” or “RxTx”.

captureDevice : str¶

Not needed anymore.

port : str¶

Only for Ethernet: The port of the SOME/IP Service-Discovery (default: 30490)

tap : str¶

TAP number (0-7), also cascade device number. 0 is the main logger.

Returns:

The newly created format details string.

Return type:

str

CreateRecordingGroup(name='')¶

Creates a new recording group. If no name is given, a name will be generated if the recording group is added to signal group.

Parameters:

name : str¶: The name of the recording group. The name must be unique for all recording groups in a package!

Returns:

The newly created recording group

Return type:

RecordingGroup

CreateRecordingInfo(path, recordingName='', formatDetailsString=None, recordingNumber=0, startTime=None, stopTime=None)¶

Creates a recording info.

Parameters:

path : str¶

Path to the recording.

recordingName : str¶

Optional: The recording name in the file (mostly the device name).

formatDetailsString : str¶

Optional: The format details string with information to read the file. If the file exists it will be checked whether the given format details string is supported.

See also: CreateFormatDetailsStringXYZ().

recordingNumber : int¶

Optional: Number of the recording.

startTime : float¶

Optional: First time stamp to be read in from the recording.

stopTime : float¶

Optional: Last time stamp to be read in from the recording.

Returns:

The newly created recording info.

Return type:

RecordingInfo

CreateSignalGroup(name='', description='')¶

Creates a new signal group. If no name is given, a name will be generated if the signal group is added to a package.

Parameters:

name : str¶: The name of the signal group. The name must be unique for all signal groups in a package!
description : str¶: Description for the signal group

Returns:

The newly created signal group.

Return type:

SignalGroup