DataBrowser¶

A2lBrowser¶

class A2lBrowser¶

The A2lBrowser type provides an interface to a A2L database. It is possible to retrieve information for a single entry or to use a full text search to get a list of filtered entries. Every entity is represented by an instance of the type A2lEntity.

CalcPhysToRaw(label, physValue)¶

Returns the raw value of the provided physical value computed using the computation method defined for the provided label

Parameters:

label : str¶: The A2L label to select the computation method from
physValue : float¶: The numeric value to be converted to its raw representation

Returns:

raw value

Return type:

float

CalcRawToPhys(label, rawValue)¶

Returns the physical converted value of the provided raw value computed using the computation method defined for the provided label

Parameters:

label : str¶: The A2L label to select the computation method from
rawValue : float¶: The numeric value to be converted to its physical representation

Returns:

physical converted value

Return type:

float

GetA2lEntity(label)¶

Returns an instance of A2lEntity representing the entity with the specified label

Parameters:

label : str¶: The A2L label to retrieve an A2lEntity instance

Returns:

An A2lEntity instance if the A2L database contains an entry with the given name, otherwise None

Return type:

A2lEntity or None

GetAcquisitionRateNames()¶

Returns a list containing all acquisition rate names defined in the A2L database.

Returns:: A list of all acquisition rate names
Return type:: list <str>

GetCodeCheckInformation()¶

Query Code Check information from the A2L file.

Returns:: Code Check information as a dict, having the keys “software_revision_address” (int), “software_revision” (str), “code_check_internal_address” (int), “code_check_external_address” (int), “code_check_length” (int) and “code_check_pattern_wp” (int). The values of the dict will be None if the Code Check information could not be parsed from the A2L file.
Return type:: dict

GetEpkInformation()¶

Query information about the EPROM identifier (EPK) from the A2L file.

Returns:: EPK information as a dict, having the keys “address” (int) and “value” (str). The values of the dict will be None if the EPK information could not be parsed from the A2L file.
Return type:: dict

GetFunctionCharacteristics(name)¶

Returns the characteristics of the function with the given name

Parameters:

name : str¶: The name of the function to return the characteristics of

Returns:

The characteristics of the function

Return type:

list <str>

GetFunctionInMeasurements(name)¶

Returns the in measurements of the function with the given name

Parameters:

name : str¶: The name of the function to return the in measurementes of

Returns:

The in measurements of the function

Return type:

list <str>

GetFunctionLocMeasurements(name)¶

Returns the local measurements of the function with the given name

Parameters:

name : str¶: The name of the function to return the local measurementes of

Returns:

The local measurements of the function

Return type:

list <str>

GetFunctionNames()¶

Returns the names of all functions within the A2L

Returns:: The names of all functions
Return type:: list <str>

GetFunctionOutMeasurements(name)¶

Returns the out measurements of the function with the given name

Parameters:

name : str¶: The name of the function to return the out measurements of

Returns:

The out measurements of the function

Return type:

list <str>

GetFunctionVersion(name)¶

Returns the version of the function with the given name

Parameters:

name : str¶: The name of the function to return the version of

Returns:

The version of the function

Return type:

str

GetLabelNameList(filter='')¶

Returns a list which contains names of labels whose matches the specified label search string

Parameters:

filter : str¶: The search string which is part of an A2L label

Returns:

A list of names if the A2L database containsentries with the given search string, otherwise an empty list

Return type:

list<str>

GetSubFunctionNames(name)¶

Returns the names of all sub functions within the function with the given name

Parameters:

name : str¶: The name of the function to get the sub functions of

Returns:

The names of all sub functions

Return type:

list <str>

GetSystemConstantNameList()¶

Returns a list which contains names of system constants defined in the A2L

Returns:: A list of names
Return type:: list<str>

GetSystemConstantValue(constName)¶

Returns the value of the given system constant

Parameters:

constName : str¶: Name of system constant defined in A2L

Returns:

Value of system constant or None if name was not found

Return type:

str or None

HasFunction(name)¶

Checks if a function of the given name exists within the A2L file

Parameters:

name : str¶: The name to check if it is an existing function

Returns:

True if a function with the given name exist, otherwise False

Return type:

bool

HasSubFunctions(name)¶

Checks if a function of the given name within the A2L file has sub functions

Parameters:

name : str¶: The name of the function to check for sub functions

Returns:

True if the function of the given name has subfunctions, otherwise False

Return type:

bool

IsCharacteristic(label)¶

Checks if the given label name is a calibration variable

Parameters:

label : str¶: The A2L label to check for a calibration variable

Returns:

True if the given label is a calibration variable, otherwise False

Return type:

bool

IsMeasurement(label)¶

Checks if the given label name is a measurement variable

Parameters:

label : str¶: The A2L label to check for a measurement variable

Returns:

True if the given label is a measurement variable, otherwise False.

Return type:

bool

ReadDataFromHex(address, length)¶

Reads the given number of bytes from the Hex file at the given address.

Parameters:

address : int¶: start address of the bytes to read
length : int¶: number of bytes to read

Returns:

bytes at the given address - or a ByteStream filled with zeroes if the Hex file does not contain the specified range.

Return type:

ByteStream

A2lEntity¶

class A2lEntity¶

The A2lEntity type represents one entry in an A2L database

GetAddress()¶

Returns the address of this A2L entity

Returns:: Address as hex number
Return type:: str

GetByteOrder()¶

Returns the signals byte order

Returns:: ‘MSB_LAST’ or ‘MSB_FIRST’
Return type:: str

GetCoeffsDict()¶

Returns the coefficients of this A2L entity

Returns:

The coefficients stored in a dictionary where the key is the index and value is the value at this index
None if the coefficients are invalid

Return type:

dict<int: float> or None

GetCompuMethodName()¶

Returns the name of the compu method of this A2L entity like defined in the A2L database

Returns:: The compu methods name
Return type:: str

GetDataType()¶

Returns the dataype of this A2L entity

Returns:: The datatype
Return type:: str

GetDescription()¶

Returns the description of this A2L entity

Returns:: The description
Return type:: str

GetDisplayIdentifier()¶

Returns the display identifier of this A2L entity

Returns:: The display identifier
Return type:: str

GetLowerLimit()¶

Returns the lower limit of this A2L entity

Returns:: The lower limit
Return type:: str

GetMatrixDim()¶

Returns the matrix dimensions for calibration or measurement entities

Returns:

Dimensions tuple
None if no MATRIX_DIM is given in the A2L file

Return type:

tuple or None

GetName()¶

Returns the name of this A2L entity

Returns:: The name
Return type:: str

GetSize()¶

Returns the size of this A2L entity

Returns:

The size
None if it is a scalar

Return type:

int or None

GetUnit()¶

Returns the name of the unit of this A2L entity like defined in the A2L database

Returns:: The units name
Return type:: str

GetUpperLimit()¶

Returns the upper limit of this A2L entity

Returns:: The upper limit
Return type:: str

GetValueType()¶

Returns the internal data type representation of the current A2L entity

Returns:

Internal data type representation
None if the entity is of an unsupported type

Return type:

str or None

GetVtabDict()¶

Returns the V-TAB Dictionary

Returns:: V-TAB Dictionary
Return type:: dict

BusBrowser¶

class BusBrowser¶

The BusBrowser type provides an interface to a BUS database. It is possible to retrieve information for a single entry or to use a full text search to get a list of filtered entries. Every entity is represented by an instance of the type BusEntity.

Info

This part of the DataBrowser API was specifically created to support certain use cases. Don’t expect your use case to easily map onto this API!

GetFrameNamesByPDUName(pduName)¶

Returns a set of frame names the given PDU is bound to

Parameters:

pduName : str¶: The name of the PDU

Returns:

The frame names

Return type:

set<str>

GetLinScheduleTables()¶

Returns the LIN schedule tables as a dictionary, mapping the schedule table name to a sequence of triples (isFrameName, command, frameTime)

Returns:: LIN schedule tables
Return type:: dict<string, tuple<bool, string, float>>

GetSDGsAndSDs()¶

Returns a dictionary with all top level SDGs and their associated SDs.

Returns:: Dictionary with SDG names as keys and a list of their corresponding SDs as values (JSON).
Return type:: dict <str, dict<str, list<str>>>

ListFrames(filter='', useLongNames=False)¶

Returns a list of BusEntity instances corresponding to frames whose name matches the specified search string

Parameters:

filter : str¶: The search string which is part of a bus frame
useLongNames : bool¶: If True search in LongNames else (default) in ShortNames

Returns:

A list of BusEntity instances if the bus database contains entries with the given search string, otherwise an empty list

Return type:

list <BusEntities>

ListPDUs(frameName='', filter='', useLongNames=False)¶

Returns a list of BusEntity instances corresponding to PDUs whose name matches the specified search string

Parameters:

frameName : str¶: The exact short name of the frame in which to search for PDUs (optional)
filter : str¶: The search string which is part of a bus frame
useLongNames : bool¶: If True search in LongNames else (default) in ShortNames

Returns:

A list of BusEntity instances if the bus database contains entries with the given search string, otherwise an empty list

Return type:

list <BusEntities>

ListSignals(frameName='', filter='', useLongNames=False, includePseudoSignals=False)¶

Returns a list of BusEntity instances corresponding to signals whose name matches the specified search string

Parameters:

frameName : str¶: The exact name of the frame in which to search for signals
filter : str¶: The search string which is part of a bus signal
useLongNames : bool¶: If True search in LongNames else (default) in ShortNames
includePseudoSignals : bool¶: If True additionally list pseudo signals like _pduUpdateBit (default=False)

Returns:

A list of BusEntity instances if the bus database contains entries with the given search string, otherwise an empty list

Return type:

list <BusEntities>

ListSignalsByPDU(pduName, filter='', useLongNames=False, includePseudoSignals=False)¶

Returns a list of BusEntity instances corresponding to signals whose name matches the specified search string

Parameters:

pduName : str¶: The exact name of the PDU in which to search for signals
filter : str¶: The search string which is part of a bus signal
useLongNames : bool¶: If True search in LongNames else (default) in ShortNames
includePseudoSignals : bool¶: If True additionally list pseudo signals like _pduUpdateBit (default=False)

Returns:

A list of BusEntity instances if the bus database contains entries with the given search string, otherwise an empty list

Return type:

list <BusEntities>

BusEntity¶

class BusEntity¶

The BusEntity type represents one entry in a bus database

GetActivations()¶

Returns a list consisting of tuples with activation state, activation time and signal quality of the signal

Return type:: list <tuple <str, float, str>>

GetByteOrder()¶

Returns the signals byte order

Returns:

“Intel”
”Motorola”
”Default”
None

Return type:

str or None

GetCycleRepetition()¶

Returns the frames cycle repetition if this bus entity is a bus frame else None

Info

Only applies to FlexRay frames.

Returns:: Frame cycle repetition
Return type:: int or None

GetDebounceTime()¶

Returns the debounce time of a PDU or a frame else None

Returns:: Debounce time
Return type:: float or None

GetDescription()¶

Returns the description of this bus entity

Returns:: The description
Return type:: str

GetE2EProfile()¶

Returns the E2E profile of a PDU

Returns:: E2E profile
Return type:: dict

GetFrameLength()¶

Returns the length of the frame in bytes if this bus entity is a bus frame else None

Returns:: Length of frame in bytes
Return type:: int or None

GetFrameType()¶

Returns the frame type (DBC MsgType or ARXML CATEGORY) or None if this is not a frame.

Returns:: frame type
Return type:: str or None

GetId()¶

Returns the identifier of this bus entity

Info

This works only for BusEntities representing a bus frame.

Returns:: The identifier
Return type:: str

GetLinearCoeffs()¶

Returns the coefficients of the linear function y = slope * x + offset where the slope is also called physical resoution.

Returns:: (slope, offset)
Return type:: tuple(float / None, float / None) / None

GetLongName()¶

Returns the long name of this bus entity

Returns:: The long name
Return type:: str

GetMaxRawValue()¶

Returns the maximum raw value of the signal. Note that this value is not necessarily equal (but always greater or equal) to GetRawValue(GetMaxValue()) as the set of physical values usually not maps to all valid raw values.

Returns:: Maximum raw value
Return type:: float

GetMaxValue()¶

Returns the maximum physical value of the signal

Returns:: Maximum physical value
Return type:: float

GetMinRawValue()¶

Returns the minimum raw value of the signal. Note that this value is not necessarily equal (but always less or equal) to GetRawValue(GetMinValue()) as the set of physical values usually not maps to all valid raw values.

Returns:: Minimum raw value
Return type:: float

GetMinValue()¶

Returns the minimum physical value of the signal

Returns:: Minimum physical value
Return type:: float

GetMultiplexerSwitchCode()¶

Returns the switch code of this bus entity else None

Info

This works only for BusEntities representing a bus PDU or bus signal.

Returns:: The switch code if available
Return type:: str or None

GetName()¶

Returns the name (as used within ecu.test) of this bus entity

Returns:: The name
Return type:: str

GetOriginalName()¶

Returns the original name of this bus entity as specified in the bus database.

Info

This is different from GetName() in case ecu.test needs to add information to the name in order to make it unique.

Returns:: The original name
Return type:: str

GetPDULength()¶

Returns the byte length if this bus entity is a bus PDU

Returns:: The byte length
Return type:: int or None

GetPDUPosition()¶

Returns the absolute bit position if this bus entity is a bus PDU

Returns:: The absolute bit position
Return type:: int or None

GetPDUUpdateBit()¶

Returns the absolute bit position of the update bit if this bus entity is a bus PDU

Returns:: The absolute bit position
Return type:: int or None

GetPath()¶

Returns the variablepath of this bus entity

Returns:: The variablepath (e.g.: <busName>/<ecuName>/<frameName>/<pduName>/<signalName>)
Return type:: str

GetPhysValue(rawValue)¶

Returns the physical value of given raw value

Returns:: Physical value of given raw value
Return type:: float

GetRawValue(value)¶

Returns the raw value of given value

Info

Value can be text or physical value.

Returns:: The raw value
Return type:: int

GetRxEcuNames()¶

Returns the names of the ECUs which listen for this Frame/PDU

Returns:: The names of the ECUs
Return type:: list<str>

GetSecOcDataId()¶

Returns the SecOC Data ID of a PDU, if it is a secured PDU or inside a secured PDU, or None otherwise.

Returns:: SecOC Data ID
Return type:: int or None

GetSignalDataPositionInFrame()¶

Returns the signals data bit position relative to the frame

Returns:: The signals data bit position
Return type:: int or None
Raise:: ValueError if the Signal has no fixed position in the frame (e.g. container PDUs)

GetSignalDataPositionInPDU()¶

Returns the signals data bit position relative to the PDU

Returns:: The signals data bit position
Return type:: int or None

GetSignalLength()¶

Returns the length of the signal in bits if this bus entity is a bus signal else None

Returns:: The length of the signal in bits
Return type:: int or None

GetStartCycle()¶

Returns the frames start cycle if this bus entity is a bus frame else None

Info

Only applies to FlexRay frames.

Returns:: The frames start cycle
Return type:: int or None

GetSystemSignalName()¶

Returns the name of the system signal of this bus entity

Returns:: The name
Return type:: str

GetTextTable(numbersAsStrings=False)¶

Returns the text table as a dictionary

Info

Set numbersAsStrings to True when using this method via ApiProxy.

Returns:: The text table
Return type:: dict

GetTimeOffset(transmissionMode=None)¶

Returns the time offset of a PDU or a frame

Parameters:

transmissionMode=None¶: If None maximal time offset is returned. True/False refers to TRANSMISSION-MODE-TRUE/FALSE-TIMING (optional)

Return type:

float or None

GetTimings(transmissionMode=None)¶

Returns dtMin and dtMax for this Frame/PDU

Parameters:

transmissionMode=None¶: If None global Timings are returned. True/False refers to TRANSMISSION-MODE-TRUE/FALSE-TIMING (optional)

Returns:

Minimum and maximum timings (in seconds)

Return type:

(float, float) or (None, None)

GetTxEcuNames()¶

Returns the names of the ECUs which are capable of transmitting this Frame/PDU/Signal corresponding to the Bus access tab

Returns:: The names of the ECUs
Return type:: list<str>

GetUnit()¶

Returns the unit of a bus signal

Returns:: The unit
Returns:: str

IsFrame()¶

Checks if this bus entity is a bus frame

Returns:: True if this entity is a bus frame else False
Return type:: bool

IsMultiplexer()¶

Checks if this bus entity is multiplexed

Info

This works only for BusEntities representing a bus PDU or frame.

Returns:: True if this Item is a multiplexed PDU (DynamicPart) or a Frame containing multiplexed PDUs else False
Return type:: bool

IsNode()¶

Checks if this bus entity is a bus node

Returns:: True if this entity is a bus node else False
Return type:: bool

IsPDU()¶

Checks if this bus entity is a bus PDU

Returns:: True if this entity is a bus PDU else False
Return type:: bool

IsSend()¶

Returns true if the current signal is sent from its associated ECU

Return type:: bool

IsSignal()¶

Checks if this bus entity is a bus signal

Returns:: True if this entity is a bus signal else False
Return type:: bool

DebugBrowser¶

class DebugBrowser¶

The DebugBrowser type prodvides an interface to a Debugger database. It is possible to query for debug variables or register entries.

GetCores()¶

Returns names of all cores

Info

Cores are not supported by all debugger tool adapters

Returns:: A list of strings containing the core names found in the database.
Return type:: list<str>

GetElfFiles()¶

Returns dictionary with mapping from elfFileKey to ELF file path

Returns:: Dictionary with elfFileKey and corresponding ELF file path
Return type:: dict<str:str>

GetModules(elfFileKey)¶

Returns all modules of the ELF file referenced by the given elfFileKey

Parameters:

elfFileKey : str¶: elfFileKey with or without wildcard for filtering

Returns:

List of modules

Return type:

list<str>

GetRegisters(registerName=None, coreName=None)¶

Returns all registers by default

Info

Use optional parameters to filter registers. You can use * as wildcard.
Delivered registerName returns the full name, consisting of register Group and register name separated by underscore.
Registers are not supported by all debugger tool adapters.

Parameters:

registerName : str¶: Full register name (group_name) with or without wildcard for filtering
coreName : str¶: Core name with or without wildcard for filtering

Returns:

A list of dictionaries, each filled the registers full name, its cores name and the mapping path is retured for every entry

Return type:

list<dict>

GetVariables(variableName=None, visibility=None, moduleName=None, functionName=None, elfFileKey=None, includeExterns=False)¶

Returns all variables except extern variables by default

Info

Use optional parameters to filter variables. You can use * as wildcard.

Parameters:

variableName : str¶: Variable name with or without wildcard for filtering
visibility : int¶: Type 0 for local, 1 for global or 2 for extern variables to be returned
moduleName : str¶: Module name with or without wildcard for filtering
functionName : str¶: Function name with or without wildcard for filtering
elfFileKey : str¶: elfFileKey with or without wildcard for filtering
includeExterns : bool¶: Use True to include extern variables in the search

Returns:

A list of dictionaries with the following keys: name, moduleName, visibility, type, elfFileKey, mappingPath, functionName and arraySize

Return type:

list<dict>

DiagBrowser¶

class DiagBrowser¶

The DiagBrowser type provides an interface to a diagnostics data base. DiagBrowser functions are available for ODX-based diagnostics only and are not supported when using CDD or GDX, for example.

DecodeUdsResponse(ServiceName, UdsResponse)¶

Decode an UDS response into a python structure

Parameters:

ServiceName : str¶: Name of the service that should be decoded
UdsResponse¶: UDS Response

Returns:

Decoded Response

Return type:

dict

EncodeUdsRequest(ServiceName, RequestDict)¶

Encode a UDS request into a ByteStream

Parameters:

ServiceName : str¶: Name of the service that should be encoded
RequestDict : dict¶: Dictionary with request parameters

Returns:

Encoded Request

Return type:

ByteStream

GetDiagDtcs()¶

Returns a list of DTC entities representing all diagnostics DTCs defined in the database

Returns:: A list of DiagDtcEntity
Return type:: list<DiagDtcEntity>

GetDiagServices()¶

Returns a list of service entities representing all diagnostics services defined in the database

Returns:: A list of DiagServiceEntity
Return type:: list<DiagServiceEntity>

GetDiagStateCharts()¶

Returns a list of state chart entities representing all state charts defined in the database

Returns:: A list of DiagStateChartEntity
Return type:: list<DiagStateChartEntity>

DiagDtcEntity¶

class DiagDtcEntity¶

The DiagDtcEntity represents one diagnostics dtc in the database.

GetSdgs()¶

Returns the special data of the diagnostics DTC from the data base. The special data is a set of key/value pairs, and can be subdivided into groups (SDGs).

GetShortName()¶

Returns the name of this DTC

Returns:: The name of DTC
Return type:: str | None

GetTroubleCode()¶

Returns trouble code as integer

DiagServiceEntity¶

class DiagServiceEntity¶

The DiagServiceEntity represents one diagnostics service in the database.

GetDescription()¶

Returns the description of this service if the service is a ODXDiagService. Otherwise, it returns None.

Returns:: Description of the service
Return type:: Description | None

GetId()¶

Returns the DID or RID of this service. None if not present.

Returns:: DID or RID of this service
Return type:: int | None

GetLongName()¶

Returns the long name of this service

Returns:: The long name of service
Return type:: str | None

GetPreconditions()¶

Returns a list of the states which are defined as preconditions for this service in the diagnostics database

Returns:: A list of precondition states
Return type:: list[DiagStateEntity]

GetSdgs()¶

Returns the special data of the diagnostics service from the database. The special data is a set of key/value pairs and can be subdivided into groups.

Returns:: A dictionary containing the special data group SI attribute or caption short name as key. The value will be the SD key/value pairs as further dictionaries
Return type:: dict<str, dict<str, str>>

GetServiceId()¶

Returns the service ID of this service

Info

e.g. 34 for ReadDataByIdentifier

Returns:: The service ID
Return type:: int

GetServiceName()¶

Returns the name of the service. This Methode distinguishes between different application layers (e.g. UDS, KWP 2000)

Info

e.g. “Read Data By Identifier”

Returns:: service name or “Unknown Service”
Return type:: str

GetShortName()¶

Returns the short name of this service

Returns:: The short name of service
Return type:: str

GetSubfunction()¶

Returns the subfunction of this service or None if there is no subfunction.

Returns:: Subfunction of this service
Return type:: int | None

GetTransitions()¶

Returns a list of state transitions which will be performed if the service was successfully called

Returns:: A list of state transitions
Return type:: list<DiagStateTransitionEntity>

DiagStateChartEntity¶

class DiagStateChartEntity¶

The DiagStateChartEntity represents a state chart from the diagnostics database.

GetLongName()¶

Returns the long name of this state chart

Returns:: The long name
Return type:: str

GetSemantic()¶

Returns the semantic of this state chart

Returns:: The semantic
Return type:: str

GetShortName()¶

Returns the short name of this state chart

Returns:: The short name
Return type:: str

GetStartState()¶

Returns the start state of this state chart

Returns:: The start state
Return type:: DiagStateEntity

GetStateChartId()¶

Returns the ID of this state chart if it was defined in the diagnostics database

Returns:: The state chart ID
Return type:: str

GetStates()¶

Returns a list of all states inside this state chart

Returns:: A list of states
Return type:: list<DiagStateEntity>

GetTransitions()¶

Returns a list of all transitions inside this state chart

Returns:: A list of state transitions
Return type:: list<DiagStateTransitionEntity>

DiagStateEntity¶

class DiagStateEntity¶

The DiagStateEntity represents a state from the diagnostics database.

GetEndingTransitions()¶

Returns a list of state transitions which have this state as their target state

Returns:: A list of state transitions
Return type:: list[DiagStateTransitionEntity]

GetLongName()¶

Returns the long name of the state

Returns:: The long name of the state
Return type:: str | None

GetShortName()¶

Returns the short name of the state

Returns:: The short name of the state
Return type:: str

GetStartingTransitions()¶

Returns a list of state transitions which have this state as their source state

Returns:: A list of state transitions
Return type:: list[DiagStateTransitionEntity]

GetStateChart()¶

Returns the state chart this state belongs to

Returns:: The state chart
Return type:: DiagStateChartEntity

GetStateId()¶

Returns the ID of this state if it was specified in the diagnostics database

Returns:: The state ID
Return type:: str

DiagStateTransitionEntity¶

class DiagStateTransitionEntity¶

The DiagStateTransitionEntity represents a transition from one state to another as defined in the diagnostics data base.

GetLongName()¶

Returns the long name of this transition

Returns:: The long name
Return type:: str | None

GetServices()¶

Returns a list of all services which may trigger this transition

Returns:: A list of services
Return type:: list[DiagServiceEntity]

GetShortName()¶

Returns the short name of this transition

Returns:: The short name
Return type:: str | None

GetSourceState()¶

Returns the source state of this transition

Returns:: The state
Return type:: DiagStateEntity

GetStateChart()¶

Returns the state chart this transition belongs to

Returns:: The state chart
Return type:: DiagStateChartEntity

GetTargetState()¶

Returns the target state of this transition

Returns:: The state
Return type:: DiagStateEntity

GetTransitionId()¶

Returns the ID of this transition if it was specified in the diagnostics database

Returns:: The transition ID
Return type:: str

LoggingBrowser¶

class LoggingBrowser¶

The LoggingBrowser type provides an interface to a logging database. It is possible to retrieve information for a single entry or to use a full text search to get a list of filtered entries. Every entity is represented by an instance of the type LoggingEntity.

GetProtocol()¶

Returns the logging protocol configured for the ECU

Returns:: “DLT (non-verbose)” or “DLT (verbose)”
Return type:: str

ListArguments(messageName, filter='')¶

Returns a list of LoggingEntity instances corresponding to message arguments whose name matches the specified search string

Returns an empty list if the logging protocol is not “DLT (non-verbose)”.

Parameters:

messageName : str¶: The exact name of the message in which to search for arguments
filter : str¶: The search string which is part of a logging argument’s nam

Returns:

A list of LoggingEntity instances if the logging database contains entries with the given search string, otherwise an empty list

Return type:

list <LoggingEntity>

ListMessages(filter='')¶

Returns a list of LoggingEntity instances corresponding to messages whose name matches the specified search string

Parameters:

filter : str¶: The search string which is part of a logging message’s name

Returns:

A list of LoggingEntity instances if the logging database contains entries with the given search string, otherwise an empty list

Return type:

list <LoggingEntity>

LoggingEntity¶

class LoggingEntity¶

The LoggingEntity type represents one entry in a logging database.

GetArgumentLength()¶

Returns the length of the argument in bits if this logging entity is a logging argument of protocol “DLT (non-verbose)” else None

Returns:: The length of the argument
Return type:: int or None

GetArgumentPositionInMessage()¶

Returns the argument’s bit position relative to the message if this logging entity is a logging argument of protocol “DLT (non-verbose)” else None

Returns:: The argument’s bit position
Return type:: int or None

GetDescription()¶

Returns the description of this logging entity

Returns:: The description
Return type:: str

GetFilterDescription()¶

Returns the filter description if this logging message of protocol “DLT (verbose)”, otherwise None

Returns:: Dict with filter attribute name as key and filter value as value. The filter values are of type bool for flags, and type str for text values, IDs and regular expressions. Regular expressions are introduced with “RegEx: “. If an attribute is not filtered, its value is None.
Return type:: dict<str, str|bool> or None

GetId()¶

Returns the message identifier if this logging entity is a logging message else None

Returns:: The identifier
Return type:: str or None

GetMessageLength()¶

Returns the length of the message in bytes if this logging entity is a logging message of protocol “DLT (non-verbose)” else None

Returns:: The length of the message
Return type:: int or None

GetName()¶

Returns the name of this logging entity

Returns:: The name
Return type:: str

GetPath()¶

Returns the variablepath of this logging entity

Returns:: The variablepath (/<messageName>/<argumentName>/)
Return type:: str

GetPhysValue(rawValue)¶

Returns the physical value of given raw value

Info

Only valid for logging arguments of protocol “DLT (non-verbose)”

Returns:: The physical value of given raw value
Return type:: float

GetRawValue(value)¶

Returns the raw value of given value

Info

Value can be text or physical value. Only valid for logging arguments of protocol “DLT (non-verbose)”

Returns:: The raw value of given value
Return type:: int

GetTxEcuNames()¶

Returns the names of the ECUs which transmit this message/signal

Info

Only valid for protocol “DLT (non-verbose)”

Returns:: The names of the ECUs
Return type:: list<str>

IsArgument()¶

Checks if this logging entity is a logging argument

Returns:: True if this entity is a logging argument else False
Return type:: bool

IsMessage()¶

Checks if this logging entity is a logging message

Returns:: True if this entity is a logging message else False
Return type:: bool

MediaBrowser¶

class MediaBrowser¶

The MediaBrowser provides access to images and masks from the file system.

Images can be accessed via the Images property. E.g. mediaBrowser.Images.myImage. This will return an object of type Image.

Masks can be accessed via the Masks property. E.g. mediaBrowser.Masks.myMask. This will return an object of type Mask.

Example:

Suppose there is a file called “myImage.png” in the image directory that is associated with the media node “CAM”. Then you could access it with:

>>> api.DataBrowser.BrowseMultimedia("CAM").Images.myImage

ModelBrowser¶

class ModelBrowser¶

The ModelBrowser provides an interface to a model database. It is possible to search the available variable paths.

FindVariables(searchString, maxResults=None)¶

Find all variables in the model tree whose full model path matches the given search string. The search may include the wildcards ‘*’ and ‘?’. Only leaf elements of the model tree are returned. These are either parameters, signals or virtual signals of the model.

Parameters:

searchString : str¶: string for search
maxResults : int | None¶: maximal number of returned found items

Returns:

list of found model paths

Return type:

list <str>

ResolveVariableAlias(variablePath)¶

Resolves an alias variable to the underlying model variable path. If the variable is not an alias variable, the same path is returned

Parameters:

variablePath : str¶: variable path to be resolved, relative to the root node of the platform

Returns:

resolved variable path

Return type:

str

ServiceBrowser¶

class ServiceBrowser¶

The ServiceBrowser type provides an interface to a service database which allows to access information regarding ECUs, services, methods, events etc.

GetE2EProfile(ecuName, serviceName, methodOrEventName, eventgroupName=None, fieldName=None)¶

Returns the E2E profile configuration of an event or a field or a method

Info

A method may have different profiles for input and output parameters. Profiles 4 and 7 are currently supported.

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: The name of the service
methodOrEventName : str¶: The event or method name
eventgroupName : str or None¶: The name of the event group or None
fieldName : str or None¶: The name of the field or None

Return type:

dict

Info

The key is the extended name of the E2E input “in” or return “out” parameter. The values are E2E configuration parameters. The validity of each of the configuration parameters depends on the E2E profile. See the item “category”.

GetEcuConsumerInfos(providerEcuName, serviceName, eventGroupName=None)¶

Returns network infos of the consumer ECUs of the service (or event group), that is specified by a given providerEcuName, serviceName (and eventGroupName). Use only for ARXMLs of version AUTOSAR_00048 or higher. If the port is assigned dynamically at runtime, the key ‘Port’ will return ‘dynamic’.

Parameters:

providerEcuName : str¶: The name of the providing ECU
serviceName : str¶: The name of the service
eventGroupName : str | None¶: If set, the name of the provided event group

Returns:

Network infos ecuName, IP, TP=UDP|TCP, Port of consuming ECUs as list of dicts with the keys: ecuName, IP, TP (transport protocol = UDP|TCP), Port (<int>|’dynamic’)

Return type:

list <dict>

GetEcuConsumerNamesByServiceName(serviceName)¶

Returns the ECUs the given service is consumed by

Parameters:

serviceName : str¶: The name of the service

Returns:

The names of the events

Return type:

list <str>

GetEcuNamesByServiceName(serviceName)¶

Returns the ECUs the given service is provided by

Parameters:

serviceName : str¶: The name of the service

Returns:

The names of the ECUs

Return type:

list <str>

GetEcus()¶

Returns all ECU names

Returns:: The names of the ECUs
Return type:: list <str>

GetEventGroupInfos(ecuName, serviceName)¶

Returns name and ID of all event groups of a given service

Parameters:

ecuName : str¶: The Name of the ECU
serviceName : str¶: The name of the service

Returns:

List of tuples with name and ID of all event groups

Return type:

list <tuple <str, int> >

GetEventInfos(ecuName, serviceName, eventgroupName, fieldName=None)¶

Returns name and ID of all events of a given event group

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: The name of the service
eventgroupName : str¶: The name of the event group
fieldName : str or None¶: (Optional) The name of the field

Returns:

List of tuples with name and ID of all events

Return type:

list <tuple <str, int> >

GetFieldNamesByServiceName(ecuName, serviceName)¶

Returns field names of a given service

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: The name of the service

Returns:

The names of the fields

Return type:

list <str>

GetInputParameterRepresentation(ecuName, serviceName, methodOrEventName, eventgroupName=None, fieldName=None)¶

Returns a nested dict which contains the type definitions of all input values of an event, a field or a method.

Parameters:

ecuName : str¶: name of the ECU
serviceName : str¶: name of the service
methodOrEventName : str¶: event or method name
eventgroupName : str / None¶: name of the event group or None
fieldName : str / None¶: name of the field or None

Return type:

dict

GetInstanceID(ecuName, serviceName)¶

Returns the instance ID of a given service

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: The name of the service

Returns:

The instance ID

Return type:

str or None

GetMethodInfos(ecuName, serviceName, fieldName=None)¶

Returns name and ID of all methods of a given service

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: The name of the service
fieldName : str or None¶: (Optional) The name of the field

Returns:

List of tuples with name and ID of all methods

Return type:

list <tuple <str, int> >

GetOfferCyclicDelay(ecuName, serviceName)¶

Returns the delay between cyclic offers in seconds of a given service

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: The name of the service

Returns:

Cyclic offers in seconds

Return type:

float or None

GetReturnParameterRepresentation(ecuName, serviceName, methodOrEventName, eventgroupName=None, fieldName=None)¶

Returns a nested dict which contains the type definitions of all return values of an event, a field or a method.

Parameters:

ecuName : str¶: name of the ECU
serviceName : str¶: name of the service
methodOrEventName : str¶: event or method name
eventgroupName : str / None¶: name of the event group or None
fieldName : str / None¶: name of the field or None

Return type:

dict

GetSDGsAndSDs()¶

Returns a dictionary with all top level SDGs and their associated SDs.

Returns:: Dictionary with SDG names as keys and a list of their corresponding SDs as values (JSON).
Return type:: dict <str, list<str>>

GetServiceAdressInfos(ecuName, serviceName)¶

Returns all provider adress infos of a given service

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: The name of the service

Returns:

Dict with provider adress ‘IP’ and ‘TCP’ or ‘UDP’ source port

Return type:

<dict>

GetServiceID(ecuName, serviceName)¶

Returns the service ID of a given service

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: The name of the service

Returns:

The service ID

Return type:

str or None

GetServiceInfos(ecuName=None)¶

Returns name and ID of all provided services (of a given ECU)

Parameters:

ecuName : str or None¶: (Optional) Name of the ECU

Returns:

List of tuples with name and ID of services

Return type:

dict <tuple <str, int> >

GetTimings(ecuName, serviceName, methodName, eventgroupName=None, fieldName=None)¶

Returns timing information of a given event or method

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: The name of the service
methodName : str¶: The name of the method
eventgroupName : str or None¶: (Optional) The name of the event group
fieldName : str or None¶: (Optional) The name of the field

Returns:

Dict with keys ‘ApplicationCycleTime’, ‘DebounceTimeRange’, ‘RequestDebounceTimeRange’, ‘TpSeparationTime’ and their values

Return type:

dict

GetVersion(ecuName, serviceName)¶

Returns the minor and major version of a given service

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: The name of the service

Returns:

Tuple with the minor and major version

Return type:

tuple <int, int>

GetVlanInfo(ecuName, serviceName)¶

Returns the VLAN ID and the default priority of a given service

Parameters:

ecuName : str¶: The name of the ECU
serviceName : str¶: nThe name of the service

Returns:

VLAN ID and the default priority

Return type:

tuple(int, int)

SgbdBrowser¶

class SgbdBrowser¶

The SgbdBrowser type provides an interface to a SGBD file. It is possible to retrieve information for a single entry or to use a full text search to get a list of filtered entries. Every entity is represented by an instance of the type SgbdEntity.

Info

prototype

GetJob(jobName)¶

Returns the SgbdEntity of a Job if it exists in selected SGBD or None if does not

Parameters:

jobName : str¶: Name of job to get

Returns:

SgbdEntity for the first matching job or None

Return type:

SgbdEntity or None

GetListTableNames()¶

Returns a list which contains all SGBD table names

Returns:: A list with all SGBD table names
Return type:: list <str>

IsJob(jobName)¶

Returns True if Job exists in selected SGBD or False if not

Parameters:

jobName : str¶: The name of job to be checked

Returns:

True if Job exists or False if not

Return type:

bool

ListJobs(filter='')¶

Returns a list which contains instances of SgbdEntity whose matches the specified job search string

Parameters:

filter : str¶: The search string which is part of a job

Returns:

A list of SgbdEntity instances if the SGBD file contains entries with the given search string, otherwise an empty list

Return type:

list <SgbdEntity>

Info

prototype

QueryTableByArgument(job=None, argument=None)¶

Returns a dictionary representing a specific argument table of the given job

Parameters:

job : str¶: The name of the job
argument : str¶: The name of the argument

Returns:

A dictionary representing the columns of the argument table

Return type:

dict

QueryTableByName(tableName=None)¶

Returns the SGBD table indicated by the given name

Parameters:

tableName : str¶: The name of a SGBD table

Returns:

A dictionary representing the columns of the SGBD table

Return type:

dict

QueryTableByResult(job=None, result=None)¶

Returns a dictionary representing a specific result table of the given job

Parameters:

job : str¶: The name of the job
result : str¶: The name of the result

Returns:

A dictionary representing the columns of the result table

Return type:

dict

SgbdEntity¶

class SgbdEntity¶

The SgbdEntity type represents one entry in a SGBD file.

Info

prototype

GetArgumentType(argumentName)¶

Returns the argument type of this SGBD entity argument name

Parameters:

argumentName : str¶: The argument name

Returns:

The argument type

Return type:

str

GetArguments()¶

Returns the arguments of this SGBD entity

Returns:: The arguments
Return type:: list <str>

Info

prototype

GetDescription()¶

Returns the description of this SGBD entity

Returns:: The description
Return type:: str

Info

prototype

GetName()¶

Returns the name of this SGBD entity

Returns:: The name
Return type:: str

Info

prototype

GetResultType(resultName)¶

Returns the result type of this SGBD entity result name

Parameters:

resultName : str¶: The result name

Returns:

The result type

Return type:

str

GetResults()¶

Returns the results of this SGBD entity

Returns:: The results
Return type:: list <str>

Info

prototype