Serial Observer Module

class mtf.network_port.serial_observer.SerialObserver

__init__()

start_serial_observer(channel_name: str, get_message_as_string: bool = True)

Start a serial observer to specific channel_name.

Parameters:

• channel_name – serial logger channel name.

• get_message_as_string – true if we need to start observer over messages as string format false if as list of int format

Returns:

True if serial observer was started else False

Examples:

>>> serial_observer_instance = SerialObserver()
>>> serial_observer_instance.start_serial_observer("serial_channel_name")

stop_serial_observer(channel_name: str)

Stop a serial observer to specific channel_name.

Parameters:

channel_name – serial logger channel name.

Returns:

True if serial observer was stopped else False

Examples:

>>> serial_observer_instance = SerialObserver()
>>> serial_observer_instance.stop_serial_observer("serial_channel_name")

stop_all_serial_observers()

Stop all started serial observers.

Returns:

True if all started serial observers sere stopped else False

Examples:

>>> serial_observer_instance = SerialObserver()
>>> serial_observer_instance.stop_all_serial_observers()

monitor_happened_serial_events(channel_name: str, message: str | list[int], timeout: int)

Monitor a serial event over specific channel_name.

Parameters:

• channel_name – serial logger channel name.

• message – event to monitor

• timeout – monitoring timeout

Returns:

True if event was received during the given timeout else False

Examples:

>>> serial_observer_instance = SerialObserver()
>>> serial_observer_instance.monitor_happened_serial_events("serial_channel_name")