Index: leahi_dialin/td/modules/events.py =================================================================== diff -u -r20c821bd230fc7689a0275a2918981669ff5cc19 -re45b20cdc5d4c5dcff8cef530b173ca94cb2e422 --- leahi_dialin/td/modules/events.py (.../events.py) (revision 20c821bd230fc7689a0275a2918981669ff5cc19) +++ leahi_dialin/td/modules/events.py (.../events.py) (revision e45b20cdc5d4c5dcff8cef530b173ca94cb2e422) @@ -8,7 +8,7 @@ # @file events.py # # @author (last) Zoltan Miskolci -# @date (last) 08-Jan-2026 +# @date (last) 05-May-2026 # @author (original) Dara Navaei # @date (original) 12-Oct-2021 # @@ -18,11 +18,17 @@ from logging import Logger from datetime import datetime from time import time +# Module imports +from logging import Logger +# Project imports from leahi_dialin.common import td_enum_repository -from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -from leahi_dialin.protocols.CAN import DenaliChannels -from leahi_dialin.utils.base import AbstractSubSystem, publish +from leahi_dialin.common.generic_defs import DataTypes +from leahi_dialin.common.msg_defs import MsgFieldPositions +from leahi_dialin.common.msg_ids import MsgIds +from leahi_dialin.protocols.CAN import CanMessenger, CanChannels +from leahi_dialin.utils.abstract_classes import AbstractSubSystem +from leahi_dialin.utils.base import publish class TDEvents(AbstractSubSystem): @@ -31,65 +37,45 @@ """ UNKNOWN_STATE = "UNKNOWN_PREVIOUS_STATE" - def __init__(self, can_interface, logger: Logger): + def __init__(self, can_interface: CanMessenger, logger: Logger): """ - @param can_interface: Denali CAN Messenger object + @param can_interface: Can Messenger object """ super().__init__() self.can_interface = can_interface self.logger = logger if self.can_interface is not None: - channel_id = DenaliChannels.td_sync_broadcast_ch_id - self.msg_id_td_event = MsgIds.MSG_ID_TD_EVENT.value - self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_td_event, self._handler_events_sync) + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.td_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_TD_EVENT.value, + function = self._handler_events_sync) - channel_id = DenaliChannels.td_sync_broadcast_ch_id - self.msg_id_td_op_mode_data = MsgIds.MSG_ID_TD_OP_MODE_DATA.value - self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_td_op_mode_data, - self._handler_td_op_mode_sync) + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.td_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_TD_OP_MODE_DATA.value, + function = self._handler_td_op_mode_sync) - self.td_events_timestamp = 0.0 #: The timestamp of the last Event message - self.td_event_op_mode = 0 #: The new Operation Mode value - self.td_event_sub_mode = 0 #: The new Operation Sub-Mode value - self.td_event_op_mode_timestamp = 0.0 #: The timestamp of the last Operation Mode change message + self.events_timestamp = 0.0 #: The timestamp of the last Event message + self.op_mode = 0 #: The new Operation Mode value + self.sub_mode = 0 #: The new Operation Sub-Mode value + self.event_op_mode_timestamp = 0.0 #: The timestamp of the last Operation Mode change message - # Dictionary of the mode as key and the sub mode states enum class as the value - self._td_op_mode_2_sub_mode = {td_enum_repository.TDOpModes.MODE_FAUL.name: td_enum_repository.TDFaultStates, - td_enum_repository.TDOpModes.MODE_SERV.name: td_enum_repository.TDServiceStates, - td_enum_repository.TDOpModes.MODE_INIT.name: td_enum_repository.TDInitStates, - td_enum_repository.TDOpModes.MODE_STAN.name: td_enum_repository.TDStandbyStates, - td_enum_repository.TDOpModes.MODE_PRET.name: td_enum_repository.TDPreTreatmentModesStates, - td_enum_repository.TDOpModes.MODE_TREA.name: td_enum_repository.TDTreatmentStates, - td_enum_repository.TDOpModes.MODE_POST.name: td_enum_repository.TDPostTreatmentStates, - td_enum_repository.TDOpModes.MODE_NLEG.name: td_enum_repository.TDNotLegalStates} + # Dictionary of the mode as key and the sub mode states enum class as the valued + self._op_mode_2_sub_mode = {td_enum_repository.TDOpModes.MODE_FAUL.name: td_enum_repository.TDFaultStates, + td_enum_repository.TDOpModes.MODE_SERV.name: td_enum_repository.TDServiceStates, + td_enum_repository.TDOpModes.MODE_INIT.name: td_enum_repository.TDInitStates, + td_enum_repository.TDOpModes.MODE_STAN.name: td_enum_repository.TDStandbyStates, + td_enum_repository.TDOpModes.MODE_PRET.name: td_enum_repository.TDPreTreatmentModesStates, + td_enum_repository.TDOpModes.MODE_TREA.name: td_enum_repository.TDTreatmentStates, + td_enum_repository.TDOpModes.MODE_POST.name: td_enum_repository.TDPostTreatmentStates, + td_enum_repository.TDOpModes.MODE_NLEG.name: td_enum_repository.TDNotLegalStates} - # Define the dictionaries - self._td_event_dictionary = dict() - self._td_event_data_type = dict() - # Loop through the list of the TD events enums and initial the event dictionary. Each event is a key in the # dictionary and the value is a list. + self._event_dictionary = dict() for event in td_enum_repository.TDEventList: - self._td_event_dictionary[td_enum_repository.TDEventList(event).name] = [] + self._event_dictionary[td_enum_repository.TDEventList(event).name] = [] - # Loop through the list of the event data type enum and update the dictionary - for data_type in td_enum_repository.TDEventDataTypes: - event_data_type = td_enum_repository.TDEventDataTypes(data_type).name - struct_unpack_type = None - # If U32 is in the data type enum (i.e. EVENT_DATA_TYPE_U32), then the key is the enum and the value is - # the corresponding format in the python struct - if 'U32' in event_data_type or 'BOOL' in event_data_type: - struct_unpack_type = 'I' - elif 'S32' in event_data_type: - struct_unpack_type = 'i' - elif 'F32' in event_data_type: - struct_unpack_type = 'f' - - self._td_event_data_type[event_data_type] = struct_unpack_type - - def get_td_nth_event(self, event_id, event_number=0): """ Returns the nth requested TD event @@ -99,14 +85,14 @@ @returns the requested TD event number """ - list_length = len(self._td_event_dictionary[td_enum_repository.TDEventList(event_id).name]) + list_length = len(self._event_dictionary[td_enum_repository.TDEventList(event_id).name]) if list_length == 0: event = [] elif event_number > list_length: - event = self._td_event_dictionary[td_enum_repository.TDEventList(event_id).name][list_length - 1] + event = self._event_dictionary[td_enum_repository.TDEventList(event_id).name][list_length - 1] else: - event = self._td_event_dictionary[td_enum_repository.TDEventList(event_id).name][list_length - event_number - 1] + event = self._event_dictionary[td_enum_repository.TDEventList(event_id).name][list_length - event_number - 1] return event @@ -117,8 +103,8 @@ @returns none """ - for key in self._td_event_dictionary: - self._td_event_dictionary[key].clear() + for key in self._event_dictionary: + self._event_dictionary[key].clear() def get_td_events(self, event_id, number_of_events=1): @@ -133,23 +119,23 @@ list_of_events = [] # If there are not enough event lists send all the events that are available - if len(self._td_event_dictionary[td_enum_repository.TDEventList(event_id).name]) <= number_of_events: - list_of_events = self._td_event_dictionary[td_enum_repository.TDEventList(event_id).name] + if len(self._event_dictionary[td_enum_repository.TDEventList(event_id).name]) <= number_of_events: + list_of_events = self._event_dictionary[td_enum_repository.TDEventList(event_id).name] else: # Get the all the events - complete_list = self._td_event_dictionary[td_enum_repository.TDEventList(event_id).name] + complete_list = self._event_dictionary[td_enum_repository.TDEventList(event_id).name] # Since the last are located at the end of the list, iterate backwards for the defined # event messages for i in range(len(complete_list) - 1, len(complete_list) - number_of_events - 1, -1): list_of_events.append(complete_list[i]) if number_of_events == 0: - list_of_events = self._td_event_dictionary[td_enum_repository.TDEventList(event_id).name] + list_of_events = self._event_dictionary[td_enum_repository.TDEventList(event_id).name] return list_of_events - @publish(["msg_id_td_event", "td_events_timestamp", '_td_event_dictionary']) + @publish(["msg_id_td_event", "events_timestamp", '_event_dictionary']) def _handler_events_sync(self, message, timestamp=0.0): """ Handles published events message @@ -162,134 +148,145 @@ op_mode = 0 sub_mode = 0 sub_state = 0 - current_sub_tuple = [] - event_id = struct.unpack('i', bytearray( + event_id = struct.unpack(DataTypes.U32.unpack_attrib(), bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] + # Convert the event ID to enum + event_enum = td_enum_repository.TDEventList(event_id) + current_timestamp = datetime.now().astimezone().strftime('%Y-%m-%d %H:%M:%S.%f') - if event_id == td_enum_repository.TDEventList.TD_EVENT_OPERATION_STATUS.value: - # Get the data type - event_data_type_1 = struct.unpack('i', bytearray( + if event_enum is td_enum_repository.TDEventList.TD_EVENT_OPERATION_STATUS: + # Get the data type - irrelevant + event_data_type_1 = struct.unpack(DataTypes.U32.unpack_attrib(), bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] - struct_data_type = self._td_event_data_type[td_enum_repository.TDEventDataTypes(event_data_type_1).name] - op_mode = struct.unpack(' current_sub_mode_timestamp: - # If the previous and current of the last two tuples do not match, then an operation mode transition - # has occurred and the previous state is converted from the previous class and the current op mode - # is converted from current operation states enum class. - # i.e last = (timestamp, event type, 3, 8) and one before = (timestamp, event type, 8, 3) - # previous and current do not match so in the last type (timestamp, event type, 8, 3) the prev state - # should be from op mode 8 and the current state should be from op mode 3 - previous_op_mode = last_op_tuple[len(last_op_tuple) - 2] - if previous_op_mode != TDEvents.UNKNOWN_STATE: - previous_sub_mode_enum_class = self._td_op_mode_2_sub_mode[previous_op_mode] - event_data_1 = previous_sub_mode_enum_class(event_data_1).name - # Unknown previous state. Display value instead of name. + # Go through the Operation Status Change message list starting from the back + # Index description: + # 0: Timestamp + # 1: Op Mode + # 2: Sub Mode + # 3: State + for i in range(len(op_status_list) - 1, -1, -1): + op_status_msg = op_status_list[i] + + # Look for a match for event_data_2 + if not data_2_found: + if op_status_msg[2] == event_data_2: + event_2_op_mode = td_enum_repository.TDOpModes(op_status_msg[1]).name + data_2_found = True + + # Look for a match for event_data_1 after event_data_2 is found + # Criteria is that the opmode, submode pair can't be the same as the one found for event_data_2 else: - event_data_1 = str(event_data_1) - event_data_2 = current_sub_mode_enum_class(event_data_2).name - else: + if op_status_msg[2] == event_data_1 and \ + (op_status_msg[2] != event_data_2 or td_enum_repository.TDOpModes(op_status_msg[1]).name != event_2_op_mode): + event_1_op_mode = td_enum_repository.TDOpModes(op_status_msg[1]).name + + # If op mode for event_data_2 found but not found for event_data_1 and run out of operation states + # assume it's the start of the unit start up and the going to standby is not logged yet + if event_2_op_mode != self.UNKNOWN_STATE and event_1_op_mode == self.UNKNOWN_STATE: + event_1_op_mode = td_enum_repository.TDOpModes.MODE_STAN.name - if event_data_2 != 0: - event_data_1 = current_sub_mode_enum_class(event_data_1).name - event_data_2 = current_sub_mode_enum_class(event_data_2).name - else: - previous_sub_mode = current_sub_tuple[len(current_sub_tuple) - 2] - previous_sub_mode_enum_class = self._td_op_mode_2_sub_mode[previous_sub_mode] - event_data_1 = previous_sub_mode_enum_class(event_data_1).name - event_data_2 = current_sub_mode_enum_class(event_data_2).name - event_tuple = (datetime.now().astimezone().strftime('%Y-%m-%d %H:%M:%S.%f'), event_state_name, event_data_1, event_data_2) + # Update the event_data values + event_data_1 = self._op_mode_2_sub_mode[event_1_op_mode](event_data_1).name + event_data_2 = self._op_mode_2_sub_mode[event_2_op_mode](event_data_2).name + + # Update the tuple + event_tuple = (current_timestamp, event_enum.name, event_data_1, event_data_2) - elif event_state_name == td_enum_repository.TDEventList.TD_EVENT_OPERATION_STATUS.name: - event_tuple = (time(), op_mode, sub_mode, sub_state) + elif event_enum is td_enum_repository.TDEventList.TD_EVENT_OPERATION_STATUS: + event_tuple = (current_timestamp, op_mode, sub_mode, sub_state) # Update event dictionary - self._td_event_dictionary[event_state_name].append(event_tuple) - self.td_events_timestamp = timestamp + self._event_dictionary[event_enum.name].append(event_tuple) + self.events_timestamp = timestamp - @publish(["msg_id_td_op_mode_data", "td_event_op_mode_timestamp", "td_event_op_mode", "td_event_sub_mode"]) + @publish(["msg_id_td_op_mode_data", "event_op_mode_timestamp", "op_mode", "sub_mode"]) def _handler_td_op_mode_sync(self, message, timestamp=0.0): """ Handles published TD operation mode messages. Current TD operation mode @@ -298,12 +295,10 @@ @param message: published TD operation mode broadcast message @return: None """ + msg_list = [] + msg_list.append(('self.op_mode', DataTypes.U32)) + msg_list.append(('self.sub_mode', DataTypes.U32)) - mode = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) - smode = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2])) - - self.td_event_op_mode = mode[0] - self.td_event_sub_mode = smode[0] - self.td_event_op_mode_timestamp = timestamp + self.process_into_vars(decoder_list = msg_list, + message = message) + self.event_op_mode_timestamp = timestamp