CustomFrTp
- class mtf.network_port.iso_tp.custom_fr_tp.CustomFrTp
Manages the transport of data using the FlexRay protocol
- __init__() None
- configure(config: IsoTpConfig) bool
Configures the CustomFrTp with the provided ISO-TP configuration.
- Args:
config (IsoTpConfig): The ISO-TP configuration to use for communication.
- Returns:
bool: True if configuration is successful, False otherwise.
- configure_reception_flow_control(flow_status: FrFlowStatus, bandwidth_control: int = 0, buffer_size: int = 0, acknowledge: SfAckValues = 1, byte_position: int = 0) bool
Configures the reception flow control based on the specified parameters.
- Args:
flow_status (FrFlowStatus): The flow control status to configure. bandwidth_control (int): Bandwidth control parameter for CTS flow control. buffer_size (int): Buffer size for CTS flow control. acknowledge (SfAckValues): Acknowledge value for ACK_RET flow control. byte_position (int): Byte position for ACK_RET flow control.
- Returns:
bool: True if configuration is successful, False otherwise.
- bind() bool
Binds the CustomFrTp for communication by starting the RX and TX listeners and setting the communication to active.
- Returns:
bool: True if the binding is successful, False otherwise.
- enable_faulty_speration_time(value: int) None
Enables a custom separation time with the specified value.
- Args:
value (int): The value for the custom separation time.
- disable_faulty_speration_time() None
Disables the custom separation time.
- close() bool
Closes the CustomFrTp communication.
- Returns:
bool: True if the communication is successfully closed, False otherwise.
- send(payload: List[int]) bool
Sends a frame or message over the CustomFrTp communication.
- Args:
payload (FramePayload): The payload to be sent.
- Returns:
bool: True if the send operation is successful, False otherwise.
- get_queue() List[List[int]]
Returns the queue of received frames or messages.
- Returns:
List[FramePayload]: A list of received frames or messages in the queue.
- clean_up() bool
Clean up all controller instances. This method should be overridden to precise the specific cleanup logic. If an instance does not override it, a default message will appear to inform that there are no cleanup logic is implemented.
- Return:
bool: True when the cleanup was successful, otherwise False if cleanup failed. By default, it returns True, yet this method should be overridden to present the actual cleanup status.
- 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.