Nm Manager Module

class mtf.network_port.nm_manager.NmManager

Network Management manager

__init__()

start_nm_controller(bus_name: str, node_id: int = 16, bus_type: BusType = BusType.CAN, cycle=0.01, frame_id: int = 0)

Start sending cyclically the NM frame.

Args:

bus_name (str): bus name node_id (int, optional): node identifier. Defaults to 0x10. bus_type (BusType, optional): bus type. It could be CAN, Ethernet, CANFD. Defaults to BusType.CAN. cycle (float, optional): sending cycle time. Defaults to 0.01. frame_id (int, optional): NM frame identifier. Defaults to 0x510.

Returns:

Boolean: True if the start cyclic send was started, else False.

stop_nm_controller(bus_name: str)

Stop sending the NM frame.

Args:

bus_name (str): the bus name

Returns:

Boolean: True if the send was stopped properly.Else False

stop_all()

Stop all the started NM controllers.

set_functional_pn(bus_name: str, payload: List[int])

Set Functional Partial Network

Args:

bus_name (str): bus name. payload (List[int]): signal value

Returns:

Boolean: True if signal value was set, else False

clean_up()

Clear all the created NM controllers.

Returns:

Boolean: True if cleanup done, else False

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

Initializes a new instance of the ControllerBase.

The instance will be automatically added to the list of controllers to be cleaned up later. It guarantees that all the controller instances are followed up and cleaned up when the associate method ‘controllers_cleanup(cls)’ is called.

Note:

Do not override this method in subclasses to maintain this functionality.

Args:

*args: Suitable arguments passed to the constructor of the ControllerBase class. **kwargs: keywords passed to the constructor of the ControllerBase class.

Returns:

instance(ControllerBase): The new instance of the class that has been created.

classmethod controllers_cleanup()

Cleans up all controller instances.

It Calls the clean_up() method for each instance, since it iterates through the list of controllers to realize any needed cleanup which can fail so an error will be raised. Then, the remaining instances will continue processing.

Returns:

bool: True indicating that all the controllers are successfully cleaned up, otherwise False when an error occurred during the operation of the cleanup.