Index: leahi_dialin/td/modules/alarms.py =================================================================== diff -u -rafe332fec54d9d0432dfc0d54aef1debaa92b066 -re45b20cdc5d4c5dcff8cef530b173ca94cb2e422 --- leahi_dialin/td/modules/alarms.py (.../alarms.py) (revision afe332fec54d9d0432dfc0d54aef1debaa92b066) +++ leahi_dialin/td/modules/alarms.py (.../alarms.py) (revision e45b20cdc5d4c5dcff8cef530b173ca94cb2e422) @@ -7,24 +7,30 @@ # # @file alarms.py # -# @author (last) Michael Garthwaite -# @date (last) 04-Oct-2023 +# @author (last) Zoltan Miskolci +# @date (last) 05-May-2026 # @author (original) Peter Lucia # @date (original) 02-Apr-2020 # ############################################################################ -import struct + +# Module imports from logging import Logger +import struct from enum import unique -from leahi_dialin.utils.base import DialinEnum -from .constants import RESET, NO_RESET -from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -from leahi_dialin.common.td_defs import TDEventDataType -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels -from leahi_dialin.utils.base import AbstractSubSystem, publish -from leahi_dialin.utils.checks import check_broadcast_interval_override_ms +# Project imports +from leahi_dialin.common.alarm_defs import AlarmList +from leahi_dialin.common.constants import NO_RESET +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.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override +from leahi_dialin.protocols.CAN import CanMessenger, CanMessage, CanChannels +from leahi_dialin.utils.abstract_classes import AbstractSubSystem +from leahi_dialin.utils.base import publish from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray +from leahi_dialin.utils.enums import DialinEnum class TDAlarms(AbstractSubSystem): @@ -54,9 +60,10 @@ TD_ALARM_RESPONSE_BUTTON_RINSEBACK = 1 TD_ALARM_RESPONSE_BUTTON_END_TREATMENT = 2 NUM_OF_TD_ALARM_RESPONSE_BUTTONS = 3 + AlarmResponseButtons._str_list = {} # Alarm status message field positions - START_POS_ALARM_STATE = DenaliMessage.PAYLOAD_START_INDEX + START_POS_ALARM_STATE = CanMessage.PAYLOAD_START_INDEX END_POS_ALARM_STATE = START_POS_ALARM_STATE + 4 START_POS_ALARM_TOP = END_POS_ALARM_STATE END_POS_ALARM_TOP = START_POS_ALARM_TOP + 4 @@ -67,87 +74,79 @@ START_POS_ALARMS_FLAGS = END_POS_ALARM_SILENCE_EXPIRES_IN END_POS_ALARMS_FLAGS = START_POS_ALARMS_FLAGS + 2 - 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_alarm_broadcast_ch_id - msg_id = MsgIds.MSG_ID_ALARM_STATUS_DATA.value - self.can_interface.register_receiving_publication_function(channel_id, msg_id, - self._handler_alarms_status_sync) + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.td_alarm_broadcast_ch_id, + message_id = MsgIds.MSG_ID_ALARM_STATUS_DATA.value, + function = self._handler_alarms_status_sync) - channel_id = DenaliChannels.td_alarm_broadcast_ch_id - msg_id = MsgIds.MSG_ID_ALARM_TRIGGERED.value - self.can_interface.register_receiving_publication_function(channel_id, msg_id, - self._handler_alarm_trigger) - msg_id = MsgIds.MSG_ID_ALARM_CLEARED.value - self.can_interface.register_receiving_publication_function(channel_id, msg_id, - self._handler_alarm_clear) - msg_id = MsgIds.MSG_ID_ALARM_CONDITION_CLEARED.value - self.can_interface.register_receiving_publication_function(channel_id, msg_id, - self._handler_alarm_condition_clear) - channel_id = DenaliChannels.td_sync_broadcast_ch_id - msg_id = MsgIds.MSG_ID_TD_ALARM_INFORMATION_DATA.value - self.can_interface.register_receiving_publication_function(channel_id, msg_id, - self._handler_alarm_information_sync) + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.td_alarm_broadcast_ch_id, + message_id = MsgIds.MSG_ID_ALARM_TRIGGERED.value, + function = self._handler_alarm_trigger) - self.td_alarm_status_timestamp = 0.0 - self.td_alarm_triggered_timestamp = 0.0 - self.td_alarm_cleared_timestamp = 0.0 - self.td_alarm_clr_condition_timestamp = 0.0 - self.td_alarm_information_timestamp = 0.0 + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.td_alarm_broadcast_ch_id, + message_id = MsgIds.MSG_ID_ALARM_CLEARED.value, + function = self._handler_alarm_clear) + + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.td_alarm_broadcast_ch_id, + message_id = MsgIds.MSG_ID_ALARM_CONDITION_CLEARED.value, + function = self._handler_alarm_condition_clear) + + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.td_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_TD_ALARM_INFORMATION_DATA.value, + function = self._handler_alarm_information_sync) + + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.td_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_TD_ACTIVE_ALARMS_LIST_REQUEST_RESPONSE.value, + function = self._handler_alarm_list_response) + + self.td_alarm_status_timestamp = 0.0 #: The timestamp of the last Alarm Status message + self.td_alarm_triggered_timestamp = 0.0 #: The timestamp of the last Alarm Triggered message + self.td_alarm_cleared_timestamp = 0.0 #: The timestamp of the last Alarm Cleared message + self.td_alarm_clr_condition_timestamp = 0.0 #: The timestamp of the last Alarm Clear Condition message + self.td_alarm_information_timestamp = 0.0 #: The timestamp of the last Alarm Information message # composite alarm status based on latest TD alarm status broadcast message - self.alarms_priority_state = 0 - self.alarm_top = 0 - self.alarms_silence_expires_in = 0 - self.alarms_escalates_in = 0 - self.alarms_flags = 0 + self.alarms_priority_state = 0 #: The current Top Alarm's priority value + self.alarm_top = 0 #: The current Top Alarm's value + self.alarms_silence_expires_in = 0 #: How many seconds the silence for the alarms expires in + self.alarms_escalates_in = 0 #: How many seconds the current Alarm escalates to the next priority + self.alarms_flags = 0 #: The Alarm flag's value - # alarm states based on received TD alarm activation and alarm clear messages - self.alarm_states = [False] * 500 - # alarm condition states based on received TD alarm activation and clear condition messages - self.alarm_conditions = [False] * 500 - # alarm priorities based on received TD alarm activation messages - self.alarm_priorities = [0] * 500 - # alarm ranks based on received TD alarm activation messages - self.alarm_ranks = [0] * 500 - # alarm clear top only flags based on received TD alarm activation messages - self.alarm_clear_top_only_flags = [False] * 500 - # alarm debug data on alarm triggered message - self.alarm_data = [0, 0] * 500 + self.alarm_states = [False] * 500 #: The States of all Alarms data in list format + self.alarm_conditions = [False] * 500 #: The Conditions of all Alarms data in list format + self.alarm_priorities = [0] * 500 #: The Priorities of all Alarms data in list format + self.alarm_ranks = [0] * 500 #: The Ranks of all Alarms data in list format + self.alarm_clear_top_only_flags = [False] * 500 #: The Clear Top only flags of all Alarms data in list format + self.alarm_data = [0, 0] * 500 #: The all Alarms data in list format + self.last_alarm_triggered = 0 #: The timestamp when did the last alarm triggered + self.last_alarm_data_1 = 0.0 #: The last Alarm's data part 1 + self.last_alarm_data_2 = 0.0 #: The last Alarm's data part 2 + # alarm information - self.alarm_data_type = dict() - self.alarm_volume = 0 - self.alarm_audio_curr_hg = 0.0 - self.alarm_audio_curr_lg = 0.0 - self.alarm_backup_audio_curr = 0.0 - self.safety_shutdown_active = False - self.ac_power_lost = False - self.alarm_table_button_blockers = [False] * self.AlarmResponseButtons.NUM_OF_TD_ALARM_RESPONSE_BUTTONS.value - self.alarm_state_button_blockers = [False] * self.AlarmResponseButtons.NUM_OF_TD_ALARM_RESPONSE_BUTTONS.value + self.alarm_volume = 0 #: The Alarm's Volume level + self.alarm_audio_curr_hg = 0.0 #: The Alarm's Audio high current + self.alarm_audio_curr_lg = 0.0 #: The Alarm's Audio low current + self.alarm_backup_audio_curr = 0.0 #: The Alarm's Audio backup current + self.safety_shutdown_active = False #: The Safety Shutdown is active or not + self.ac_power_lost = False #: The AC Power is lost or not + self.alarm_table_button_blockers = [False] * self.AlarmResponseButtons.NUM_OF_TD_ALARM_RESPONSE_BUTTONS.value #: The Alarm Table's Button blocker data + self.alarm_state_button_blockers = [False] * self.AlarmResponseButtons.NUM_OF_TD_ALARM_RESPONSE_BUTTONS.value #: The Alarm State's Button blocker data - # Loop through the list of the event data type enum and update the dictionary - for data_type in TDEventDataType: - event_data_type = TDEventDataType(data_type).name - struct_unpack_type = None + # Alarms list + self.ui_alarm_list_accepted = True #: The Alarm List request accepted + self.ui_alarm_list_reject_reason = 0 #: The Alarm List request reject reason + self.ui_alarm_list = [] #: The UI Alarm List content + self.ui_alarm_list_timestamp = 0.0 #: The timestamp of the last Alarm List - # 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 or 'NONE' 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.alarm_data_type[event_data_type] = struct_unpack_type - def clear_dialin_alarms(self): """ Clears the alarms states in Dialin. @@ -157,7 +156,10 @@ for x in range(500): self.alarm_states[x] = False - @publish(["td_alarm_status_timestamp", "alarms_priority_state", "alarm_top", "alarms_silence_expires_in", "alarms_escalates_in", "alarms_flags"]) + + @publish(["msg_id_td_alarm_status_data", "alarms_priority_state", "alarm_top", + "alarms_silence_expires_in", "alarms_escalates_in", "alarms_flags", + "td_alarm_status_timestamp"]) def _handler_alarms_status_sync(self, message, timestamp=0.0): """ Handles published alarms status messages. alarms status data are captured @@ -166,16 +168,21 @@ @param message: published alarm status data message @return: none """ - self.alarms_priority_state = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] - self.alarm_top = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] - self.alarms_escalates_in = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] - self.alarms_silence_expires_in = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] - self.alarms_flags = struct.unpack('H', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.START_POS_FIELD_5+2]))[0] + msg_list = [] + msg_list.append(('self.alarms_priority_state', DataTypes.U32)) + msg_list.append(('self.alarm_top', DataTypes.U32)) + msg_list.append(('self.alarms_escalates_in', DataTypes.U32)) + msg_list.append(('self.alarms_silence_expires_in', DataTypes.U32)) + msg_list.append(('self.alarms_flags', DataTypes.U16)) + self.process_into_vars(decoder_list = msg_list, + message = message) self.td_alarm_status_timestamp = timestamp - @publish(["td_alarm_triggered_timestamp", "alarm_states", "alarm_conditions", "alarm_data", - "alarm_priorities", "alarm_ranks", "alarm_clear_top_only_flags"]) + + @publish(["msg_id_td_alarm_triggered", "alarm_states", "alarm_conditions", + "alarm_data", "alarm_priorities", "alarm_ranks", "alarm_clear_top_only_flags", + "td_alarm_triggered_timestamp"]) def _handler_alarm_trigger(self, message, timestamp=0.0): """ Handles published TD alarm activation messages. @@ -184,68 +191,113 @@ @return: none """ self.logger.debug("Alarm activated!") - alarm_id = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) - data_typ_1 = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2])) - # Get the corresponding structure format - struct_data_type_1 = self.alarm_data_type[TDEventDataType(data_typ_1[0]).name] - # Get the data value by unpacking the data type - data_1 = struct.unpack(struct_data_type_1, bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3])) + result = {} + msg_list = [] + msg_list.append(('alarm_id', DataTypes.U32)) + msg_list.append(('data_typ_1', DataTypes.U32)) + msg_list.append(('data_1', 'data_typ_1')) + msg_list.append(('data_typ_2', DataTypes.U32)) + msg_list.append(('data_2', 'data_typ_2')) + msg_list.append(('priority', DataTypes.U32)) + msg_list.append(('rank', DataTypes.U32)) + msg_list.append(('clr_top_only', DataTypes.U32)) - data_typ_2 = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4])) - # Get the corresponding structure format - struct_data_type_2 = self.alarm_data_type[TDEventDataType(data_typ_2[0]).name] - # Get the data value by unpacking the data type - data_2 = struct.unpack(struct_data_type_2, bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5])) + i = 1 + for msg_detail in msg_list: + start_pos = eval(f'MsgFieldPositions.START_POS_FIELD_{i}') + end_pos = eval(f'MsgFieldPositions.END_POS_FIELD_{i}') + if isinstance(msg_detail[1], DataTypes): + unpack_attrib = msg_detail[1].unpack_attrib() + else: + unpack_attrib = DataTypes(result[msg_detail[1]]).unpack_attrib() + + value = struct.unpack(unpack_attrib, bytearray(message['message'][start_pos:end_pos]))[0] + result[msg_detail[0]] = value + i += 1 - priority = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6])) - rank = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7])) - clr_top_only = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8])) - - self.logger.debug("Alarm ID: %d %d %d" % (alarm_id[0], data_1[0], data_2[0])) - self.alarm_states[alarm_id[0]] = True - self.alarm_conditions[alarm_id[0]] = True - self.alarm_priorities[alarm_id[0]] = priority[0] - self.alarm_ranks[alarm_id[0]] = rank[0] - self.alarm_clear_top_only_flags[alarm_id[0]] = clr_top_only[0] - self.alarm_data[alarm_id[0]] = [data_1[0], data_2[0]] + self.logger.debug("Alarm ID: %d %d %d" % (result['alarm_id'], result['data_1'], result['data_2'])) + self.alarm_states[result['alarm_id']] = True + self.alarm_conditions[result['alarm_id']] = True + self.alarm_priorities[result['alarm_id']] = result['priority'] + self.alarm_ranks[result['alarm_id']] = result['rank'] + self.alarm_clear_top_only_flags[result['alarm_id']] = result['clr_top_only'] + self.alarm_data[result['alarm_id']] = [result['data_1'], result['data_2']] + self.last_alarm_triggered = result['alarm_id'] + self.last_alarm_data_1 = result['data_1'] + self.last_alarm_data_2 = result['data_2'] self.td_alarm_triggered_timestamp = timestamp - @publish(["TD_alarm_cleared_timestamp", "alarm_states", "alarm_conditions"]) + + @publish(["msg_id_td_alarm_cleared", "alarm_states", "alarm_conditions", "TD_alarm_cleared_timestamp"]) def _handler_alarm_clear(self, message, timestamp=0.0): """ Handles published TD alarm clear messages. @param message: published TD alarm clear message @return: none """ - alarm_id = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) - self.alarm_states[alarm_id[0]] = False - self.alarm_conditions[alarm_id[0]] = False + msg_list = [] + msg_list.append(('alarm_id', DataTypes.U32)) + + result = self.process_into_vars(decoder_list = msg_list, + message = message) + self.alarm_states[result['alarm_id']] = False + self.alarm_conditions[result['alarm_id']] = False self.td_alarm_cleared_timestamp = timestamp - @publish(["td_alarm_clr_condition_timestamp", "alarm_conditions", "alarm_conditions"]) + + @publish(["msg_id_td_alarm_condition_cleared", "alarm_conditions", "alarm_conditions", "td_alarm_clr_condition_timestamp"]) def _handler_alarm_condition_clear(self, message, timestamp=0.0): """ Handles published TD alarm clear alarm condition messages. @param message: published TD alarm clear alarm condition message @return: none """ - alarm_id = struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) - self.alarm_conditions[alarm_id[0]] = False + msg_list = [] + msg_list.append(('alarm_id', DataTypes.U32)) + + result = self.process_into_vars(decoder_list = msg_list, + message = message) + + self.alarm_conditions[result['alarm_id']] = False self.td_alarm_clr_condition_timestamp = timestamp - @publish(["td_alarm_information_timestamp", "alarm_volume", "alarm_audio_curr_hg", "alarm_audio_curr_lg", "alarm_backup_audio_curr", - "safety_shutdown_active", "ac_power_lost", "alarm_table_button_blockers", "alarm_state_button_blockers"]) + + @publish(["msg_id_td_alarm_info_data", "alarm_volume", "alarm_audio_curr_hg", + "alarm_audio_curr_lg", "alarm_backup_audio_curr", "safety_shutdown_active", "ac_power_lost", + "alarm_table_button_blockers", "alarm_state_button_blockers", + "td_alarm_information_timestamp"]) def _handler_alarm_information_sync(self, message, timestamp=0.0): """ Handles published TD alarm information broadcast messages. @param message: published TD alarm information message @return: none """ + msg_list = [] + msg_list.append(('self.alarm_volume', DataTypes.U32)) + msg_list.append(('self.alarm_audio_curr_hg', DataTypes.F32)) + msg_list.append(('self.alarm_audio_curr_lg', DataTypes.F32)) + msg_list.append(('self.alarm_backup_audio_curr', DataTypes.U32)) + msg_list.append(('self.safety_shutdown_active', DataTypes.BOOL)) + msg_list.append(('self.ac_power_lost', DataTypes.BOOL)) + sensor_list = [] + sensor_list.append((self.AlarmResponseButtons.TD_ALARM_RESPONSE_BUTTON_RESUME.value, DataTypes.BOOL_U08)) + sensor_list.append((self.AlarmResponseButtons.TD_ALARM_RESPONSE_BUTTON_RINSEBACK.value, DataTypes.BOOL_U08)) + sensor_list.append((self.AlarmResponseButtons.TD_ALARM_RESPONSE_BUTTON_END_TREATMENT.value, DataTypes.BOOL_U08)) + sensor_list.append((self.AlarmResponseButtons.TD_ALARM_RESPONSE_BUTTON_RESUME.value, DataTypes.BOOL_U08)) + sensor_list.append((self.AlarmResponseButtons.TD_ALARM_RESPONSE_BUTTON_RINSEBACK.value, DataTypes.BOOL_U08)) + sensor_list.append((self.AlarmResponseButtons.TD_ALARM_RESPONSE_BUTTON_END_TREATMENT.value, DataTypes.BOOL_U08)) + self.process_into_vars(decoder_list = msg_list, + message = message) + self.process_into_dict(dict_to_update = self.alarm_table_button_blockers, + decoder_list = sensor_list, + message = message, + start_from_byte = len(msg_list) * DataTypes.U32.size()) + """ vol = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) ach = struct.unpack('f', bytearray( @@ -283,8 +335,73 @@ self.alarm_state_button_blockers[self.AlarmResponseButtons.TD_ALARM_RESPONSE_BUTTON_RESUME.value] = True if srs[0] else False self.alarm_state_button_blockers[self.AlarmResponseButtons.TD_ALARM_RESPONSE_BUTTON_RINSEBACK.value] = True if srb[0] else False self.alarm_state_button_blockers[self.AlarmResponseButtons.TD_ALARM_RESPONSE_BUTTON_END_TREATMENT.value] = True if set[0] else False + """ self.td_alarm_information_timestamp = timestamp + + @publish(["msg_id_td_active_alarms_list_request_response", "accepted", "rejection_reason", "active_alarm_list"]) + def _handler_alarm_list_response(self, message, timestamp=0.0): + """ + Handles published TD alarm clear alarm condition messages. + + @param message: published TD alarm clear alarm condition message + @return: none + """ + self.ui_alarm_list_accepted = struct.unpack(DataTypes.U32.unpack_attrib(), bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] + self.ui_alarm_list_reject_reason = struct.unpack(DataTypes.U32.unpack_attrib(), bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] + + i = 3 + for _ in range(0,10): + start_pos = eval(f'MsgFieldPositions.START_POS_FIELD_{i}') + end_pos = eval(f'MsgFieldPositions.END_POS_FIELD_{i}') + value = struct.unpack(DataTypes.U32.unpack_attrib(), bytearray(message['message'][start_pos:end_pos]))[0] + self.ui_alarm_list.append(value) + i += 1 + self.ui_alarm_list_timestamp = timestamp + + + def cmd_alarm_status_broadcast_interval_override(self, ms: int = 250, reset: int = NO_RESET): + """ + Constructs and sends the alarm status broadcast interval override command + Constraints: + Must be logged into TD. + Given interval must be non-zero and a multiple of the TD general task interval (50 ms). + + @param ms: integer - interval (in ms) to override with + @param reset: integer - 1 to reset a previous override, 0 to override + @return: 1 if successful, zero otherwise + """ + return cmd_generic_broadcast_interval_override( + ms = ms, + reset = reset, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_ALARM_STATUS_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Alarm Status', + logger = self.logger, + can_interface = self.can_interface) + + + def cmd_alarm_info_broadcast_interval_override(self, ms: int = 1000, reset: int = NO_RESET): + """ + Constructs and sends the alarm information broadcast interval override command + Constraints: + Must be logged into TD. + Given interval must be non-zero and a multiple of the TD general task interval (50 ms). + + @param ms: integer - interval (in ms) to override with + @param reset: integer - 1 to reset a previous override, 0 to override + @return: 1 if successful, zero otherwise + """ + return cmd_generic_broadcast_interval_override( + ms = ms, + reset = reset, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_ALARM_INFO_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Alarm Info', + logger = self.logger, + can_interface = self.can_interface) + + def cmd_alarm_state_override(self, alarm: int, state: int, reset: int = NO_RESET) -> int: """ Constructs and sends the alarm state override command @@ -298,34 +415,24 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) sta = integer_to_bytearray(state) alm = integer_to_bytearray(alarm) payload = rst + sta + alm - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_ALARM_STATE_OVERRIDE_REQUEST.value, - payload=payload) + alarm_name = AlarmList(alarm).name + state_name = 'Active' if state != 0 else 'Inactive' + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_ALARM_STATE_OVERRIDE_REQUEST, + entity_name = f'TD {alarm_name} Alarm state', + override_text = f'{state_name}', + logger = self.logger, + can_interface = self.can_interface) - # Send message - received_message = self.can_interface.send(message) - # If there is content... - if received_message is not None: - # self.logger.debug(received_message) - if reset == RESET: - str_res = "reset back to normal" - else: - str_res = ("active" if state != 0 else "inactive") - self.logger.debug("Alarm " + str(alarm) + " " + str_res + ": " + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_clear_all_alarms(self) -> int: """ Constructs and sends the clear all active alarms command. @@ -335,24 +442,20 @@ @return: 1 if successful, zero otherwise """ - key = integer_to_bytearray(-758926171) # 0xD2C3B4A5 payload = key - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_ALARM_CLEAR_ALL_ALARMS_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_ALARM_CLEAR_ALL_ALARMS_REQUEST, + entity_name = f'TD Alarms', + override_text = f'Cleared', + logger = self.logger, + can_interface = self.can_interface) - # Send message - received_message = self.can_interface.send(message) - # If there is content... - if received_message is not None: - self.logger.debug("All alarms cleared.") - # response payload is OK or not OK - return 1 == received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - return False - def cmd_alarm_time_override(self, alarm: int, time_ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the alarm time override command @@ -365,36 +468,23 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) ms = integer_to_bytearray(time_ms) alm = integer_to_bytearray(alarm) payload = rst + ms + alm - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_ALARM_START_TIME_OVERRIDE_REQUEST.value, - payload=payload) + alarm_name = AlarmList(alarm).name + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_ALARM_START_TIME_OVERRIDE_REQUEST, + entity_name = f'TD {alarm_name} Alarms time', + override_text = f'{time_ms} ms', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override alarm time since activated") - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # self.logger.debug(received_message) - if reset == RESET: - str_res = "reset back to normal" - else: - str_res = str(time_ms) - self.logger.debug("Alarm time since activated overridden to " + str_res + " ms: " + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_alarm_lamp_pattern_override(self, pattern: int, reset: int = NO_RESET) -> int: """ Constructs and sends the alarm lamp pattern override command. @@ -419,126 +509,32 @@ pat = integer_to_bytearray(pattern) payload = rst + pat - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_ALARM_LAMP_PATTERN_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("Override Alarm Lamp Pattern") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - self.logger.debug(received_message) - if reset == RESET: - str_pat = "reset back to normal" - elif pattern == self.TD_ALARM_LAMP_PATTERN_OFF: - str_pat = "off" - elif pattern == self.TD_ALARM_LAMP_PATTERN_OK: - str_pat = "ok" - elif pattern == self.TD_ALARM_LAMP_PATTERN_FAULT: - str_pat = "fault" - elif pattern == self.TD_ALARM_LAMP_PATTERN_HIGH: - str_pat = "high" - elif pattern == self.TD_ALARM_LAMP_PATTERN_MEDIUM: - str_pat = "medium" - elif pattern == self.TD_ALARM_LAMP_PATTERN_LOW: - str_pat = "low" - else: - str_pat = "manual" - self.logger.debug("Alarm lamp pattern overridden to " + str_pat + ":" + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] + if pattern == self.TD_ALARM_LAMP_PATTERN_OFF: + str_pat = "Off" + elif pattern == self.TD_ALARM_LAMP_PATTERN_OK: + str_pat = "Ok" + elif pattern == self.TD_ALARM_LAMP_PATTERN_FAULT: + str_pat = "Fault" + elif pattern == self.TD_ALARM_LAMP_PATTERN_HIGH: + str_pat = "High" + elif pattern == self.TD_ALARM_LAMP_PATTERN_MEDIUM: + str_pat = "Medium" + elif pattern == self.TD_ALARM_LAMP_PATTERN_LOW: + str_pat = "Low" else: - self.logger.debug("Timeout!!!!") - return False + str_pat = "Manual" - def cmd_alarm_info_broadcast_interval_override(self, ms: int = 1000, reset: int = NO_RESET): - """ - Constructs and sends the alarm information broadcast interval override command - Constraints: - Must be logged into TD. - Given interval must be non-zero and a multiple of the TD general task interval (50 ms). + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_ALARM_AUDIO_LEVEL_OVERRIDE_REQUEST, + entity_name = f'TD Alarms lamp pattern', + override_text = f'{str_pat}', + logger = self.logger, + can_interface = self.can_interface) - @param ms: integer - interval (in ms) to override with - @param reset: integer - 1 to reset a previous override, 0 to override - @return: 1 if successful, zero otherwise - """ - if not check_broadcast_interval_override_ms(ms): - return False - - rst = integer_to_bytearray(reset) - mis = integer_to_bytearray(ms) - payload = rst + mis - - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_ALARM_INFO_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override alarm information broadcast interval") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(ms) + " ms: " - self.logger.debug("Alarm information broadcast interval overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - - def cmd_alarm_status_broadcast_interval_override(self, ms: int = 250, reset: int = NO_RESET): - """ - Constructs and sends the alarm status broadcast interval override command - Constraints: - Must be logged into TD. - Given interval must be non-zero and a multiple of the TD general task interval (50 ms). - - @param ms: integer - interval (in ms) to override with - @param reset: integer - 1 to reset a previous override, 0 to override - @return: 1 if successful, zero otherwise - """ - - if not check_broadcast_interval_override_ms(ms): - return False - - rst = integer_to_bytearray(reset) - mis = integer_to_bytearray(ms) - payload = rst + mis - - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_ALARM_STATUS_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override alarm status broadcast interval") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(ms) + " ms: " - self.logger.debug("Alarm status broadcast interval overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_alarm_audio_level_override(self, volume: int = 5, reset: int = NO_RESET): """ Constructs and sends the alarm audio volume override command @@ -550,34 +546,21 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) vol = integer_to_bytearray(volume) payload = rst + vol - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_ALARM_AUDIO_LEVEL_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_ALARM_AUDIO_LEVEL_OVERRIDE_REQUEST, + entity_name = f'TD Alarms audio volume', + override_text = f'{str(volume)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override alarm audio volume level") - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(volume) + ": " - self.logger.debug("Alarm audio volume level overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_alarm_audio_current_hg_override(self, current: float = 0.0, reset: int = NO_RESET): """ Constructs and sends the alarm audio current (high gain) override command @@ -588,34 +571,21 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) cur = float_to_bytearray(current) payload = rst + cur - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_ALARM_AUDIO_CURRENT_HG_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_ALARM_AUDIO_CURRENT_HG_OVERRIDE_REQUEST, + entity_name = f'TD Alarms audio high gain current', + override_text = f'{str(current)} mA', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override alarm audio high gain current") - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(current) + " mA: " - self.logger.debug("Alarm audio high gain current overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_alarm_audio_current_lg_override(self, current: float = 0.0, reset: int = NO_RESET): """ Constructs and sends the alarm audio current (low gain) override command @@ -626,34 +596,21 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) cur = float_to_bytearray(current) payload = rst + cur - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_ALARM_AUDIO_CURRENT_LG_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_ALARM_AUDIO_CURRENT_LG_OVERRIDE_REQUEST, + entity_name = f'TD Alarms audio low gain current', + override_text = f'{str(current)} mA', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override alarm audio high gain current") - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(current) + " mA: " - self.logger.debug("Alarm audio low gain current overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_alarm_backup_audio_current_override(self, current: float = 0.0, reset: int = NO_RESET): """ Constructs and sends the backup alarm audio current override command @@ -664,30 +621,16 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) cur = float_to_bytearray(current) payload = rst + cur - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BACKUP_ALARM_AUDIO_CURRENT_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override alarm backup audio current") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(current) + " mA: " - self.logger.debug("Alarm backup audio current overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BACKUP_ALARM_AUDIO_CURRENT_OVERRIDE_REQUEST, + entity_name = f'TD Alarms backup audio current', + override_text = f'{str(current)} mA', + logger = self.logger, + can_interface = self.can_interface)