Index: leahi_dialin/dd/modules/heaters.py =================================================================== diff -u -r0114616a15c2e55ffbd4c6bb4535dd8dbb92880b -r38e8dd31728056dbb7f9304c98ab16d7147b75a2 --- leahi_dialin/dd/modules/heaters.py (.../heaters.py) (revision 0114616a15c2e55ffbd4c6bb4535dd8dbb92880b) +++ leahi_dialin/dd/modules/heaters.py (.../heaters.py) (revision 38e8dd31728056dbb7f9304c98ab16d7147b75a2) @@ -7,184 +7,186 @@ # # @file heaters.py # -# @author (last) Michael Garthwaite -# @date (last) 28-Oct-2024 +# @author (last) Zoltan Miskolci +# @date (last) 07-Jan-2026 # @author (original) Dara Navaei # @date (original) 29-May-2020 # ############################################################################ import struct -from enum import unique from logging import Logger -from .constants import NO_RESET +from leahi_dialin.common.constants import NO_RESET +from leahi_dialin.common.dd_defs import dd_enum_repository from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -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.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override +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 -@unique -class HeatersStartStop(DialinEnum): - STOP = 0 - START = 1 - - -@unique -class HeatersState(DialinEnum): - HEATER_EXEC_STATE_OFF = 0 - HEATER_EXEC_STATE_PRIMARY_RAMP_TO_TARGET = 1 - HEATER_EXEC_STATE_PRIMARY_CONTROL_TO_TARGET = 2 - HEATER_EXEC_STATE_CONTROL_TO_DISINFECT_TARGE = 3 - HEATER_EXEC_STATE_TRIMMER_RAMP_TO_TARGET = 4 - HEATER_EXEC_STATE_TRIMMER_CONTROL_TO_TARGET = 5 - NUM_OF_HEATERS_STATE = 6 - - -@unique -class HeatersNames(DialinEnum): - DD_PRIMARY_HEATER = 0 - DD_TRIMMER_HEATER = 1 - NUM_OF_DD_HEATERS = 2 - - class DDHeaters(AbstractSubSystem): """ - Dialysate Delivery (DD) Dialin API sub-class for heaters related commands. """ def __init__(self, can_interface, logger: Logger): """ - @param can_interface: Denali CAN Messenger object """ - super().__init__() self.can_interface = can_interface self.logger = logger - self.main_primary_heater_duty_cycle = 0.0 - self.trimmer_heater_duty_cycle = 0.0 - self.primary_heaters_target_temperature = 0.0 - self.trimmer_heater_target_temperature = 0.0 - self.primary_heater_state = 0 - self.trimmer_heater_state = 0 - self.primary_control_counter = 0 - self.trimmer_control_counter = 0 + self.dd_heaters = { + dd_enum_repository.DDHeaterNames.D5_HEAT.name: { + dd_enum_repository.DDHeaterAttributes.HEAT_DUTY_CYCLE.name: 0.0, + dd_enum_repository.DDHeaterAttributes.HEAT_TARGET_TEMP.name: 0.0, + dd_enum_repository.DDHeaterAttributes.HEAT_STATE.name: 0, + dd_enum_repository.DDHeaterAttributes.DUTY_CYCLE_COUNT.name: 0.0, + dd_enum_repository.DDHeaterAttributes.PWM_PERIOD.name: 0.0, + dd_enum_repository.DDHeaterAttributes.ADJUSTED_TARGET_TEMP.name: 0.0, + dd_enum_repository.DDHeaterAttributes.TARGET_TEMP_TD.name: 0.0 + }, + dd_enum_repository.DDHeaterNames.D45_HEAT.name: { + dd_enum_repository.DDHeaterAttributes.HEAT_DUTY_CYCLE.name: 0.0, + dd_enum_repository.DDHeaterAttributes.HEAT_TARGET_TEMP.name: 0.0, + dd_enum_repository.DDHeaterAttributes.HEAT_STATE.name: 0, + dd_enum_repository.DDHeaterAttributes.DUTY_CYCLE_COUNT.name: None, # D45 Heater doesn't use this attribute + dd_enum_repository.DDHeaterAttributes.PWM_PERIOD.name: None, # D45 Heater doesn't use this attribute + dd_enum_repository.DDHeaterAttributes.ADJUSTED_TARGET_TEMP.name: None, # D45 Heater doesn't use this attribute + dd_enum_repository.DDHeaterAttributes.TARGET_TEMP_TD.name: None # D45 Heater doesn't use this attribute + } + } + + #Temp Heater Debugging published fields + self.dbg1 = 0.0 + self.dbg2 = 0.0 + self.dbg3 = 0.0 + self.dbg4 = 0.0 + self.dbg5 = 0.0 + self.dbg6 = 0.0 + self.dbg7 = 0.0 + self.dbg8 = 0.0 + self.dbg9 = 0.0 + self.dd_heaters_timestamp = 0.0 if self.can_interface is not None: channel_id = DenaliChannels.dd_sync_broadcast_ch_id - msg_id = MsgIds.MSG_ID_DD_HEATERS_DATA.value - self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_heaters_sync) + self.msg_id_dd_heaters_data = MsgIds.MSG_ID_DD_HEATERS_DATA.value + self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_dd_heaters_data, self._handler_heaters_sync) - @publish(["dd_heaters_timestamp", - "main_primary_heater_duty_cycle","trimmer_heater_duty_cycle", - "primary_heaters_target_temperature","trimmer_heater_target_temperature", - "primary_heater_state","trimmer_heater_state", - "primary_control_counter","trimmer_control_counter"]) + + @publish(["msg_id_dd_heaters_data", "dd_heaters", + "dbg1", "dbg2", "dbg3", "dbg4", "dbg5", "dbg6", "dbg7", "dbg8", "dbg9", + "dd_heaters_timestamp"]) def _handler_heaters_sync(self, message, timestamp=0.0): """ - Handles published heaters message + Handles published DD heaters message - @param message: published heaters data message + @param message: published DD heaters data message @returns none """ - self.main_primary_heater_duty_cycle = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] - self.trimmer_heater_duty_cycle = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] - self.primary_heaters_target_temperature = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] - self.trimmer_heater_target_temperature = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] - self.primary_heater_state = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] - self.trimmer_heater_state = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6]))[0] - self.primary_control_counter = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7]))[0] - self.trimmer_control_counter = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8]))[0] + self.dd_heaters[dd_enum_repository.DDHeaterNames.D5_HEAT.name][dd_enum_repository.DDHeaterAttributes.HEAT_DUTY_CYCLE.name] = ( + struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])))[0] + self.dd_heaters[dd_enum_repository.DDHeaterNames.D45_HEAT.name][dd_enum_repository.DDHeaterAttributes.HEAT_DUTY_CYCLE.name] = ( + struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2])))[0] + self.dd_heaters[dd_enum_repository.DDHeaterNames.D5_HEAT.name][dd_enum_repository.DDHeaterAttributes.HEAT_TARGET_TEMP.name] = ( + struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3])))[0] + self.dd_heaters[dd_enum_repository.DDHeaterNames.D45_HEAT.name][dd_enum_repository.DDHeaterAttributes.HEAT_TARGET_TEMP.name] = ( + struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4])))[0] + self.dd_heaters[dd_enum_repository.DDHeaterNames.D5_HEAT.name][dd_enum_repository.DDHeaterAttributes.HEAT_STATE.name] = ( + struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5])))[0] + self.dd_heaters[dd_enum_repository.DDHeaterNames.D45_HEAT.name][dd_enum_repository.DDHeaterAttributes.HEAT_STATE.name] = ( + struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6])))[0] + self.dd_heaters[dd_enum_repository.DDHeaterNames.D5_HEAT.name][dd_enum_repository.DDHeaterAttributes.DUTY_CYCLE_COUNT.name] = ( + struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7])))[0] + self.dd_heaters[dd_enum_repository.DDHeaterNames.D5_HEAT.name][dd_enum_repository.DDHeaterAttributes.PWM_PERIOD.name] = ( + struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8])))[0] + self.dd_heaters[dd_enum_repository.DDHeaterNames.D5_HEAT.name][dd_enum_repository.DDHeaterAttributes.ADJUSTED_TARGET_TEMP.name] = ( + struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_9:MsgFieldPositions.END_POS_FIELD_9])))[0] + self.dd_heaters[dd_enum_repository.DDHeaterNames.D5_HEAT.name][dd_enum_repository.DDHeaterAttributes.TARGET_TEMP_TD.name] = ( + struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_10:MsgFieldPositions.END_POS_FIELD_10])))[0] - self.dg_heaters_timestamp = timestamp + self.dbg1 = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_11:MsgFieldPositions.END_POS_FIELD_11]))[0] + self.dbg2 = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_12:MsgFieldPositions.END_POS_FIELD_12]))[0] + self.dbg3 = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_13:MsgFieldPositions.END_POS_FIELD_13]))[0] + self.dbg4 = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_14:MsgFieldPositions.END_POS_FIELD_14]))[0] + self.dbg5 = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_15:MsgFieldPositions.END_POS_FIELD_15]))[0] + self.dbg6 = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_16:MsgFieldPositions.END_POS_FIELD_16]))[0] + self.dbg7 = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_17:MsgFieldPositions.END_POS_FIELD_17]))[0] + self.dbg8 = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_18:MsgFieldPositions.END_POS_FIELD_18]))[0] + self.dbg9 = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_19:MsgFieldPositions.END_POS_FIELD_19]))[0] + self.dd_heaters_timestamp = timestamp + + def cmd_heaters_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends broadcast time interval. Constraints: - Must be logged into DG. - Given interval must be non-zero and a multiple of the DG general task interval (50 ms). + Must be logged into DD. + Given interval must be non-zero and a multiple of the DD general task interval (50 ms). @param ms: (int) Publish time interval in ms @param reset: (int) 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ - if not check_broadcast_interval_override_ms(ms): - return False + return cmd_generic_broadcast_interval_override( + ms = ms, + reset = reset, + channel_id = DenaliChannels.dialin_to_dd_ch_id, + msg_id = MsgIds.MSG_ID_DD_HEATERS_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'DD Heaters', + logger = self.logger, + can_interface = self.can_interface) - reset_value = integer_to_bytearray(reset) - interval_value = integer_to_bytearray(ms) - payload = reset_value + interval_value - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, - message_id=MsgIds.MSG_ID_DD_HEATERS_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("Sending {} ms publish interval to the Heaters module".format(ms)) - # Send message - received_message = self.can_interface.send(message) - - # If there is content in message - if received_message is not None: - # Response payload is OK or not - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_heater_duty_cycle_override(self, heater: int, duty_cycle: float, reset: int = NO_RESET) -> int: """ Constructs and sends heater duty cycle override command - Must be logged into DG - There must be a minimum flow available for the heaters (FMP for primary and FMD for trimmer) + Must be logged into DD - @param heater the heater to override its value (primary, trimmer) (0-1.0 order) + @param heater the heater to override its value @param duty_cycle the duty cycle value to override in percent @param reset: (int) 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ - reset_value = integer_to_bytearray(reset) - heater_name = integer_to_bytearray(heater) + rst = integer_to_bytearray(reset) + htr = integer_to_bytearray(heater) duty = float_to_bytearray(duty_cycle/100) - payload = reset_value + duty + heater_name - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, - message_id=MsgIds.MSG_ID_DD_HEATERS_DUTY_CYCLE_OVERRIDE_REQUEST.value, - payload=payload) + payload = rst + duty + htr - self.logger.debug("Overriding {} heater's duty cycle to {:5.3f} %".format(HeatersNames(heater).name, duty_cycle)) - # Send message - received_message = self.can_interface.send(message) + heater_name = dd_enum_repository.DDHeaterNames(heater).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.dialin_to_dd_ch_id, + msg_id = MsgIds.MSG_ID_DD_HEATERS_DUTY_CYCLE_OVERRIDE_REQUEST, + entity_name = f'DD {heater_name} Heaters Duty Cycle', + override_text = str(duty_cycle), + logger = self.logger, + can_interface = self.can_interface) - # If there is content in message - if received_message is not None: - # Response payload is OK or not - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False def cmd_heater_start_stop_override(self, heater: int, command: int, temperature: float) -> int: """ - Constructs and sends heater duty cycle override command - Must be logged into DG - There must be a minimum flow available for the heaters (FMP for primary and FMD for trimmer) + Constructs and sends heater start stop override - @param heater the heater to override its value (primary, trimmer) (0-1.0 order) + + @param heater the heater to override its value @param command the heater to start or stop @param temperature: float - temp to set to @returns 1 if successful, zero otherwise @@ -194,18 +196,66 @@ tmp = float_to_bytearray(temperature) payload = htr + cmd + tmp - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, - message_id=MsgIds.MSG_ID_DD_HEATERS_START_STOP_OVERRIDE_REQUEST.value, - payload=payload) + heater_name = dd_enum_repository.DDHeaterNames(heater).name.split('_')[0] + start_or_stop = 'Start' if command == 0 else 'Stop' + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_dd_ch_id, + msg_id = MsgIds.MSG_ID_DD_HEATERS_START_STOP_OVERRIDE_REQUEST, + entity_name = f'DD {heater_name} Heaters {start_or_stop} temperature', + override_text = str(temperature), + logger = self.logger, + can_interface = self.can_interface) - # Send message - received_message = self.can_interface.send(message) - # If there is content in message - if received_message is not None: - # Response payload is OK or not - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False + def cmd_heater_target_temperature_override(self, heater: int, temperature: float, reset: int) -> int: + """ + Constructs and sends heater set target temperture override + @param heater the heater to override its value (primary, trimmer) (0-1.0 order) + @param temperature: float - temp to set to + @param reset: (int) 1 to reset a previous override, 0 to override + @returns 1 if successful, zero otherwise + """ + htr = integer_to_bytearray(heater) + tmp = float_to_bytearray(temperature) + rst = integer_to_bytearray(reset) + payload = rst + tmp + htr + + heater_name = dd_enum_repository.DDHeaterNames(heater).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_dd_ch_id, + msg_id = MsgIds.MSG_ID_DD_HEATERS_TARGET_TEMPERATURE_OVERRIDE_REQUEST, + entity_name = f'DD {heater_name} Heaters target temperature', + override_text = str(temperature), + logger = self.logger, + can_interface = self.can_interface) + + + def cmd_heater_pwm_period_override(self, heater: int, period: float, reset: int) -> int: + """ + Constructs and sends heater pwm period override + + @param heater the heater to override its value (primary, trimmer) (0-1.0 order) + @param period: float - period to set to + @param reset: (int) 1 to reset a previous override, 0 to override + @returns 1 if successful, zero otherwise + """ + htr = integer_to_bytearray(heater) + prd = float_to_bytearray(period) + rst = integer_to_bytearray(reset) + payload = rst + prd + htr + + heater_name = dd_enum_repository.DDHeaterNames(heater).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = NO_RESET, + channel_id = DenaliChannels.dialin_to_dd_ch_id, + msg_id = MsgIds.MSG_ID_DD_HEATERS_PWM_PERIOD_OVERRIDE_REQUEST, + entity_name = f'DD {heater_name} Heaters PWM period', + override_text = str(period), + logger = self.logger, + can_interface = self.can_interface)