########################################################################### # # Copyright (c) 2020-2024 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 heaters.py # # @author (last) Zoltan Miskolci # @date (last) 04-May-2026 # @author (original) Dara Navaei # @date (original) 29-May-2020 # ############################################################################ # Module imports from logging import Logger # Project imports from leahi_dialin.common.constants import NO_RESET from leahi_dialin.common import dd_enum_repository from leahi_dialin.common.generic_defs import DataTypes from leahi_dialin.common.msg_defs import MsgIds from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override from leahi_dialin.protocols.CAN import DenaliCanMessenger, DenaliChannels from leahi_dialin.utils.abstract_classes import AbstractSubSystem from leahi_dialin.utils.base import publish from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray class DDHeaters(AbstractSubSystem): """ Dialysate Delivery (DD) Dialin API sub-class for heaters related commands. """ def __init__(self, can_interface: DenaliCanMessenger, logger: Logger): """ @param can_interface: Denali CAN Messenger object """ super().__init__() self.can_interface = can_interface self.logger = logger if self.can_interface is not None: self.can_interface.register_receiving_publication_function(channel_id = DenaliChannels.dd_sync_broadcast_ch_id, message_id = MsgIds.MSG_ID_DD_HEATERS_DATA.value, function = self._handler_heaters_sync) self.dd_heaters_timestamp = 0.0 #: The timestamp of the latest message #: The Heaters data in dictionary format 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.FEED_FORWARD.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.FEED_FORWARD.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 @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 DD heaters message @param message: published DD heaters data message @returns none """ sensor_list = [] sensor_list.append((dd_enum_repository.DDHeaterNames.D5_HEAT.name, dd_enum_repository.DDHeaterAttributes.HEAT_DUTY_CYCLE.name, DataTypes.F32)) sensor_list.append((dd_enum_repository.DDHeaterNames.D45_HEAT.name, dd_enum_repository.DDHeaterAttributes.HEAT_DUTY_CYCLE.name, DataTypes.F32)) sensor_list.append((dd_enum_repository.DDHeaterNames.D5_HEAT.name, dd_enum_repository.DDHeaterAttributes.HEAT_TARGET_TEMP.name, DataTypes.F32)) sensor_list.append((dd_enum_repository.DDHeaterNames.D45_HEAT.name, dd_enum_repository.DDHeaterAttributes.HEAT_TARGET_TEMP.name, DataTypes.F32)) sensor_list.append((dd_enum_repository.DDHeaterNames.D5_HEAT.name, dd_enum_repository.DDHeaterAttributes.HEAT_STATE.name, DataTypes.U32)) sensor_list.append((dd_enum_repository.DDHeaterNames.D45_HEAT.name, dd_enum_repository.DDHeaterAttributes.HEAT_STATE.name, DataTypes.U32)) sensor_list.append((dd_enum_repository.DDHeaterNames.D5_HEAT.name, dd_enum_repository.DDHeaterAttributes.FEED_FORWARD.name, DataTypes.F32)) sensor_list.append((dd_enum_repository.DDHeaterNames.D5_HEAT.name, dd_enum_repository.DDHeaterAttributes.PWM_PERIOD.name, DataTypes.F32)) sensor_list.append((dd_enum_repository.DDHeaterNames.D5_HEAT.name, dd_enum_repository.DDHeaterAttributes.ADJUSTED_TARGET_TEMP.name, DataTypes.F32)) sensor_list.append((dd_enum_repository.DDHeaterNames.D5_HEAT.name, dd_enum_repository.DDHeaterAttributes.TARGET_TEMP_TD.name, DataTypes.F32)) msg_list =[] msg_list.append(('self.dbg1', DataTypes.F32)) msg_list.append(('self.dbg2', DataTypes.F32)) msg_list.append(('self.dbg3', DataTypes.F32)) msg_list.append(('self.dbg4', DataTypes.F32)) msg_list.append(('self.dbg5', DataTypes.F32)) msg_list.append(('self.dbg6', DataTypes.F32)) msg_list.append(('self.dbg7', DataTypes.F32)) msg_list.append(('self.dbg8', DataTypes.F32)) msg_list.append(('self.dbg9', DataTypes.F32)) self.process_into_dict(dict_to_update = self.dd_heaters, decoder_list = sensor_list, message = message) self.process_into_vars(decoder_list = msg_list, message = message, start_from_byte = len(sensor_list) * DataTypes.U32.size()) 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 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 """ 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) 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 DD @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 """ rst = integer_to_bytearray(reset) htr = integer_to_bytearray(heater) duty = float_to_bytearray(duty_cycle/100) payload = rst + duty + htr 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) def cmd_heater_start_stop_override(self, heater: int, command: int, temperature: float) -> int: """ Constructs and sends heater start stop override @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 """ htr = integer_to_bytearray(heater) cmd = integer_to_bytearray(command) tmp = float_to_bytearray(temperature) payload = htr + cmd + tmp 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) 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)