Index: leahi_dialin/fp/modules/alarms.py =================================================================== diff -u -rec8a2600b9e8cf6fe7e02c200a1c24221ca86863 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/fp/modules/alarms.py (.../alarms.py) (revision ec8a2600b9e8cf6fe7e02c200a1c24221ca86863) +++ leahi_dialin/fp/modules/alarms.py (.../alarms.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,23 +7,26 @@ # # @file alarms.py # -# @author (last) Micahel Garthwaite -# @date (last) 17-Aug-2023 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Quang Nguyen # @date (original) 02-Sep-2020 # ############################################################################ + import struct from logging import Logger -from .constants import RESET, NO_RESET +from leahi_dialin.common.alarm_defs import AlarmList +from leahi_dialin.common.constants import NO_RESET from leahi_dialin.common.fp_defs import FPEventDataType from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions +from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels -from leahi_dialin.utils.base import AbstractSubSystem, publish, DialinEnum -from leahi_dialin.utils.checks import check_broadcast_interval_override_ms -from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray +from leahi_dialin.utils.base import AbstractSubSystem, publish +from leahi_dialin.utils.conversions import integer_to_bytearray + class FPAlarms(AbstractSubSystem): """ FP interface containing alarm related commands. @@ -82,6 +85,7 @@ self.alarm_data_type[event_data_type] = struct_unpack_type + @publish(["msg_id_fp_alarm_triggered", "alarm_states", "alarm_conditions", "alarm_data", "alarm_priorities", "alarm_ranks", "alarm_clear_top_only_flags", "fp_alarm_triggered_timestamp"]) @@ -123,6 +127,56 @@ self.last_alarm_data_2 = data_2[0] self.fp_alarm_triggered_timestamp = timestamp + + def cmd_alarm_state_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the alarm state data broadcast interval override command + Constraints: + Must be logged into FP. + Given interval must be non-zero and a multiple of the FP 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 + """ + print('Not implemented in the FW') + return False + + return cmd_generic_broadcast_interval_override( + ms = ms, + reset = reset, + channel_id = DenaliChannels.dialin_to_fp_ch_id, + msg_id = '', + module_name = 'FP Alarm state', + logger = self.logger, + can_interface = self.can_interface) + + + def cmd_alarm_info_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the alarm info data broadcast interval override command + Constraints: + Must be logged into FP. + Given interval must be non-zero and a multiple of the FP 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 + """ + + print('Not implemented in the FW') + return False + + return cmd_generic_broadcast_interval_override( + ms = ms, + reset = reset, + channel_id = DenaliChannels.dialin_to_fp_ch_id, + msg_id = '', + module_name = 'FP 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 @@ -142,28 +196,19 @@ alm = integer_to_bytearray(alarm) payload = rst + sta + alm - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_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 = DenaliChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_ALARM_STATE_OVERRIDE_REQUEST, + entity_name = f'FP {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. @@ -173,22 +218,17 @@ @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_FP_ALARM_CLEAR_ALL_ALARMS_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_ALARM_CLEAR_ALL_ALARMS_REQUEST, + entity_name = f'FP 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 - #TODO: alarm state override, alarm info pubish override