Bap Module

class mtf.libs.mtf_pybinder.bap.BAPASG

BAP ASG class

__init__(*args, **kwargs)

__new__(**kwargs)

async_request(self: mtf.libs.mtf_pybinder.bap.BAPASG, fct_id_or_name: int | str, op_code: mtf.libs.mtf_pybinder.bap.BAPOpCode, payload: list[int], with_retries: bool = True) → mtf.libs.mtf_pybinder.bap.BAPResult

Make an asynchronous request.

Args:

fct_id_or_name (str|int): Function ID or name. op_code (int): Operation code. payload (list[int]): The data payload for the request, consisting of unsigned 8-bit integers. with_retries (bool): Whether to retry on failure.

Return:

BAPResult: The result of the operation.

cancel_ongoing_async_requests(self: mtf.libs.mtf_pybinder.bap.BAPASG) → None

Cancel all ongoing asynchronous requests.

property config

enable_debug(self: mtf.libs.mtf_pybinder.bap.BAPASG, on_off: bool = True) → bool

Enable or disable debug mode.

Args:

on_off (bool): True to enable, False to disable.

Return:

bool: True if the operation has successed, otherwise False.

get_available_functions(self: mtf.libs.mtf_pybinder.bap.BAPASG) → set[int]

Get all available functions.

Return:

list[int]: List of available functions ids.

get_communication_channels(self: mtf.libs.mtf_pybinder.bap.BAPASG) → set[str]

Get all communication channels.

Return:

Set[str]: List of communication channels names.

get_function_config(self: mtf.libs.mtf_pybinder.bap.BAPASG, fct_id_or_name: int | str) → mtf.libs.mtf_pybinder.bap.BAPFunctionConfig

Get the configuration of a specific function.

Args:

fct_id_or_name (str|int): Function ID or name.

Return:

BAPFunctionConfig: The configuration of the specified function.

property heartbeat_factor

property id

property listener

property name

property observer

request_unchecked(self: mtf.libs.mtf_pybinder.bap.BAPASG, fct_id_or_name: int | str, op_code: mtf.libs.mtf_pybinder.bap.BAPOpCode, payload: list[int]) → mtf.libs.mtf_pybinder.bap.BAPResult

Make an unchecked request. No checks for payload length and op_code.

Args:

fct_id_or_name (str|int): Function ID or name. op_code (BAPOpCode): Operation code. payload (list[int]): The data payload for the request, consisting of unsigned 8-bit integers.

Return:

BAPResult: The result of the operation.

start(self: mtf.libs.mtf_pybinder.bap.BAPASG) → bool

Start the ASG simulation.

Return:

bool: True if the operation has successed, otherwise False.

stop(self: mtf.libs.mtf_pybinder.bap.BAPASG) → bool

Stop the ASG simulation.

Return:

bool: True if the operation has successed, otherwise False.

class mtf.libs.mtf_pybinder.bap.BAPBALError

BAL error information

Members:

GET_ALL_CORRUPTED

INVALID_STATE

CACHE_INVALID

CACHE_NOT_AVAILABLE

INVALID_ARGUMENT

INCOMPATIBLE_PROTOCOL_VERSION

INCOMPATIBLE_DATA_SPECIFICATION

CACHE_INVALID

CACHE_NOT_AVAILABLE

GET_ALL_CORRUPTED

INCOMPATIBLE_DATA_SPECIFICATION

INCOMPATIBLE_PROTOCOL_VERSION

INVALID_ARGUMENT

INVALID_STATE

__init__(self: mtf.libs.mtf_pybinder.bap.BAPBALError, value: int) → None

__new__(**kwargs)

property name

property value

class mtf.libs.mtf_pybinder.bap.BAPBALEvent

BAL event information

Members:

GET_ALL_RECEIVED_FCU_ONLY

MESSAGE_REPORTED

GET_ALL_RECEIVED_FCU_ONLY

MESSAGE_REPORTED

__init__(self: mtf.libs.mtf_pybinder.bap.BAPBALEvent, value: int) → None

__new__(**kwargs)

property name

property value

class mtf.libs.mtf_pybinder.bap.BAPBALTraceInfo

BAL debug data.

__init__(self: mtf.libs.mtf_pybinder.bap.BAPBALTraceInfo) → None

__new__(**kwargs)

property errors

Set of the BAL errors information.

property events

Set of the BAL events information.

property is_valid_cache

Condition of cache in BAL is valid (only ASG).

property status

Status of BAL.

class mtf.libs.mtf_pybinder.bap.BAPBCLError

BCL error information

Members:

BAD_DATA_LENGTH

RECEIVED_DATA_LOST

TIMEOUT_SEGMENTATION

OVERSIZE_SEGMENTATION

ILLEGAL_SEQUENCE

BAD_DATA_LENGTH

ILLEGAL_SEQUENCE

OVERSIZE_SEGMENTATION

RECEIVED_DATA_LOST

TIMEOUT_SEGMENTATION

__init__(self: mtf.libs.mtf_pybinder.bap.BAPBCLError, value: int) → None

__new__(**kwargs)

property name

property value

class mtf.libs.mtf_pybinder.bap.BAPBCLEvent

BCL event information

Members:

START_MSG_OF_SEGMENTED_MSG_SENT

INITIAL_MSG_OF_SEGMENTED_MSG_RECEIVED

SENDING_OF_SEGMENTED_MSG_COMPLETED

SEGMENTED_MSG_RECEIVED_IN_FULL

ERRONEOUS_MSG_RECEIVED_AND_DISCARDED

MSG_TRANSFERRED_TO_THE_LAYER_BELOW_BCL

LAYER_UNDERNEATH_BCL_TRANSFERRED_MSG_TO_BCL

ERRONEOUS_MSG_RECEIVED_AND_DISCARDED

INITIAL_MSG_OF_SEGMENTED_MSG_RECEIVED

LAYER_UNDERNEATH_BCL_TRANSFERRED_MSG_TO_BCL

MSG_TRANSFERRED_TO_THE_LAYER_BELOW_BCL

SEGMENTED_MSG_RECEIVED_IN_FULL

SENDING_OF_SEGMENTED_MSG_COMPLETED

START_MSG_OF_SEGMENTED_MSG_SENT

__init__(self: mtf.libs.mtf_pybinder.bap.BAPBCLEvent, value: int) → None

__new__(**kwargs)

property name

property value

class mtf.libs.mtf_pybinder.bap.BAPBCLTraceInfo

BCL debug data.

__init__(self: mtf.libs.mtf_pybinder.bap.BAPBCLTraceInfo) → None

__new__(**kwargs)

property errors

Set of the BCL errors information.

property events

Set of the BCL events information.

class mtf.libs.mtf_pybinder.bap.BAPBPLError

BPL error information

Members:

REQUEST_TIMEOUT

RETRY_TIMEOUT

HEARTBEAT_TIMEOUT

BUSY

BUSY

HEARTBEAT_TIMEOUT

REQUEST_TIMEOUT

RETRY_TIMEOUT

__init__(self: mtf.libs.mtf_pybinder.bap.BAPBPLError, value: int) → None

__new__(**kwargs)

property name

property value

class mtf.libs.mtf_pybinder.bap.BAPBPLEvent

BPL event information

Members:

ONE_HEARTBEAT_CYCLE_COMPLETED

HEARTBEAT_MSG_SENT_OR_RECEIVED

REQUEST_RETRY_MONITORING_ACTIVATED

T_RETRY_EXPIRATION_AND_REQUEST_REPEATED

RETRY_MONITORING_AFTER_MATCHING_OPCODE_DEACTIVATED

T_RETRY_RESTARTED

T_RETRYSTOPPED

HEARTBEAT_MSG_SENT_OR_RECEIVED

ONE_HEARTBEAT_CYCLE_COMPLETED

REQUEST_RETRY_MONITORING_ACTIVATED

RETRY_MONITORING_AFTER_MATCHING_OPCODE_DEACTIVATED

T_RETRYSTOPPED

T_RETRY_EXPIRATION_AND_REQUEST_REPEATED

T_RETRY_RESTARTED

__init__(self: mtf.libs.mtf_pybinder.bap.BAPBPLEvent, value: int) → None

__new__(**kwargs)

property name

property value

class mtf.libs.mtf_pybinder.bap.BAPBPLTraceInfo

BPL debug data.

__init__(self: mtf.libs.mtf_pybinder.bap.BAPBPLTraceInfo) → None

__new__(**kwargs)

property errors

Set of the BPL errors information.

property events

Set of the BPL events information.

property is_heartbeat_sent_or_running

Condition of BPL Heartbeat mechanism. FSG: Heartbeats are being sent, ASG: Heartbeat monitoring is running.

class mtf.libs.mtf_pybinder.bap.BAPDataDefinitionVersion

BAP data definition version class

__init__(*args, **kwargs)

__new__(**kwargs)

property major

property minor

class mtf.libs.mtf_pybinder.bap.BAPDebugData

BAP debug data.

__init__(self: mtf.libs.mtf_pybinder.bap.BAPDebugData) → None

__new__(**kwargs)

property bal_data

BAL debug data.

property bcl_data

BCL debug data.

property bpl_data

BPL debug data.

property fct_id

Function identifier.

static from_payload(payload: list[int], is_extended_lsg_id: bool = True) → mtf.libs.mtf_pybinder.bap.BAPDebugData

Get the dissected debug data from the given payload.

Args:

payload (list[int]): The payload to be dissected to get all the debug data. is_extended_lsg_id (bool, optional): Indicates if LSG-ID > 63 or LSG-ID < 64. Default is true, meaning LSG_ID > 63.

Return:

BapDebugData: the instance of BapDebugData.

property lsg_id

Logical control module identifier.

property op_code

operation code.

class mtf.libs.mtf_pybinder.bap.BAPEvent

BAP network event class

__init__(self: mtf.libs.mtf_pybinder.bap.BAPEvent) → None

__new__(**kwargs)

property fct_id

property lsg_id

property op_code

property payload

property timestamp

class mtf.libs.mtf_pybinder.bap.BAPFSG

BAP FSG class

__init__(*args, **kwargs)

__new__(**kwargs)

property config

deactivate_property_auto_response(self: mtf.libs.mtf_pybinder.bap.BAPFSG, fct_id_or_name: int | str | None = None) → mtf.libs.mtf_pybinder.bap.BAPResult

Deactivate the responses to ASG requests.

Args:

fct_id_or_name (str|int, optional): Function ID or name.

Return:

BAPResult: The result of the operation.

enable_debug(self: mtf.libs.mtf_pybinder.bap.BAPFSG, on_off: bool = True) → bool

Enable or disable debug mode.

Args:

on_off (bool): True to enable, False to disable.

Return:

bool: True if the operation has successed, otherwise False.

get_available_functions(self: mtf.libs.mtf_pybinder.bap.BAPFSG) → set[int]

Get all available functions.

Return:

list[int]: List of available functions ids.

get_communication_channels(self: mtf.libs.mtf_pybinder.bap.BAPFSG) → set[str]

Get all communication channels.

Return:

Set[str]: List of communication channels names.

get_function_config(self: mtf.libs.mtf_pybinder.bap.BAPFSG, fct_id_or_name: int | str) → mtf.libs.mtf_pybinder.bap.BAPFunctionConfig

Get the configuration of a specific function.

Args:

fct_id_or_name (str|int): Function ID or name.

Return:

BAPFunctionConfig: The configuration of the specified function.

property heartbeat_time

property id

property listener

property name

property observer

reactivate_property_auto_response(self: mtf.libs.mtf_pybinder.bap.BAPFSG, fct_id_or_name: int | str | None = None) → bool

Reactivate the auto-response for a property.

Args:

fct_id_or_name (str|int, optional): Function ID or name.

Return:

bool: True if the operation was successfull, otherwise False.

restart_heartbeat_mechanism(self: mtf.libs.mtf_pybinder.bap.BAPFSG) → bool

Restart the heartbeat mechanism.

Return:

bool: True if the operation was successfull, otherwise False.

start(self: mtf.libs.mtf_pybinder.bap.BAPFSG, startup_config: mtf.libs.mtf_pybinder.bap.BAPFSGStartupConfig) → bool

Start the FSG simulation with the given startup configuration.

Args:

startup_config (BAPFSGStartupConfig): Configuration for startup.

Return:

bool: True if the operation was successfull, otherwise False.

stop(self: mtf.libs.mtf_pybinder.bap.BAPFSG) → bool

Stop the FSG simulation.

Return:

bool: True if the operation was successfull, otherwise False.

stop_heartbeat_mechanism(self: mtf.libs.mtf_pybinder.bap.BAPFSG) → bool

Stop the heartbeat mechanism.

Return:

bool: True if the operation was successfull, otherwise False.

transmit(self: mtf.libs.mtf_pybinder.bap.BAPFSG, fct_id_or_name: int | str, op_code: mtf.libs.mtf_pybinder.bap.BAPOpCode, payload: list[int] = []) → mtf.libs.mtf_pybinder.bap.BAPResult

Transmit FSG message with the given parameters.

Note: In case of Property, it is better to use update_payload method.

Args:

fct_id_or_name (str|int): Function ID or name. op_code (BAPOpCode): Operation code. payload (list[int]): The data payload, consisting of unsigned 8-bit integers.

Return:

BAPResult: The result of the operation.

transmit_unchecked(self: mtf.libs.mtf_pybinder.bap.BAPFSG, fct_id_or_name: int | str, op_code: mtf.libs.mtf_pybinder.bap.BAPOpCode, payload: list[int] = []) → mtf.libs.mtf_pybinder.bap.BAPResult

Transmit FSG message with the given parameters. No checks for payload length and op_code.

Args:

fct_id_or_name (str|int): Function ID or name. op_code (int): Operation code. payload (list[int]): The data payload, consisting of unsigned 8-bit integers.

Return:

BAPResult: The result of the operation.

update_payload(self: mtf.libs.mtf_pybinder.bap.BAPFSG, fct_id_or_name: int | str, payload: list[int]) → mtf.libs.mtf_pybinder.bap.BAPResult

Update the payload of a property function. It will retrigger the heartbeat mechanism and send the function with STATUS OpCode.

Args:

fct_id_or_name (str|int): Function ID or name. payload (list[int]): The new payload data, consisting of unsigned 8-bit integers.

Return:

BAPResult: The result of the operation.

class mtf.libs.mtf_pybinder.bap.BAPFSGStartupConfig

BAP FSG startup config class

__init__(self: mtf.libs.mtf_pybinder.bap.BAPFSGStartupConfig) → None

__new__(**kwargs)

property function_list

Optional subset of functions to activate. Defaults all activated.

property send_bap_config_reset

Whether to send config reset or not. Defaults True.

property start_heartbeat_mechanism

Whether to start heartbeat mechanism or not. Defaults True.

property use_statusall_to_reply_to_getall

Whether to reply with status_all to get_all or not. Defaults True.

class mtf.libs.mtf_pybinder.bap.BAPFunctionClass

Members:

ARRAY

CACHE

METHOD

PROPERTY

ARRAY

CACHE

METHOD

PROPERTY

__init__(self: mtf.libs.mtf_pybinder.bap.BAPFunctionClass, value: int) → None

__new__(**kwargs)

property name

property value

class mtf.libs.mtf_pybinder.bap.BAPFunctionConfig

BAP Function Config class

__init__(*args, **kwargs)

__new__(**kwargs)

property fct_class

get_length(self: mtf.libs.mtf_pybinder.bap.BAPFunctionConfig, tx_direction: bool = True) → int

Get the length of the function payload.

Args:

tx_direction (bool, optional): Indicates if the function will be transmitted (True) or received (False). Default is True.

Return:

int: The length of the function payload.

get_pdu_names(self: mtf.libs.mtf_pybinder.bap.BAPFunctionConfig, tx_direction: bool = True) → set[str]

Get Pdu names of the function.

Args:

tx_direction (bool, optional): Indicates if the function will be transmitted (True) or received (False). Default is True.

Return:

Set[str]: The set of the Pdu names.

has_op_code(self: mtf.libs.mtf_pybinder.bap.BAPFunctionConfig, op_code: mtf.libs.mtf_pybinder.bap.BAPOpCode, tx_direction: bool = True) → bool

Check if the function has a specific operation code.

Args:

op_code (BAPOpCode): The operation code to check. tx_direction (bool, optional): Indicates if the function will be transmitted (true) or received (false). Default is true.

Return:

bool: True if the operation code exists, otherwise False.

property heart_beat_on

property id

property max_retry_counter

property name

property processing_or_retry_timer

class mtf.libs.mtf_pybinder.bap.BAPLSGConfig

BAP LSG Config class

__init__(*args, **kwargs)

__new__(**kwargs)

property data_def_version

property lsg_class

property lsg_subclass

property protocol_version

class mtf.libs.mtf_pybinder.bap.BAPLSGListener

Listener on BAP PDUs for a specific LSG.

__init__(*args, **kwargs)

__new__(**kwargs)

get_history(self: mtf.libs.mtf_pybinder.bap.BAPLSGListener) → list[mtf.libs.mtf_pybinder.bap.BAPEvent]

Get and clear all captured events since start listening.

Return:

List[BAPEvent]: List of captured BAP events.

start_listening(self: mtf.libs.mtf_pybinder.bap.BAPLSGListener, callback: Callable[[mtf.libs.mtf_pybinder.bap.BAPEvent], None] | None = None) → bool

Start the data acquisition.

Args:

callback (function, optional): A callback function to handle incoming events.

Return:

bool: True if the listener has started successfully, otherwise False.

stop_listening(self: mtf.libs.mtf_pybinder.bap.BAPLSGListener) → bool

Stop the data acquisition.

Return:

bool: True if the listener has stopped successfully, otherwise False.

class mtf.libs.mtf_pybinder.bap.BAPLSGObserver

Observer on BAP PDUs for a specific LSG.

__init__(*args, **kwargs)

__new__(**kwargs)

get_last_received_message(self: mtf.libs.mtf_pybinder.bap.BAPLSGObserver, fct_id: int, op_codes: set[mtf.libs.mtf_pybinder.bap.BAPOpCode] = set()) → mtf.libs.mtf_pybinder.bap.BAPEvent

Get the last received message for a specific function ID.

Args:

fct_id (int): The function ID for which to get the last message. op_codes (Set[BAPOpCode], optional): A set of operation codes to filter the messages.

Return:

BAPEvent: The last received message.

start(self: mtf.libs.mtf_pybinder.bap.BAPLSGObserver) → bool

Start the data acquisition.

Return:

bool: True if the observer has started successfully, otherwise False.

stop(self: mtf.libs.mtf_pybinder.bap.BAPLSGObserver) → bool

Stop the data acquisition.

Return:

bool: True if the observer has stopped successfully, otherwise False.

wait_message_reception(self: mtf.libs.mtf_pybinder.bap.BAPLSGObserver, fct_id: int, timeout_in_ms: int, op_codes: set[mtf.libs.mtf_pybinder.bap.BAPOpCode] = set(), all: bool = False) → bool

Wait for the reception of a message with a specific function ID.

Args:

fct_id (int): The function ID to wait for. timeout_in_ms (int): The timeout duration in milliseconds. op_codes (set[BAPOpCode], optional): A set of operation codes to filter the messages. all (bool, optional): Wait for each operation code (True) or just one (False). Defaults to False.

Return:

bool: True if the condition was satisfied during the timeout, otherwise False.

class mtf.libs.mtf_pybinder.bap.BAPNetwork

BAP Network class

__init__(*args, **kwargs)

__new__(**kwargs)

cleanup(self: mtf.libs.mtf_pybinder.bap.BAPNetwork) → None

Cleanup the BAPNetwork and stop all observers.

disable(self: mtf.libs.mtf_pybinder.bap.BAPNetwork) → None

Disable the BAPNetwork.

enable(self: mtf.libs.mtf_pybinder.bap.BAPNetwork, sg_list: set[str] | None = None) → bool

Enable the BAPNetwork.

Args:

sg_list (set[str], optional): List of SGs to enable.

Return:

bool: True if the operation has successed, otherwise False.

get_all_sgs(self: mtf.libs.mtf_pybinder.bap.BAPNetwork) → dict[str, mtf.libs.mtf_pybinder.bap.BAPSG]

Get all SGs in the BAPNetwork.

Return:

List[BAPSG]: List of all SGs.

get_sg_by_id(self: mtf.libs.mtf_pybinder.bap.BAPNetwork, sg_id: str) → mtf.libs.mtf_pybinder.bap.BAPSG

Get a SG by id e.f config file name.

Args:

sg_id (string): Id of the SG.

Return:

BAPSG: SG object if found, otherwise None.

get_sgs_by_name(self: mtf.libs.mtf_pybinder.bap.BAPNetwork, sg_name: str) → dict[str, mtf.libs.mtf_pybinder.bap.BAPSG]

Get map of SGs by name.

Args:

sg_name (string): Name of the SG.

Return:

BAPSG: map of found SGs

start_lsgs_observers(self: mtf.libs.mtf_pybinder.bap.BAPNetwork, sg_list: set[str]) → bool

Start observers for the all LSGs of the specified SGs.

Args:

sg_list (Set[str]): List of SGs to observe.

Return:

bool: True if the operation has successed, otherwise False.

stop_lsgs_observers(self: mtf.libs.mtf_pybinder.bap.BAPNetwork) → None

Stop all LSGs observers of the specified SGs.

static try_get_instance() → mtf.libs.mtf_pybinder.bap.BAPNetwork

Get the singleton instance of BAPNetwork.

Return:

BAPNetwork: the singleton instance of BAPNetwork.

class mtf.libs.mtf_pybinder.bap.BAPOpCode

BAP operation codes enum class

Members:

VALUE_0

VALUE_1

VALUE_2

VALUE_3

VALUE_4

VALUE_5

VALUE_6

ERROR

GET_ALL

STATUS_ALL

RESET

SET

GET

SET_GET

HEARTBEAT_STATUS

STATUS

STATUS_ACK

ACK

START

ABORT

START_RESULT

PROCESSING

RESULT

SET_ARRAY

GET_ARRAY

SET_GET_ARRAY

CHANGED_ARRAY

STATUS_ARRAY

ABORT

ACK

CHANGED_ARRAY

ERROR

GET

GET_ALL

GET_ARRAY

HEARTBEAT_STATUS

PROCESSING

RESET

RESULT

SET

SET_ARRAY

SET_GET

SET_GET_ARRAY

START

START_RESULT

STATUS

STATUS_ACK

STATUS_ALL

STATUS_ARRAY

VALUE_0

VALUE_1

VALUE_2

VALUE_3

VALUE_4

VALUE_5

VALUE_6

__init__(self: mtf.libs.mtf_pybinder.bap.BAPOpCode, value: int) → None

__new__(**kwargs)

property name

property value

class mtf.libs.mtf_pybinder.bap.BAPProtocolVersion

BAP protocol version class

__init__(*args, **kwargs)

__new__(**kwargs)

property major

property minor

class mtf.libs.mtf_pybinder.bap.BAPResult

BAP result enum class

Members:

REQUEST_TIMEOUT

RESPONSE_TIMEOUT

RETRY_TIMEOUT

REQUEST_ERROR

OP_CODE_ERROR

FUNCTION_ID_ERROR

INVALID_INPUT

OTHER

BUSY

NO_ERROR

NOT_SUPPORTED

BUSY

FUNCTION_ID_ERROR

INVALID_INPUT

NOT_SUPPORTED

NO_ERROR

OP_CODE_ERROR

OTHER

REQUEST_ERROR

REQUEST_TIMEOUT

RESPONSE_TIMEOUT

RETRY_TIMEOUT

__init__(self: mtf.libs.mtf_pybinder.bap.BAPResult, value: int) → None

__new__(**kwargs)

property name

property value

class mtf.libs.mtf_pybinder.bap.BAPSG

BAP SG class

__init__(*args, **kwargs)

__new__(**kwargs)

property config

get_all_asgs(self: mtf.libs.mtf_pybinder.bap.BAPSG) → dict[str, list[mtf.libs.mtf_pybinder.bap.BAPASG]]

Get all ASGs.

Return:

Dict[str, List[BAPASG]]: Dict of all ASGs.

get_all_fsgs(self: mtf.libs.mtf_pybinder.bap.BAPSG) → dict[str, list[mtf.libs.mtf_pybinder.bap.BAPFSG]]

Get all FSGs.

Return:

Dict[str, List[BAPFSG]]: Dict of all FSGs.

get_asg(self: mtf.libs.mtf_pybinder.bap.BAPSG, id_or_name: int | str, config: mtf.libs.mtf_pybinder.bap.BAPLSGConfig | None = None) → mtf.libs.mtf_pybinder.bap.BAPASG

Get an ASG by ID or name. Note: If ‘config’ is provided, it will return the corresponding ASG instance

else it will return a random ASG instance with that name or ID.

Args:

id_or_name (str|int): ID or name of the ASG. config (BAPLSGConfig, Optional): Specific LSG config

Return:

BAPASG: ASG object if found, otherwise None.

get_asgs(self: mtf.libs.mtf_pybinder.bap.BAPSG, id_or_name: int | str) → list[mtf.libs.mtf_pybinder.bap.BAPASG]

Get all ASG instances by ID or name.

Args:

id_or_name (str|int): ID or name of the ASG.

Return:

list[BAPASG]: list of all ASG instances.

get_fsg(self: mtf.libs.mtf_pybinder.bap.BAPSG, id_or_name: int | str, config: mtf.libs.mtf_pybinder.bap.BAPLSGConfig | None = None) → mtf.libs.mtf_pybinder.bap.BAPFSG

Get an FSG by ID or name. Note: If ‘config’ is provided, it will return the corresponding FSG instance

else it will return a random FSG instance with that name or ID.

Args:

id_or_name (str|int): ID or name of the FSG. config (BAPLSGConfig, Optional): Specific LSG config

Return:

BAPFSG: FSG object if found, otherwise None.

get_fsgs(self: mtf.libs.mtf_pybinder.bap.BAPSG, id_or_name: int | str) → list[mtf.libs.mtf_pybinder.bap.BAPFSG]

Get all FSG instances by ID or name.

Args:

id_or_name (str|int): ID or name of the FSG.

Return:

list[BAPFSG]: list of all FSG instances.

class mtf.libs.mtf_pybinder.bap.BAPSGConfig

BAP SG Config class

__init__(self: mtf.libs.mtf_pybinder.bap.BAPSGConfig) → None

__new__(**kwargs)

property xml_version_major

property xml_version_minor

class mtf.libs.mtf_pybinder.bap.BAPSpecialFctId

BAP special functions ids enum class

Members:

BAP_CONFIG

GET_ALL

FUNCTION_LIST

HEART_BEAT

FSG_OPERATION_STATE

FSG_SETUP

FSG_CTR

BAP_CONFIG

FSG_CTR

FSG_OPERATION_STATE

FSG_SETUP

FUNCTION_LIST

GET_ALL

HEART_BEAT

__init__(self: mtf.libs.mtf_pybinder.bap.BAPSpecialFctId, value: int) → None

__new__(**kwargs)

property name

property value

class mtf.libs.mtf_pybinder.bap.BAPStatus

Status of BAL

Members:

NOT_INITIALIZED

INITIALIZED

WAIT_FOR_CONFIG

RUNNING

INITIALIZED

NOT_INITIALIZED

RUNNING

WAIT_FOR_CONFIG

__init__(self: mtf.libs.mtf_pybinder.bap.BAPStatus, value: int) → None

__new__(**kwargs)

property name

property value