########################################################################### # # 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 balancing_chamber.py # # @author (last) Zoltan Miskolci # @date (last) 07-Jan-2026 # @author (original) Micahel Garthwaite # @date (original) 29-Oct-2020 # ############################################################################ import struct 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_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 class DDBalancingChamber(AbstractSubSystem): """ Balancing Chamber Dialysate Delivery (DD) Dialin API sub-class for Balancing Chamber 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 if self.can_interface is not None: channel_id = DenaliChannels.dd_sync_broadcast_ch_id self.msg_id_dd_bal_chamber_data = MsgIds.MSG_ID_DD_BAL_CHAMBER_DATA.value self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_dd_bal_chamber_data, self._handler_balancing_chamber_sync) self.execution_state = 0 self.switching_state = 0 self.switching_frequency = 0.0 self.switching_period = 0 self.bal_chamber_fill_in_progress = 0 self.current_bal_chamber_switching_counter = 0 self.is_pressure_stabilized_during_fill = 0 self.bal_chamber_switch_only_state = 0 self.dd_bal_chamber_timestamp = 0 @publish(["msg_id_dd_bal_chamber_data", "execution_state", "switching_state", "switching_frequency", "switching_period", "bal_chamber_fill_in_progress", "current_bal_chamber_switching_counter", "is_pressure_stabilized_during_fill", "bal_chamber_switch_only_state", "dd_bal_chamber_timestamp"]) def _handler_balancing_chamber_sync(self, message, timestamp=0.0): """ Handles published balancing chamber data messages. @param message: published balancing chamber data message @return: None """ self.execution_state = struct.unpack('I', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.switching_state = struct.unpack('I', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] self.switching_frequency = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] self.switching_period = struct.unpack('I', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] self.bal_chamber_fill_in_progress = struct.unpack('I', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] self.current_bal_chamber_switching_counter = struct.unpack('I', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6]))[0] self.is_pressure_stabilized_during_fill = struct.unpack('I', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7]))[0] self.bal_chamber_switch_only_state = struct.unpack('I', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8]))[0] self.dd_bal_chamber_timestamp = timestamp def cmd_balancing_chamber_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the balancing chamber data broadcast interval override command 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: 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_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_BAL_CHAMBER_DATA_PUBLISH_OVERRIDE_REQUEST, module_name = 'DD Balancing Chamber', logger = self.logger, can_interface = self.can_interface) def cmd_switch_frequency_override(self, frequency: float, reset: int = NO_RESET) -> int: """ Constructs and sends the balancing chamber switch frequency override command Constraints: Must be logged into DD. @param frequency: float - frequency value to override switch frequency with @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ reset_byte_array = integer_to_bytearray(reset) freq = float_to_bytearray(frequency) payload = reset_byte_array + freq return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_BAL_CHAMBER_SWITCH_FREQ_OVERRIDE_REQUEST, entity_name = 'Switch Frequency', override_text = str(frequency), logger = self.logger, can_interface = self.can_interface) def cmd_switch_only_start_stop_override(self, start_stop: int, flow: float) -> int: """ Constructs and sends the balancing chamber switch only start stop override command Constraints: Must be logged into DD. @param start_stop: int - value to start or stop switch ( start = 1, stop = 0 @param flow: float - flow rate in ml/min @return: 1 if successful, zero otherwise """ sts = integer_to_bytearray(start_stop) freq = float_to_bytearray(flow) payload = sts + freq return cmd_generic_override( payload = payload, reset = NO_RESET, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_BC_SWITCH_ONLY_START_STOP_OVERRIDE_REQUEST, entity_name = 'Switch Only Start' if start_stop == 1 else 'Switch Only Stop', override_text = str(flow), logger = self.logger, can_interface = self.can_interface) def cmd_acid_dose_volume_override(self, volume: float, reset: int = NO_RESET) -> int: """ Constructs and sends the acid dose volume override command Constraints: Must be logged into DD. @param volume: float - volume value to override acid dose with @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ reset_byte_array = integer_to_bytearray(reset) vol = float_to_bytearray(volume) payload = reset_byte_array + vol return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_ACID_DOSING_VOLUME_OVERRIDE_REQUEST, entity_name = 'Acid dose volume', override_text = str(volume), logger = self.logger, can_interface = self.can_interface) def cmd_bicarb_dose_volume_override(self, volume: float, reset: int = NO_RESET) -> int: """ Constructs and sends the bicarb dose volume override command Constraints: Must be logged into DD. @param volume: float - volume value to override bicarb dose with @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ reset_byte_array = integer_to_bytearray(reset) vol = float_to_bytearray(volume) payload = reset_byte_array + vol return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_BICARB_DOSING_VOLUME_OVERRIDE_REQUEST, entity_name = 'Bicarb dose volume', override_text = str(volume), logger = self.logger, can_interface = self.can_interface)