Nm Controller Module

class mtf.network_port.nm_controller.NmController

Network Management controller

__init__(node_id: int, bus_name: str, bus_type: BusType, cycle: float, frame_id: int)

start_send_cyclic_nm()

Start sending NM message cyclically.

stop_send_cyclic_nm()

Stop sending NM message cyclically

set_basic_nm(val: List[int])

Basic NM signal setter

Args:

val (List[int]): Basic NM signal value.

set_fktn(val: List[int])

Set Functional NM signal

Args:

val (List[int]): Functional NM signal value.

set_cbv(val: int)

Set Control Bit Vector signal

Args:

val (int): Control Bit Vector singal value.

nm_thread_function_()

Network Management transmition thread.

build_nm_payload_()

Create an NM payload.

Returns:

List[int]: Network Management payload

build_user_data_()

Create the user data for NM.

Returns:

List[int]: user data for NM

class mtf.network_port.nm_controller.EthNmController

Ethernet Network Management controller

__init__(channel_name: str)

get_nm_signal(signal_name: str, update_nm_signal_data=None)

Get network management signal value

Args:

signal_name (UdpNmSignals): NM signal name update_nm_signal_data(Function): Update NM signal data

Returns:

Union[int, List[int]]: requested signal value.

static __new__(cls, *args, **kwargs)

Initialize a new instance of the ControllerBase.

The instance will be automatically added to the list of controllers.

callback_(data_frame: BusEvent)

clean_up()

classmethod controllers_cleanup()

Clean up all controller instances.

Calls the clean_up() method for each instance.

get_message_queue() → list[dict[str, Any]]

Get messages queue :return: :rtype:

get_queue() → list[dict[str, Any]]

Get the queue

get_timestamp_queue() → list[int]

register_callback(callback_fnc: Callable[[IEthernetProtocol], None])

Parameters:

callback_fnc – callback function with parameter of type MessageEthernet

Setting a callback

# ...
from andisdk import MessageEthernet
# ...

def eth_listener_callback(msg: MessageEthernet):
    # do things

# ... creating listener 
# register our callback
listener.register_callback(eth_listener_callback)

Warning

The callback function should be lightweight without logs. Otherwise, it will reduce the performance dramatically. The object that is passed to callback functions is mutable. So the user must be careful. In case of silent mode, the callback functions will be invoked only when getting the queue.

reset() → None

cleanup the queue

start(channel=None, keep_cache=False, silent_mode: bool = False)

start_listening(keep_cache=False, silent_mode: bool = False) → bool

stop()

stop_listening() → bool

unregister_callback(callback_fnc: Callable[[IEthernetProtocol], None])

Parameters:

callback_fnc – callback function with parameter of type MessageEthernet

Remove a callback

# ...
from andisdk import MessageEthernet
# ...

def eth_listener_callback(msg: MessageEthernet):
    # do things

# ... creating listener 
# ... do work
# unregister our callback
listener.unregister_callback(eth_listener_callback)

adapt_queue_elements() → Queue[BaseEvent]

ensure the object.timestamp, object.payload