Index: leahi_dialin/common/override_templates.py =================================================================== diff -u -raa534fb000c14ca2490eda9c4497f18402db3c2d -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/common/override_templates.py (.../override_templates.py) (revision aa534fb000c14ca2490eda9c4497f18402db3c2d) +++ leahi_dialin/common/override_templates.py (.../override_templates.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -18,7 +18,7 @@ from logging import Logger # Project imports -from .constants import RESET, NO_RESET +from .constants import RESET from .msg_defs import MsgIds from ..protocols.CAN import DenaliMessage, DenaliChannels from ..utils.checks import check_broadcast_interval_override_ms @@ -49,7 +49,7 @@ @return: 1 if successful, zero otherwise """ - if not check_broadcast_interval_override_ms(ms): + if not check_broadcast_interval_override_ms(ms, logger): return False reset_byte_array = integer_to_bytearray(reset) Index: leahi_dialin/common/td_defs.py =================================================================== diff -u -r8bcac0e6e7960de5d9bdf925bbf5581cdc97df31 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/common/td_defs.py (.../td_defs.py) (revision 8bcac0e6e7960de5d9bdf925bbf5581cdc97df31) +++ leahi_dialin/common/td_defs.py (.../td_defs.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -249,8 +249,8 @@ class TDEjectorAttributes(DialinEnum): STATE = 0 # Ejector State to command SET_SPEED = 1 # Ejector Set Speed - OPT_SNSR_RETRACT = 2 # Ejector optical sensor retract - OPT_SNSR_ENGAGE = 3 # Ejector optical sensor engage + OPT_SNSR_RETRACT = 2 # Ejector H25 optical sensor retract + OPT_SNSR_ENGAGE = 3 # Ejector H24 optical sensor engage NUM_OF_EJECTOR_ATTRIBUTES = 4 # Number of Ejector Attributes @unique Index: leahi_dialin/dd/modules/alarms.py =================================================================== diff -u -r410054cfec7aee839266233249413b08b368fbd3 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/dd/modules/alarms.py (.../alarms.py) (revision 410054cfec7aee839266233249413b08b368fbd3) +++ leahi_dialin/dd/modules/alarms.py (.../alarms.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -8,7 +8,7 @@ # @file alarms.py # # @author (last) Zoltan Miskolci -# @date (last) 07-Jan-2026 +# @date (last) 08-Jan-2026 # @author (original) Quang Nguyen # @date (original) 02-Sep-2020 # @@ -17,6 +17,7 @@ import struct from logging import Logger +from leahi_dialin.common.alarm_defs import AlarmList from leahi_dialin.common.constants import NO_RESET from leahi_dialin.common.dd_defs import DDEventDataType from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions @@ -283,12 +284,14 @@ alm = integer_to_bytearray(alarm) payload = rst + sta + alm + alarm_name = AlarmList(alarm).name + state_name = 'Active' if state != 0 else 'Inactive' return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_ALARM_STATE_OVERRIDE_REQUEST, - entity_name = f'DD Alarm {str(alarm)}', - override_text = "active" if state != 0 else "inactive", + entity_name = f'DD {alarm_name} Alarm state', + override_text = f'{state_name}', logger = self.logger, can_interface = self.can_interface) Index: leahi_dialin/dd/modules/dd_test_configs.py =================================================================== diff -u -r410054cfec7aee839266233249413b08b368fbd3 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/dd/modules/dd_test_configs.py (.../dd_test_configs.py) (revision 410054cfec7aee839266233249413b08b368fbd3) +++ leahi_dialin/dd/modules/dd_test_configs.py (.../dd_test_configs.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -143,7 +143,7 @@ reset = NO_RESET, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_RESET_ALL_TEST_CONFIGURATIONS, - entity_name = f'Reset all Test Configurations', + entity_name = f'Reset all DD & FP Test Configurations', override_text = 'Active', logger = self.logger, can_interface = self.can_interface) 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 Index: leahi_dialin/fp/modules/events.py =================================================================== diff -u -r7d9d004527efeccb91958b440abdff08c2c52648 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/fp/modules/events.py (.../events.py) (revision 7d9d004527efeccb91958b440abdff08c2c52648) +++ leahi_dialin/fp/modules/events.py (.../events.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,21 +7,24 @@ # # @file events.py # -# @author (last) Jonny Paguio -# @date (last) 16-Sep-2025 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Dara Navaei # @date (original) 12-Oct-2021 # ############################################################################ import struct from logging import Logger -from leahi_dialin.common import * +from datetime import datetime +from time import time + +from leahi_dialin.common.fp_defs import FPEventList, FPEventDataType, FPOpModes, FPFaultStates, \ + FPServiceStates, FPPostStates, FPStandbyStates, FPPreGenPermeateStates, FPGenPermeateStates, \ + FPPreGenPDefStates, FPGenPermeateDefStates, FPNotLegalStates 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 datetime import datetime -from time import time class FPEvents(AbstractSubSystem): @@ -35,7 +38,6 @@ @param can_interface: Denali CAN Messenger object """ - super().__init__() self.can_interface = can_interface self.logger = logger @@ -90,6 +92,7 @@ self._fp_event_data_type[event_data_type] = struct_unpack_type + def get_fp_nth_event(self, event_id, event_number=0): """ Returns the nth requested FP event @@ -110,6 +113,7 @@ return event + def clear_fp_event_list(self): """ Clears the FP event list @@ -119,6 +123,7 @@ for key in self._fp_event_dictionary: self._fp_event_dictionary[key].clear() + def get_fp_events(self, event_id, number_of_events=1): """ Returns the requested number of a certain FP event ID @@ -146,6 +151,7 @@ return list_of_events + @publish(["msg_id_fp_event", "fp_events_timestamp", '_fp_event_dictionary']) def _handler_events_sync(self, message, timestamp=0.0): """ @@ -285,6 +291,7 @@ self._fp_event_dictionary[event_state_name].append(event_tuple) self.fp_events_timestamp = timestamp + @publish(["msg_id_fp_op_mode_data", "fp_event_op_mode_timestamp", "fp_event_op_mode", "fp_event_sub_mode"]) def _handler_fp_op_mode_sync(self, message, timestamp=0.0): """ @@ -302,4 +309,4 @@ self.fp_event_op_mode = mode[0] self.fp_event_sub_mode = smode[0] - self.fp_event_op_mode_timestamp = timestamp \ No newline at end of file + self.fp_event_op_mode_timestamp = timestamp Index: leahi_dialin/fp/modules/fp_test_configs.py =================================================================== diff -u -re27f157082335696e336c9d9952392bc62e3c8c8 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/fp/modules/fp_test_configs.py (.../fp_test_configs.py) (revision e27f157082335696e336c9d9952392bc62e3c8c8) +++ leahi_dialin/fp/modules/fp_test_configs.py (.../fp_test_configs.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,26 +7,26 @@ # # @file fp_test_configs.py # -# @author (last) Jonny Paguio -# @date (last) 22-Aug-2025 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Jonny Paguio # @date (original) 20-Aug-2025 # ############################################################################ from logging import Logger +from leahi_dialin.common.constants import NO_RESET from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions +from leahi_dialin.common.override_templates import cmd_generic_override from leahi_dialin.common.test_config_defs import DDFPTestConfigOptions -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels -from .constants import NO_RESET -from leahi_dialin.utils.conversions import integer_to_bytearray, bytearray_to_integer +from leahi_dialin.protocols.CAN import DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish +from leahi_dialin.utils.conversions import integer_to_bytearray, bytearray_to_integer class FPTestConfig(AbstractSubSystem): """ - FP Dialin API sub-class for setting and getting the test configurations. """ @@ -60,6 +60,25 @@ return self.fp_test_configs[DDFPTestConfigOptions(config).name] + @publish(['msg_id_fp_send_test_config', 'fp_test_configs', 'fp_test_configs_response_timestamp']) + def _handler_fp_test_config_sync(self, message, timestamp=0.0): + """ + Handles published test configuration status messages. + + @param message: published FP test configurations message + @return: None + """ + payload = message['message'] + index = MsgFieldPositions.START_POS_FIELD_1 + + for config in DDFPTestConfigOptions.__members__: + if 'NUM_OF_TEST_CONFIGS' not in config: + config_value, index = bytearray_to_integer(payload, index, False) + self.fp_test_configs[config] = config_value + + self.fp_test_configs_response_timestamp = timestamp + + def cmd_set_test_config(self, config: int, reset: int = NO_RESET): """ Constructs and sends the FP test config @@ -74,26 +93,21 @@ c = integer_to_bytearray(config) payload = reset_value + c - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_SET_TEST_CONFIGURATION.value, - payload=payload) + response = cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_SET_TEST_CONFIGURATION, + entity_name = f'FP {DDFPTestConfigOptions(config).name} Test Config', + override_text = 'Active', + logger = self.logger, + can_interface = self.can_interface) + + # Update the stored test configs from the FW + self.cmd_request_test_config_status_from_fw() + return response - if reset == NO_RESET: - self.logger.debug("Setting {}".format(DDFPTestConfigOptions(config).name)) - else: - self.logger.debug("Resetting {}".format(DDFPTestConfigOptions(config).name)) - # Send message - received_message = self.can_interface.send(message) - - # If there is no content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_request_test_config_status_from_fw(self): """ Constructs and sends the FP test configs request @@ -102,26 +116,17 @@ @return: 1 if successful, zero otherwise """ - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_GET_TEST_CONFIGURATION.value) + return cmd_generic_override( + payload = None, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_GET_TEST_CONFIGURATION, + entity_name = f'Get FP Test Configuration Record', + override_text = 'Active', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug('Getting FP test configuration record') - # Reset the test configs regardless of whether the message has been acknowledged or not. The reset might be out - # sync and reset the test configuration while the latest data has been received. If the test configuration is - # reset in Dialin but the message was not acknowledged, the user shall send the request again - self._reset_test_configs_record() - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - self.logger.debug("Received FW ACK after requesting FP test configuration record.") - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_reset_all_test_configs(self): """ Constructs and sends the FP test configs reset all @@ -130,47 +135,16 @@ @return: 1 if successful, zero otherwise """ - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_RESET_ALL_TEST_CONFIGURATIONS.value) - - self.logger.debug("Resetting all FP test configurations") - - # Send message - received_message = self.can_interface.send(message) - - # If there is no content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - - @publish(['msg_id_fp_send_test_config', 'fp_test_configs', 'fp_test_configs_response_timestamp']) - def _handler_fp_test_config_sync(self, message, timestamp=0.0): - """ - Handles published test configuration status messages. - - @param message: published FP test configurations message - @return: None - """ - payload = message['message'] - index = MsgFieldPositions.START_POS_FIELD_1 - - for config in DDFPTestConfigOptions.__members__: - if 'NUM_OF_TEST_CONFIGS' not in config: - config_value, index = bytearray_to_integer(payload, index, False) - self.fp_test_configs[config] = config_value - - self.fp_test_configs_response_timestamp = timestamp - - def _reset_test_configs_record(self): - """ - Resets the test configuration dictionary - - @return: None - """ - for config in DDFPTestConfigOptions.__members__: - # Loop through the list of the test configuration and set the values to 0xFFFFFFFF - if 'NUM_OF_TEST_CONFIGS' not in config: - self.fp_test_configs[config] = 0xFFFFFFFF + response = cmd_generic_override( + payload = None, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_RESET_ALL_TEST_CONFIGURATIONS, + entity_name = f'Reset all DD & FP Test Configurations', + override_text = 'Active', + logger = self.logger, + can_interface = self.can_interface) + + # Update the stored test configs from the FW + self.cmd_request_test_config_status_from_fw() + return response Index: leahi_dialin/td/modules/air_pump.py =================================================================== diff -u -rec8a2600b9e8cf6fe7e02c200a1c24221ca86863 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/air_pump.py (.../air_pump.py) (revision ec8a2600b9e8cf6fe7e02c200a1c24221ca86863) +++ leahi_dialin/td/modules/air_pump.py (.../air_pump.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,8 +7,8 @@ # # @file air_pump.py # -# @author (last) Micahel Garthwaite -# @date (last) 10-Mar-2023 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Micahel Garthwaite # @date (original) 01-Nov-2024 # @@ -17,12 +17,12 @@ import struct from logging import Logger -from .constants import RESET, NO_RESET +from leahi_dialin.common.constants import NO_RESET 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.common.td_defs import TDAirPumpNames, TDAirPumpAttributes -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels +from leahi_dialin.protocols.CAN import DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish -from leahi_dialin.utils.checks import check_broadcast_interval_override_ms from leahi_dialin.utils.conversions import integer_to_bytearray @@ -57,6 +57,7 @@ self.td_air_pump_timestamp = 0.0 + @publish(["msg_id_td_air_pump_data", "td_air_pump", "td_air_pump_timestamp"]) def _handler_air_pump_sync(self, message, timestamp=0.0): """ @@ -74,35 +75,7 @@ self.td_air_pump[TDAirPumpNames.H12_AIR_PUMP.name][TDAirPumpAttributes.POWER.name] = app[0] self.td_air_pump_timestamp = timestamp - def cmd_air_pump_set_state(self, state: int, power: int) -> int: - """ - Constructs and sends the air pump set state command. - Constraints: - Must be logged into TD. - @param power: integer - 0-255 value to set the air pump power - @return: 1 if successful, zero otherwise - """ - - sts = integer_to_bytearray(state) - pwr = integer_to_bytearray(power) - payload = sts + pwr - - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_PUMP_SET_STATE_REQUEST.value, - payload=payload) - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_air_pump_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the air pump data broadcast interval override command @@ -114,33 +87,38 @@ @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 = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_PUMP_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Air Pump', + logger = self.logger, + can_interface = self.can_interface) - if not check_broadcast_interval_override_ms(ms): - return False - rst = integer_to_bytearray(reset) - mis = integer_to_bytearray(ms) - payload = rst + mis + def cmd_air_pump_set_state(self, state: int, power: int) -> int: + """ + Constructs and sends the air pump set state command. - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_PUMP_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) + Constraints: + Must be logged into TD. + @param state: integer - 1 to stop the pump, 2 to activate it + @param power: integer - 0-255 value to set the air pump power + @return: 1 if successful, zero otherwise + """ + sts = integer_to_bytearray(state) + pwr = integer_to_bytearray(power) + payload = sts + pwr - self.logger.debug("override TD air pump data 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("Air pump data 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 + state_name = 'start with power' if state == 2 else 'stopped' + power_value = f'{str(power)}' if state == 2 else '' + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_PUMP_SET_STATE_REQUEST, + entity_name = f'TD Air Pump to {state_name}', + override_text = f'{power_value}', + logger = self.logger, + can_interface = self.can_interface) Index: leahi_dialin/td/modules/air_trap.py =================================================================== diff -u -r43fec7787f9a4115d19deeb5cbc1d7bbf23134fe -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/air_trap.py (.../air_trap.py) (revision 43fec7787f9a4115d19deeb5cbc1d7bbf23134fe) +++ leahi_dialin/td/modules/air_trap.py (.../air_trap.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,22 +7,22 @@ # # @file air_trap.py # -# @author (last) Michael Garthwaite -# @date (last) 26-Jun-2024 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Sean Nash # @date (original) 21-Sep-2020 # ############################################################################ + import struct from logging import Logger -from enum import unique -from .constants import RESET, NO_RESET +from leahi_dialin.common.constants import NO_RESET 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.common.td_defs import TDAirTrapValves, TDAirTrapLevelSensors, TDAirTrapLevelSensorsAttributes, TDAirTrapState -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.protocols.CAN import DenaliChannels +from leahi_dialin.utils.base import AbstractSubSystem, publish from leahi_dialin.utils.conversions import integer_to_bytearray @@ -69,6 +69,7 @@ self.air_control = 0 self.td_air_trap_timestamp = 0.0 + @publish(["msg_id_td_air_trap_data", "air_trap_level_sensors", "air_trap_valve_states", @@ -107,6 +108,28 @@ self.air_control = controlling[0] self.td_air_trap_timestamp = timestamp + + def cmd_air_trap_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the air trap data 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 = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_TRAP_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Air Trap', + logger = self.logger, + can_interface = self.can_interface) + + def cmd_air_trap_level_sensor_override(self, sensor: int, detected: int, reset: int = NO_RESET) -> int: """ Constructs and sends the air trap level sensor override command @@ -119,29 +142,23 @@ @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) det = integer_to_bytearray(detected) idx = integer_to_bytearray(sensor) payload = rst + det + idx - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_TRAP_LEVEL_OVERRIDE_REQUEST.value, - payload=payload) + sensor_name = TDAirTrapLevelSensors(sensor).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_TRAP_LEVEL_OVERRIDE_REQUEST, + entity_name = f'TD {sensor_name} Air Trap level sensor', + override_text = f'{str(detected)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override air trap level sensor detection value for sensor " + str(sensor) + " ,Level: " + str(detected)) - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_raw_air_trap_level_sensor_override(self, sensor: int, detected: int, reset: int = NO_RESET) -> int: """ Constructs and sends the raw air trap level sensor override command @@ -154,71 +171,23 @@ @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) det = integer_to_bytearray(detected) idx = integer_to_bytearray(sensor) payload = rst + det + idx - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_TRAP_LEVEL_RAW_OVERRIDE_REQUEST.value, - payload=payload) + sensor_name = TDAirTrapLevelSensors(sensor).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_TRAP_LEVEL_RAW_OVERRIDE_REQUEST, + entity_name = f'TD {sensor_name} Air Trap level sensor raw', + override_text = f'{str(detected)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override raw air trap level sensor detection value for sensor " + str(sensor) + " ,Level: " + str(detected)) - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - - def cmd_air_trap_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: - """ - Constructs and sends the air trap data 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_AIR_TRAP_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override TD air trap data 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("Air trap data 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_set_td_air_trap_valve(self, valve: int = TDAirTrapValves.H13_VALV.value, valve_state: int = TDAirTrapState.STATE_CLOSED.value) -> int: """ @@ -228,25 +197,21 @@ @param valve_state: air trap valve state (open or close) @returns 1 if successful, zero otherwise """ - vlv = integer_to_bytearray(valve) sts = integer_to_bytearray(valve_state) payload = vlv + sts - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_2_WAY_VALVE_SET_STATE_REQUEST.value, - payload=payload) - # Send message - received_message = self.can_interface.send(message) + valve_name = TDAirTrapValves(valve).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_2_WAY_VALVE_SET_STATE_REQUEST, + entity_name = f'TD Air Trap {valve_name} Valve state', + override_text = f'{str(valve_state)}', + logger = self.logger, + can_interface = self.can_interface) - # If there is content... - if received_message is not None: - # response payload is OK or not OK - self.logger.debug("Air trap valve " + str(valve) + " set to " + str(valve_state)) - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("timeout!!") - return False def cmd_set_td_air_trap_control(self, control: int = 0) -> int: """ @@ -255,24 +220,19 @@ @param control: start/stop for air trap control (0=stop, 1=start) @returns 1 if successful, zero otherwise """ - ctl = integer_to_bytearray(control) payload = ctl - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_SET_AIR_TRAP_CONTROL.value, - payload=payload) - # Send message - received_message = self.can_interface.send(message) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_SET_AIR_TRAP_CONTROL, + entity_name = f'TD Air Trap control', + override_text = f'{str(control)}', + logger = self.logger, + can_interface = self.can_interface) - # If there is content... - if received_message is not None: - # response payload is OK or not OK - self.logger.debug("Air trap control set to " + str(control)) - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("timeout!!") - return False def cmd_air_trap_air_pump_power_raise_override(self, power: int, reset: int = NO_RESET) -> int: """ @@ -289,28 +249,17 @@ pwr = integer_to_bytearray(power) payload = rst + pwr - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_PUMP_POWER_RAISE_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_PUMP_POWER_RAISE_OVERRIDE_REQUEST, + entity_name = f'TD Air Pump Raise power', + override_text = f'{str(power)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("Override TD air trap air pump raise power 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(power) - self.logger.debug("Air trap air pump power raise 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_air_trap_air_pump_power_lower_override(self, power: int, reset: int = NO_RESET) -> int: """ Constructs and sends the air trap air pump power lower override command @@ -326,24 +275,12 @@ pwr = integer_to_bytearray(power) payload = rst + pwr - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_AIR_PUMP_POWER_LOWER_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("Override TD air trap air pump lower power 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(power) - self.logger.debug("Air trap air pump power lower 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 = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_AIR_PUMP_POWER_LOWER_OVERRIDE_REQUEST, + entity_name = f'TD Air Pump Lower power', + override_text = f'{str(power)}', + logger = self.logger, + can_interface = self.can_interface) Index: leahi_dialin/td/modules/alarms.py =================================================================== diff -u -rec8a2600b9e8cf6fe7e02c200a1c24221ca86863 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/alarms.py (.../alarms.py) (revision ec8a2600b9e8cf6fe7e02c200a1c24221ca86863) +++ leahi_dialin/td/modules/alarms.py (.../alarms.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,23 +7,24 @@ # # @file alarms.py # -# @author (last) Michael Garthwaite -# @date (last) 04-Oct-2023 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Peter Lucia # @date (original) 02-Apr-2020 # ############################################################################ + import struct from logging import Logger from enum import unique -from leahi_dialin.utils.base import DialinEnum -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.msg_defs import MsgIds, MsgFieldPositions +from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override 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 +from leahi_dialin.utils.base import AbstractSubSystem, DialinEnum, publish from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray @@ -152,6 +153,7 @@ self.alarm_data_type[event_data_type] = struct_unpack_type + def clear_dialin_alarms(self): """ Clears the alarms states in Dialin. @@ -161,6 +163,7 @@ for x in range(500): self.alarm_states[x] = False + @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"]) @@ -180,6 +183,7 @@ self.td_alarm_status_timestamp = timestamp + @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"]) @@ -221,6 +225,7 @@ self.last_alarm_data_2 = data_2[0] self.td_alarm_triggered_timestamp = timestamp + @publish(["msg_id_td_alarm_cleared", "alarm_states", "alarm_conditions", "TD_alarm_cleared_timestamp"]) def _handler_alarm_clear(self, message, timestamp=0.0): """ @@ -234,6 +239,7 @@ self.alarm_conditions[alarm_id[0]] = False self.td_alarm_cleared_timestamp = timestamp + @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): """ @@ -246,6 +252,7 @@ self.alarm_conditions[alarm_id[0]] = False self.td_alarm_clr_condition_timestamp = timestamp + @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", @@ -257,7 +264,6 @@ @param message: published TD alarm information message @return: none """ - vol = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) ach = struct.unpack('f', bytearray( @@ -297,6 +303,49 @@ 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 + + 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 = DenaliChannels.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 = DenaliChannels.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 @@ -310,34 +359,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 = DenaliChannels.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. @@ -347,24 +386,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 = DenaliChannels.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 @@ -377,36 +412,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 = DenaliChannels.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. @@ -431,126 +453,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 = DenaliChannels.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 @@ -562,34 +490,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 = DenaliChannels.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 @@ -600,34 +515,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 = DenaliChannels.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 @@ -638,34 +540,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 = DenaliChannels.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 @@ -676,30 +565,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 = DenaliChannels.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) Index: leahi_dialin/td/modules/blood_flow.py =================================================================== diff -u -r7c8e829c563547ee50c517f1d6b84cb800b72027 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/blood_flow.py (.../blood_flow.py) (revision 7c8e829c563547ee50c517f1d6b84cb800b72027) +++ leahi_dialin/td/modules/blood_flow.py (.../blood_flow.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,22 +7,22 @@ # # @file blood_flow.py # -# @author (last) Micahel Garthwaite -# @date (last) 17-Aug-2023 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Peter Lucia # @date (original) 02-Apr-2020 # ############################################################################ + import struct from logging import Logger -from .constants import PUMP_CONTROL_MODE_CLOSED_LOOP, PUMP_CONTROL_MODE_OPEN_LOOP -from .constants import RESET, NO_RESET +from leahi_dialin.common.constants import NO_RESET, PUMP_CONTROL_MODE_CLOSED_LOOP 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.common.td_defs import TDBloodFlowMotorAttributes -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels +from leahi_dialin.protocols.CAN import DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish -from leahi_dialin.utils.checks import check_broadcast_interval_override_ms from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray @@ -57,6 +57,7 @@ TDBloodFlowMotorAttributes.ROTOR_HALL_STATE.name: 0, } + @publish(["msg_id_td_blood_pump_data", "h4_motor", "td_blood_flow_timestamp"]) def _handler_blood_flow_sync(self, message, timestamp=0.0): """ @@ -66,7 +67,6 @@ @param message: published blood flow data message @return: none """ - self.h4_motor[TDBloodFlowMotorAttributes.SET_BLOOD_FLOW_RATE.name] = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.h4_motor[TDBloodFlowMotorAttributes.MEASURED_BLOOD_FLOW_RATE.name] = struct.unpack('f', bytearray( @@ -88,6 +88,28 @@ self.td_blood_flow_timestamp = timestamp + + def cmd_blood_flow_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the measured blood flow 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 = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BLOOD_PUMP_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Blood Flow', + logger = self.logger, + can_interface = self.can_interface) + + def cmd_blood_flow_set_flow_rate_request(self, flow: int, mode: int = PUMP_CONTROL_MODE_CLOSED_LOOP) -> int: """ Constructs and sends the blood flow set point command @@ -98,31 +120,21 @@ @param mode: integer - 0 for closed loop control mode or 1 for open loop control mode @return: 1 if successful, zero otherwise """ - flo = integer_to_bytearray(flow) mod = integer_to_bytearray(mode) payload = flo + mod - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BLOOD_PUMP_SET_FLOW_RATE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BLOOD_PUMP_SET_FLOW_RATE_REQUEST, + entity_name = f'TD Blood Flow flow rate', + override_text = f'{str(flow)} mL/min', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override blood flow set point") - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - self.logger.debug( - "Blood flow set point overridden to " + str(flo) + " mL/min" + str(mod) + - 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_blood_flow_set_speed_rate_request(self, rpm: int) -> int: """ Constructs and sends the blood flow set speed command @@ -132,30 +144,20 @@ @param rpm: integer - speed set point (in rpm) between 80 - 3080 @return: 1 if successful, zero otherwise """ - rpm = integer_to_bytearray(rpm) payload = rpm - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BLOOD_PUMP_SET_SPEED_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BLOOD_PUMP_SET_SPEED_REQUEST, + entity_name = f'TD Blood Flow RPM', + override_text = f'{str(rpm)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override blood flow set point") - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - self.logger.debug( - "Blood flow speed rate to " + str(rpm) + - 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_blood_flow_measured_override(self, flow: int, reset: int = NO_RESET) -> int: """ Constructs and sends the measured blood flow override command @@ -166,35 +168,21 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) flo = float_to_bytearray(flow) payload = rst + flo - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BLOOD_PUMP_MEASURED_FLOW_RATE_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BLOOD_PUMP_MEASURED_FLOW_RATE_OVERRIDE_REQUEST, + entity_name = f'TD Blood Flow measured flow rate', + override_text = f'{str(flow)} mL/min', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override measured blood flow") - # 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(flow) - self.logger.debug("Blood flow (measured)) overridden to " + str_res + " mL/min: " + - 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_blood_pump_measured_motor_speed_override(self, speed: int, reset: int = NO_RESET) -> int: """ Constructs and sends the measured blood pump motor speed override \n @@ -206,35 +194,21 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) spd = float_to_bytearray(speed) payload = rst + spd - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BLOOD_PUMP_MEASURED_MOTOR_SPEED_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BLOOD_PUMP_MEASURED_MOTOR_SPEED_OVERRIDE_REQUEST, + entity_name = f'TD Blood Flow measured motor RPM', + override_text = f'{str(spd)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override measured blood pump speed") - # 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(speed) - self.logger.debug("Blood pump speed (measured) overridden to " + str_res + " RPM: " + - 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_blood_pump_measured_rotor_speed_override(self, speed: int, reset: int = NO_RESET) -> int: """ Constructs and sends the measured blood pump rotor speed override \n @@ -246,78 +220,22 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) spd = float_to_bytearray(speed) payload = rst + spd - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BLOOD_PUMP_MEASURED_ROTOR_SPEED_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BLOOD_PUMP_MEASURED_ROTOR_SPEED_OVERRIDE_REQUEST, + entity_name = f'TD Blood Flow measured rotor RPM', + override_text = f'{str(spd)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override measured blood pump rotor speed") - # Send message - received_message = self.can_interface.send(message) - # If there is contentleahi_dialin.. - if received_message is not None: - # self.logger.debug(received_message) - if reset == RESET: - str_res = "reset back to normal" - else: - str_res = str(speed) - self.logger.debug("Blood pump rotor speed (measured) overridden to " + str_res + " RPM: " + - 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_blood_flow_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: - """ - Constructs and sends the measured blood flow 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_BLOOD_PUMP_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override blood flow broadcast interval") - - # 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(ms) + " ms: " - self.logger.debug("Blood flow 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_blood_pump_rotor_count_override(self, rot_count: int, reset: int = NO_RESET) -> int: """ Constructs and sends the blood pump rotor count override command @@ -329,35 +247,21 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) cnt = integer_to_bytearray(rot_count) payload = rst + cnt - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BLOOD_PUMP_ROTOR_COUNT_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BLOOD_PUMP_ROTOR_COUNT_OVERRIDE_REQUEST, + entity_name = f'TD Blood Flow rotor count', + override_text = f'{str(rot_count)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override blood pump rotor count") - # 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(rot_count) + ": " - self.logger.debug("Blood pump rotor count 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_home_blood_pump(self) -> int: """ Constructs and sends home blood pump command. @@ -366,23 +270,17 @@ @return: 1 if successful, zero otherwise """ + return cmd_generic_override( + payload = None, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_HOME_BLOOD_PUMP_REQUEST, + entity_name = f'TD Blood Flow homing', + override_text = f'Active', + logger = self.logger, + can_interface = self.can_interface) - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_HOME_BLOOD_PUMP_REQUEST.value) - self.logger.debug("homing blood pump") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return True - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_hard_stop_blood_pump(self) -> int: """ Constructs and sends hard stop blood pump command. @@ -391,22 +289,17 @@ @return: 1 if successful, zero otherwise """ - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_HARD_STOP_BLOOD_PUMP.value) + return cmd_generic_override( + payload = None, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_HARD_STOP_BLOOD_PUMP, + entity_name = f'TD Blood Flow Pump hard stop', + override_text = f'Active', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("Hard stopping blood pump") - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return True - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_blood_flow_alpha_y_intercept_override(self, intercept: float, reset: int = NO_RESET) -> int: """ Constructs and sends the blood flow alpha y intercept override. @@ -418,26 +311,21 @@ @return: 1 if successful, zero otherwise """ - reset_byte_array = integer_to_bytearray(reset) intercept_byte_array = float_to_bytearray(intercept) payload = reset_byte_array + intercept_byte_array - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BLOOD_FLOW_ALPHA_Y_INTERCEPT_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BLOOD_FLOW_ALPHA_Y_INTERCEPT_OVERRIDE_REQUEST, + entity_name = f'TD Blood Flow alpha Y intercept', + override_text = f'{str(intercept)}', + 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: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.error("Timeout!!!!") - return False - def cmd_blood_flow_wear_a_term_override(self, a_term: float, reset: int = NO_RESET) -> int: """ Constructs and sends the blood flow wear a term override @@ -449,26 +337,21 @@ @return: 1 if successful, zero otherwise """ - reset_byte_array = integer_to_bytearray(reset) term_byte_array = float_to_bytearray(a_term) payload = reset_byte_array + term_byte_array - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BLOOD_FLOW_WEAR_A_TERM_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BLOOD_FLOW_WEAR_A_TERM_OVERRIDE_REQUEST, + entity_name = f'TD Blood Flow wear A term', + override_text = f'{str(a_term)}', + 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: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.error("Timeout!!!!") - return False - def cmd_blood_flow_wear_b_term_override(self, b_term: float, reset: int = NO_RESET) -> int: """ Constructs and sends the blood flow wear b term override @@ -480,22 +363,16 @@ @return: 1 if successful, zero otherwise """ - reset_byte_array = integer_to_bytearray(reset) term_byte_array = float_to_bytearray(b_term) payload = reset_byte_array + term_byte_array - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BLOOD_FLOW_WEAR_B_TERM_OVERRIDE_REQUEST.value, - payload=payload) - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.error("Timeout!!!!") - return False \ No newline at end of file + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BLOOD_FLOW_WEAR_B_TERM_OVERRIDE_REQUEST, + entity_name = f'TD Blood Flow wear B term', + override_text = f'{str(b_term)}', + logger = self.logger, + can_interface = self.can_interface) Index: leahi_dialin/td/modules/bubble_detector.py =================================================================== diff -u -rec8a2600b9e8cf6fe7e02c200a1c24221ca86863 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/bubble_detector.py (.../bubble_detector.py) (revision ec8a2600b9e8cf6fe7e02c200a1c24221ca86863) +++ leahi_dialin/td/modules/bubble_detector.py (.../bubble_detector.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,19 +7,21 @@ # # @file air_bubbles.py # -# @author (last) Sean Nash -# @date (last) 04-May-2023 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Peman Montazemi # @date (original) 18-May-2021 # ############################################################################ + import struct from logging import Logger -from .constants import RESET, NO_RESET +from .constants import NO_RESET 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.common.td_defs import TDAirBubbleDetectorNames, TDAirBubbleDetectorAttributes -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels +from leahi_dialin.protocols.CAN import DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish from leahi_dialin.utils.conversions import integer_to_bytearray @@ -69,6 +71,7 @@ } } + @publish(["msg_id_td_bubbles_data", "h18_bubble_detector", "td_air_bubbles_timestamp"]) def _handler_air_bubbles_data_sync(self, message, timestamp=0.0): """ @@ -77,14 +80,35 @@ @param message: published air bubbles data message as: h18 bubble status, h18 bubble state @return: None """ - self.h18_bubble_detector[TDAirBubbleDetectorNames.H18_ADV.name][TDAirBubbleDetectorAttributes.STATUS.name] = ( struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])))[0] self.h18_bubble_detector[TDAirBubbleDetectorNames.H18_ADV.name][TDAirBubbleDetectorAttributes.STATE.name] = ( struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2])))[0] self.td_air_bubbles_timestamp = timestamp + + def cmd_air_bubbles_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the air bubbles data broadcast interval override command + Constraints: + Must be logged into TD. + Given interval must be positive non-zero and a multiple of the TD priority 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 = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BUBBLE_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Air Bubble Detector', + logger = self.logger, + can_interface = self.can_interface) + + def cmd_air_bubble_status_override(self, index: int, status: int, reset: int = NO_RESET) -> int: """ Constructs and sends the air bubble detector status override command @@ -103,66 +127,13 @@ stat = integer_to_bytearray(status) payload = rst + stat + i - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BUBBLE_OVERRIDE_REQUEST.value, - payload=payload) - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - - def cmd_air_bubbles_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: - """ - Constructs and sends the air bubbles data broadcast interval override command - Constraints: - Must be logged into TD. - Given interval must be positive non-zero and a multiple of the TD priority 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 ms > 0 and ms % 50 == 0: - 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_BUBBLE_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("Override TD air bubbles data broadcast interval to"+str(ms)+"ms") - - # 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("Air bubbles data 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 - elif ms <= 0: - self.logger.debug("ms must be positive non-zero.") - return False - elif ms % 50 != 0: - self.logger.debug("ms must be a multiple of 50.") - return False - else: - self.logger.debug("ms must be an integer.") - return False \ No newline at end of file + sensor_name = TDAirBubbleDetectorNames(index).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BUBBLE_OVERRIDE_REQUEST, + entity_name = f'TD {sensor_name} Bubble Detector status', + override_text = f'{str(status)}', + logger = self.logger, + can_interface = self.can_interface) Index: leahi_dialin/td/modules/buttons.py =================================================================== diff -u -rec8a2600b9e8cf6fe7e02c200a1c24221ca86863 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/buttons.py (.../buttons.py) (revision ec8a2600b9e8cf6fe7e02c200a1c24221ca86863) +++ leahi_dialin/td/modules/buttons.py (.../buttons.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,18 +7,20 @@ # # @file buttons.py # -# @author (last) Micahel Garthwaite -# @date (last) 05-Nov-2024 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Peter Lucia # @date (original) 14-Oct-2024 # ############################################################################ + import struct from logging import Logger -from .constants import RESET, NO_RESET +from leahi_dialin.common.constants import NO_RESET from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliCanMessenger, DenaliChannels +from leahi_dialin.common.override_templates import cmd_generic_override +from leahi_dialin.protocols.CAN import DenaliCanMessenger, DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish from leahi_dialin.utils.conversions import integer_to_bytearray @@ -34,7 +36,6 @@ @param can_interface: the Denali CAN interface object """ - super().__init__() self.can_interface = can_interface self.logger = logger @@ -47,15 +48,16 @@ self._handler_poweroff_timeout_occurred) self.td_power_off_timestamp = 0.0 + def reset_poweroff_timeout_expired(self): """ Resets the dialin poweroff timeout flag to False @return: None """ - self.poweroff_timeout_expired = False + @publish(['msg_id_off_button_press_request', 'poweroff_timeout_expired', 'td_power_off_timestamp']) def _handler_poweroff_timeout_occurred(self, message, timestamp=0.0): """ @@ -75,6 +77,7 @@ self.poweroff_timeout_expired = bool(mode[0]) self.td_power_off_timestamp = timestamp + def cmd_off_button_override(self, state: int, reset: int = NO_RESET) -> int: """ Constructs and sends the Off button override command @@ -92,30 +95,18 @@ sta = integer_to_bytearray(state) payload = rst + sta - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_OFF_BUTTON_OVERRIDE_REQUEST.value, - payload=payload) + state_name = 'Pressed' if state == 1 else 'Released' + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_OFF_BUTTON_OVERRIDE_REQUEST, + entity_name = f'TD Off Button', + override_text = f'{state_name}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override off button") - # 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 = ("pressed" if state != 0 else "released") - - self.logger.debug("Off button 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_stop_button_override(self, state: int, reset: int = NO_RESET) -> int: """ Constructs and sends the Stop button override command @@ -133,26 +124,13 @@ sta = integer_to_bytearray(state) payload = rst + sta - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_STOP_BUTTON_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override stop button") - - # 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 = ("pressed" if state != 0 else "released") - self.logger.debug("Stop button 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 + state_name = 'Pressed' if state == 1 else 'Released' + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_STOP_BUTTON_OVERRIDE_REQUEST, + entity_name = f'TD Stop Button', + override_text = f'{state_name}', + logger = self.logger, + can_interface = self.can_interface) Index: leahi_dialin/td/modules/ejector.py =================================================================== diff -u -r6944f314294da17334cb50aea33b044c83daa95d -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/ejector.py (.../ejector.py) (revision 6944f314294da17334cb50aea33b044c83daa95d) +++ leahi_dialin/td/modules/ejector.py (.../ejector.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -17,12 +17,12 @@ import struct from logging import Logger -from .constants import RESET, NO_RESET +from leahi_dialin.common.constants import NO_RESET 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.common.td_defs import TDEjectorNames, TDEjectorAttributes -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels +from leahi_dialin.protocols.CAN import DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish -from leahi_dialin.utils.checks import check_broadcast_interval_override_ms from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray @@ -58,6 +58,7 @@ } self.td_ejector_timestamp = 0 + @publish(["msg_id_td_ejector_data", "h5_motor", "td_ejector_timestamp"]) def _handler_ejector_sync(self, message, timestamp=0.0): """ @@ -77,6 +78,7 @@ self.td_ejector_timestamp = timestamp + def cmd_ejector_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the ejector motor data broadcast interval override command @@ -88,37 +90,16 @@ @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 = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_EJECTOR_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Ejector', + logger = self.logger, + can_interface = self.can_interface) - 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_EJECTOR_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override TD ejector data 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("ejector data 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_ejector_request_command(self, cmd: int) -> int: """ Constructs and sends the ejector request command. @@ -135,23 +116,17 @@ idx = integer_to_bytearray(cmd) payload = idx - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_EJECTOR_COMMAND.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_EJECTOR_COMMAND, + entity_name = f'TD Ejector state', + override_text = f'{str(cmd)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("setting ejector state to" + str(cmd)) - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_ejector_set_motor_speed_request(self, speed: int) -> int: """ Constructs and sends the ejector set speed command. Negative values imply reverse ( retract ) direction. @@ -166,23 +141,17 @@ spd = float_to_bytearray(speed) payload = spd - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_EJECTOR_MOTOR_SET_SPEED_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_EJECTOR_MOTOR_SET_SPEED_REQUEST, + entity_name = f'TD Ejector speed', + override_text = f'{str(speed)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("setting ejector set speed to" + str(spd)) - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_ejector_optical_sensor_override(self, sensor: int, sensor_active: int, reset: int = NO_RESET) -> int: """ Constructs and sends the ejector optical sensor override command @@ -206,24 +175,13 @@ active = integer_to_bytearray(sensor_active) payload = rst + active + sen - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_EJECTOR_OPT_SENSOR_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("Override sensor ID {} to {}".format(sen, active)) - - # 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 = "Override sensor {} to {}".format(sen, active) - self.logger.debug(str_res) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False + sensor_name = 'H25 Retract' if sensor == 0 else 'H24 Engage' + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_EJECTOR_OPT_SENSOR_OVERRIDE_REQUEST, + entity_name = f'TD Ejector {sensor_name} Optical Sensor', + override_text = f'{str(sensor_active)}', + logger = self.logger, + can_interface = self.can_interface) Index: leahi_dialin/td/modules/events.py =================================================================== diff -u -r7d9d004527efeccb91958b440abdff08c2c52648 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/events.py (.../events.py) (revision 7d9d004527efeccb91958b440abdff08c2c52648) +++ leahi_dialin/td/modules/events.py (.../events.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,21 +7,24 @@ # # @file events.py # -# @author (last) Jonny Paguio -# @date (last) 16-Sep-2025 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Dara Navaei # @date (original) 12-Oct-2021 # ############################################################################ import struct from logging import Logger -from leahi_dialin.common import * +from datetime import datetime +from time import time + +from leahi_dialin.common.td_defs import TDEventList, TDEventDataType, TDOpModes, TDFaultStates, \ + TDServiceStates, TDInitStates, TDStandbyStates, TDTreatmentParamStates, TDPreTreatmentModesStates, \ + TDTreatmentStates, TDPostTreatmentStates, TDNotLegalStates 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 datetime import datetime -from time import time class TDEvents(AbstractSubSystem): @@ -90,6 +93,7 @@ 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 @@ -110,6 +114,7 @@ return event + def clear_td_event_list(self): """ Clears the TD event list @@ -119,6 +124,7 @@ for key in self._td_event_dictionary: self._td_event_dictionary[key].clear() + def get_td_events(self, event_id, number_of_events=1): """ Returns the requested number of a certain TD event ID @@ -146,6 +152,7 @@ return list_of_events + @publish(["msg_id_td_event", "td_events_timestamp", '_td_event_dictionary']) def _handler_events_sync(self, message, timestamp=0.0): """ @@ -285,6 +292,7 @@ self._td_event_dictionary[event_state_name].append(event_tuple) self.td_events_timestamp = timestamp + @publish(["msg_id_td_op_mode_data", "td_event_op_mode_timestamp", "td_event_op_mode", "td_event_sub_mode"]) def _handler_td_op_mode_sync(self, message, timestamp=0.0): """ @@ -302,4 +310,4 @@ self.td_event_op_mode = mode[0] self.td_event_sub_mode = smode[0] - self.td_event_op_mode_timestamp = timestamp \ No newline at end of file + self.td_event_op_mode_timestamp = timestamp Index: leahi_dialin/td/modules/pressure_sensors.py =================================================================== diff -u -rf762fd31ac5b03734f000f9fcd671851581def8a -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/pressure_sensors.py (.../pressure_sensors.py) (revision f762fd31ac5b03734f000f9fcd671851581def8a) +++ leahi_dialin/td/modules/pressure_sensors.py (.../pressure_sensors.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -19,8 +19,8 @@ from leahi_dialin.common.constants import NO_RESET from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -from leahi_dialin.common.td_defs import TDPressureSensorNames, TDPressureSensorAttributes from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override +from leahi_dialin.common.td_defs import TDPressureSensorNames, TDPressureSensorAttributes from leahi_dialin.protocols.CAN import DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray @@ -141,13 +141,12 @@ @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 = DenaliChannels.dialin_to_td_ch_id, msg_id = MsgIds.MSG_ID_TD_PRESSURE_PUBLISH_INTERVAL_OVERRIDE_REQUEST, - module_name = 'TD pressure sensors', + module_name = 'TD Pressure Sensors', logger = self.logger, can_interface = self.can_interface) @@ -164,7 +163,6 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) sen = integer_to_bytearray(sensor) prs = float_to_bytearray(pressure) @@ -203,7 +201,7 @@ reset = reset, channel_id = DenaliChannels.dialin_to_td_ch_id, msg_id = MsgIds.MSG_ID_TD_TMP_PRESSURE_OVERRIDE_REQUEST, - entity_name = 'TD TMP Pressure Sensor', + entity_name = 'TD TMP Pressure Sensor pressure', override_text = str(prs) + " mmHg. ", logger = self.logger, can_interface = self.can_interface) Index: leahi_dialin/td/modules/switches.py =================================================================== diff -u -rec8a2600b9e8cf6fe7e02c200a1c24221ca86863 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/switches.py (.../switches.py) (revision ec8a2600b9e8cf6fe7e02c200a1c24221ca86863) +++ leahi_dialin/td/modules/switches.py (.../switches.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,24 +7,23 @@ # # @file switches.py # -# @author (last) Micahel Garthwaite -# @date (last) 03-Mar-2023 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Dara Navaei # @date (original) 25-Jul-2021 # ############################################################################ import struct -from enum import unique from logging import Logger -from leahi_dialin.utils.conversions import integer_to_bytearray +from leahi_dialin.common.constants import NO_RESET 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.common.td_defs import TDSwitchStatus, TDSwitchesNames -from .constants import RESET, NO_RESET -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.protocols.CAN import DenaliChannels +from leahi_dialin.utils.base import AbstractSubSystem, publish +from leahi_dialin.utils.conversions import integer_to_bytearray class TDSwitches(AbstractSubSystem): @@ -51,6 +50,7 @@ self.td_switches_status = {TDSwitchesNames.H9_FRONT_DOOR.name: TDSwitchStatus.CLOSED.value} self.td_switches_timestamp = 0.0 + @publish(["msg_id_td_switches_data", "td_switches_status", "td_switches_timestamp"]) def _handler_switches_sync(self, message, timestamp=0.0): """ @@ -65,82 +65,51 @@ self.td_switches_status[TDSwitchesNames.H9_FRONT_DOOR.name] = TDSwitchStatus(front_door).value self.td_switches_timestamp = timestamp - def cmd_switch_status_override(self, switch: int, status: int, reset: int = NO_RESET) -> int: + + def cmd_switches_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ - Constructs and sends the TD switch status override command + Constructs and sends the TD switch data publication 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 switch: (int) switch ID that is status is overridden - @param status: (int) status that the switch will be overridden to + @param ms: (int) interval (in ms) to override with @param reset: (int) 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - reset_value = integer_to_bytearray(reset) - sw = integer_to_bytearray(switch) - st = integer_to_bytearray(status) - payload = reset_value + st + sw + return cmd_generic_broadcast_interval_override( + ms = ms, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_SWITCHES_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Switches', + logger = self.logger, + can_interface = self.can_interface) - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_SWITCH_STATE_OVERRIDE_REQUEST.value, - payload=payload) - self.logger.debug("Override switch status") - - # Send message - received_message = self.can_interface.send(message) - - # If there is no content... - if received_message is not None: - - self.logger.debug("Switch " + str(TDSwitchesNames(switch).name) + " to: " + - 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_switches_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + def cmd_switch_status_override(self, switch: int, status: int, reset: int = NO_RESET) -> int: """ - Constructs and sends the TD switch data publication override command. + Constructs and sends the TD switch status 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: (int) interval (in ms) to override with + @param switch: (int) switch ID that is status is overridden + @param status: (int) status that the switch will be overridden to @param reset: (int) 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ + reset_value = integer_to_bytearray(reset) + sw = integer_to_bytearray(switch) + st = integer_to_bytearray(status) + payload = reset_value + st + sw - 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_SWITCHES_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("Override TD switches data broadcast interval") - - # 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(mis) - self.logger.debug( - "TD Switches data broadcast interval 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 + switch_name = TDSwitchesNames(switch).name + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_SWITCH_STATE_OVERRIDE_REQUEST, + entity_name = f'TD {switch_name} Switch status', + override_text = f'{str(status)}', + logger = self.logger, + can_interface = self.can_interface) Index: leahi_dialin/td/modules/td_test_configs.py =================================================================== diff -u -rec8a2600b9e8cf6fe7e02c200a1c24221ca86863 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/td_test_configs.py (.../td_test_configs.py) (revision ec8a2600b9e8cf6fe7e02c200a1c24221ca86863) +++ leahi_dialin/td/modules/td_test_configs.py (.../td_test_configs.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -7,21 +7,22 @@ # # @file td_test_configs.py # -# @author (last) Jonny Paguio -# @date (last) 22-Aug-2025 +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 # @author (original) Jonny Paguio # @date (original) 20-Aug-2025 # ############################################################################ from logging import Logger +from leahi_dialin.common.constants import NO_RESET from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions +from leahi_dialin.common.override_templates import cmd_generic_override from leahi_dialin.common.test_config_defs import TDTestConfigOptions -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels -from .constants import NO_RESET -from leahi_dialin.utils.conversions import integer_to_bytearray, bytearray_to_integer +from leahi_dialin.protocols.CAN import DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish +from leahi_dialin.utils.conversions import integer_to_bytearray, bytearray_to_integer class TDTestConfig(AbstractSubSystem): @@ -60,6 +61,25 @@ return self.td_test_configs[TDTestConfigOptions(config).name] + @publish(['msg_id_td_send_test_config', 'td_test_configs', 'td_test_configs_response_timestamp']) + def _handler_td_test_config_sync(self, message, timestamp=0.0): + """ + Handles published test configuration status messages. + + @param message: published TD test configurations message + @return: None + """ + payload = message['message'] + index = MsgFieldPositions.START_POS_FIELD_1 + + for config in TDTestConfigOptions.__members__: + if 'NUM_OF_TEST_CONFIGS' not in config: + config_value, index = bytearray_to_integer(payload, index, False) + self.td_test_configs[config] = config_value + + self.td_test_configs_response_timestamp = timestamp + + def cmd_set_test_config(self, config: int, reset: int = NO_RESET): """ Constructs and sends the TD test config @@ -73,27 +93,22 @@ reset_value = integer_to_bytearray(reset) c = integer_to_bytearray(config) payload = reset_value + c + + response = cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_SET_TEST_CONFIGURATION, + entity_name = f'TD {TDTestConfigOptions(config).name} Test Config', + override_text = 'Active', + logger = self.logger, + can_interface = self.can_interface) - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_SET_TEST_CONFIGURATION.value, - payload=payload) + # Update the stored test configs from the FW + self.cmd_request_test_config_status_from_fw() + return response + - if reset == NO_RESET: - self.logger.debug("Setting {}".format(TDTestConfigOptions(config).name)) - else: - self.logger.debug("Resetting {}".format(TDTestConfigOptions(config).name)) - - # Send message - received_message = self.can_interface.send(message) - - # If there is no content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_request_test_config_status_from_fw(self): """ Constructs and sends the TD test configs request @@ -102,26 +117,17 @@ @return: 1 if successful, zero otherwise """ - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_GET_TEST_CONFIGURATION.value) + return cmd_generic_override( + payload = None, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_GET_TEST_CONFIGURATION, + entity_name = f'Get TD Test Configuration Record', + override_text = 'Active', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug('Getting TD test configuration record') - # Reset the test configs regardless of whether the message has been acknowledged or not. The reset might be out - # sync and reset the test configuration while the latest data has been received. If the test configuration is - # reset in Dialin but the message was not acknowledged, the user shall send the request again - self._reset_test_configs_record() - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - self.logger.debug("Received FW ACK after requesting TD test configuration record.") - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_reset_all_test_configs(self): """ Constructs and sends the TD test configs reset all @@ -130,47 +136,16 @@ @return: 1 if successful, zero otherwise """ - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_RESET_ALL_TEST_CONFIGURATIONS.value) - - self.logger.debug("Resetting all TD test configurations") - - # Send message - received_message = self.can_interface.send(message) - - # If there is no content... - if received_message is not None: - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - - @publish(['msg_id_td_send_test_config', 'td_test_configs', 'td_test_configs_response_timestamp']) - def _handler_td_test_config_sync(self, message, timestamp=0.0): - """ - Handles published test configuration status messages. - - @param message: published TD test configurations message - @return: None - """ - payload = message['message'] - index = MsgFieldPositions.START_POS_FIELD_1 - - for config in TDTestConfigOptions.__members__: - if 'NUM_OF_TEST_CONFIGS' not in config: - config_value, index = bytearray_to_integer(payload, index, False) - self.td_test_configs[config] = config_value - - self.td_test_configs_response_timestamp = timestamp - - def _reset_test_configs_record(self): - """ - Resets the test configuration dictionary - - @return: None - """ - for config in TDTestConfigOptions.__members__: - # Loop through the list of the test configuration and set the values to 0xFFFFFFFF - if 'NUM_OF_TEST_CONFIGS' not in config: - self.td_test_configs[config] = 0xFFFFFFFF \ No newline at end of file + response = cmd_generic_override( + payload = None, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_RESET_ALL_TEST_CONFIGURATIONS, + entity_name = f'Reset all TD Test Configurations', + override_text = 'Active', + logger = self.logger, + can_interface = self.can_interface) + + # Update the stored test configs from the FW + self.cmd_request_test_config_status_from_fw() + return response Index: leahi_dialin/td/modules/temperature_sensors.py =================================================================== diff -u -r6e0b0571d3f4064c8d7bb2b737e326c460780759 -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/td/modules/temperature_sensors.py (.../temperature_sensors.py) (revision 6e0b0571d3f4064c8d7bb2b737e326c460780759) +++ leahi_dialin/td/modules/temperature_sensors.py (.../temperature_sensors.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -1,13 +1,28 @@ +########################################################################### +# +# Copyright (c) 2020-2025 Diality Inc. - All Rights Reserved. +# +# THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN +# WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. +# +# @file temperature_sensors.py +# +# @author (last) Zoltan Miskolci +# @date (last) 08-Jan-2026 +# @author (original) Dara Navaei +# @date (original) 09-Nov-2020 +# +############################################################################ import struct from logging import Logger from .constants import RESET, NO_RESET 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.common.td_defs import TDTemperatureSensorNames -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels +from leahi_dialin.protocols.CAN import DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish -from leahi_dialin.utils.checks import check_broadcast_interval_override_ms from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray @@ -33,6 +48,7 @@ self.td_temperatures_status = {TDTemperatureSensorNames.H23_TEMP.name: 0.0} self.td_temperature_timestamp = 0.0 + @publish(["msg_id_td_temperature_data", "td_temperatures_status", "td_temperature_timestamp" @@ -51,86 +67,52 @@ self.td_temperatures_status[TDTemperatureSensorNames.H23_TEMP.name] = baro self.td_temperature_timestamp = timestamp - def cmd_temperature_sensor_override(self, sensor: int, temperature: float, reset: int = NO_RESET) -> int: + + def cmd_temperature_sensors_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ - Constructs and sends the measured temperature sensor override command - . + Constructs and sends the measured temperature sensors 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 sensor: int - sensor ID - @param temperature: float - measured temperature in C + @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 = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_TEMPERATURE_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Temperature Sensors', + logger = self.logger, + can_interface = self.can_interface) - rst = integer_to_bytearray(reset) - sen = integer_to_bytearray(sensor) - prs = float_to_bytearray(temperature) - payload = rst + prs + sen - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_TEMPERATURE_OVERRIDE.value, - payload=payload) - - self.logger.debug("override temperature sensor") - - # 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(prs) + " C. " - self.logger.debug("temperature (measured)) 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_temperature_sensors_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + def cmd_temperature_sensor_override(self, sensor: int, temperature: float, reset: int = NO_RESET) -> int: """ - Constructs and sends the measured temperature sensors broadcast interval override command + Constructs and sends the measured temperature sensor 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 sensor: int - sensor ID + @param temperature: float - measured temperature in C @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 + sen = integer_to_bytearray(sensor) + prs = float_to_bytearray(temperature) + payload = rst + prs + sen - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_TEMPERATURE_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override temperature sensors broadcast interval") - - # 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(ms) + " ms: " - self.logger.debug("Temperature sensors 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 \ No newline at end of file + sensor_name = TDTemperatureSensorNames(sensor).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_TEMPERATURE_OVERRIDE, + entity_name = f'TD {sensor_name} Temperature Sensor temperature', + override_text = f'{str(temperature)} C', + logger = self.logger, + can_interface = self.can_interface) Index: leahi_dialin/utils/checks.py =================================================================== diff -u -r2138d06d100fdcf23f2e9069f35ee2fdee62008f -r03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93 --- leahi_dialin/utils/checks.py (.../checks.py) (revision 2138d06d100fdcf23f2e9069f35ee2fdee62008f) +++ leahi_dialin/utils/checks.py (.../checks.py) (revision 03dc6c3ff80d7f76a5b6438ba067e02a37e2ce93) @@ -14,14 +14,24 @@ # ############################################################################ -def check_broadcast_interval_override_ms(ms: int): +from logging import Logger + + +def check_broadcast_interval_override_ms(ms: int, logger: Logger): """ Checks whether a given broadcast interval override (in ms) is valid. @param ms: (int) number of ms being used to override a broadcast interval @return: True if valid, False if not """ - result = False if ms > 0 and ms % 50 == 0: - result = True - return result + return True + elif ms <= 0: + logger.debug("ms must be positive non-zero.") + return False + elif ms % 50 != 0: + logger.debug("ms must be a multiple of 50.") + return False + else: + logger.debug("ms must be an integer.") + return False