########################################################################### # # 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 dialysate_pump.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.dd_defs import dd_enum_repository 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 DDDialysatePumps(AbstractSubSystem): """ DialysatePumps Dialysate Delivery (DD) Dialin API sub-class for dialysate pumps 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_dialysate_pumps_data = MsgIds.MSG_ID_DIALYSATE_PUMPS_DATA.value self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_dd_dialysate_pumps_data, self._handler_dialysate_pumps_sync) self.dd_dialysate_pumps = { dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name: { dd_enum_repository.DDDialysatePumpAttributes.TARGET_RPM.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.MEASURED_SPEED.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.CURRENT_SPEED.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.STATE.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.TARGET_PRESSURE.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.MEASURED_PRESSURE.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.MEASURED_CURRENT.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.CONTROL.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.DIRECTION_ERROR_COUNT.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.MEASURED_DIRECTION.name: 0.0 }, dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name: { dd_enum_repository.DDDialysatePumpAttributes.TARGET_RPM.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.MEASURED_SPEED.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.CURRENT_SPEED.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.STATE.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.TARGET_PRESSURE.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.MEASURED_PRESSURE.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.MEASURED_CURRENT.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.CONTROL.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.DIRECTION_ERROR_COUNT.name: 0.0, dd_enum_repository.DDDialysatePumpAttributes.MEASURED_DIRECTION.name: 0.0 } } self.dd_dialysate_pump_timestamp = 0 @publish(["msg_id_dd_dialysate_pumps_data", "dd_dialysate_pumps", "dd_dialysate_pump_timestamp",]) def _handler_dialysate_pumps_sync(self, message, timestamp=0.0): """ Handles published dialysate pumps' data messages. Dialysate pumps' speed data are captured for reference. @param message: published dialysate pumps' data message @return: None """ self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.TARGET_RPM.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.TARGET_RPM.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.MEASURED_SPEED.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.MEASURED_SPEED.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.CURRENT_SPEED.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.CURRENT_SPEED.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.STATE.name] = ( struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.STATE.name] = ( struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.TARGET_PRESSURE.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_9:MsgFieldPositions.END_POS_FIELD_9])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.TARGET_PRESSURE.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_10:MsgFieldPositions.END_POS_FIELD_10])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.MEASURED_PRESSURE.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_11:MsgFieldPositions.END_POS_FIELD_11])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.MEASURED_PRESSURE.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_12:MsgFieldPositions.END_POS_FIELD_12])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.MEASURED_CURRENT.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_13:MsgFieldPositions.END_POS_FIELD_13])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.MEASURED_CURRENT.name] = ( struct.unpack('f', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_14:MsgFieldPositions.END_POS_FIELD_14])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.CONTROL.name] = ( struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_15:MsgFieldPositions.END_POS_FIELD_15])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.CONTROL.name] = ( struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_16:MsgFieldPositions.END_POS_FIELD_16])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.DIRECTION_ERROR_COUNT.name] = ( struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_17:MsgFieldPositions.END_POS_FIELD_17])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.DIRECTION_ERROR_COUNT.name] = ( struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_18:MsgFieldPositions.END_POS_FIELD_18])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D12_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.MEASURED_DIRECTION.name] = ( struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_19:MsgFieldPositions.END_POS_FIELD_19])))[0] self.dd_dialysate_pumps[dd_enum_repository.DDDialysatePumpNames.D48_PUMP.name][dd_enum_repository.DDDialysatePumpAttributes.MEASURED_DIRECTION.name] = ( struct.unpack('i', bytearray(message['message'][MsgFieldPositions.START_POS_FIELD_20:MsgFieldPositions.END_POS_FIELD_20])))[0] self.dd_dialysate_pump_timestamp = timestamp def cmd_dialysate_pump_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the dialysate pump 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_DIALYSATE_PUMPS_PUBLISH_INTERVAL_OVERRIDE_REQUEST, module_name = 'DD Dialysate Pump', logger = self.logger, can_interface = self.can_interface) def cmd_dialysate_pump_target_speed_override(self, pump_id: int, speed: float, reset: int = NO_RESET) -> int: """ Constructs and sends the dialysate pump target speed override command @param pump_id: unsigned int - dialysate pump ID @param speed: float - target speed value to override pump 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) speed_byte_array = float_to_bytearray(speed) pump_id_byte_array = integer_to_bytearray(pump_id) payload = reset_byte_array + speed_byte_array + pump_id_byte_array return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_DIALYSATE_PUMPS_TARGET_SPEED_OVERRIDE_REQUEST, entity_name = f'DD {dd_enum_repository.DDDialysatePumpNames(pump_id).name} Dialysate Pump target speed', override_text = str(speed), logger = self.logger, can_interface = self.can_interface) def cmd_dialysate_pump_measured_speed_override(self, pump_id: int, speed: float, reset: int = NO_RESET) -> int: """ Constructs and sends the dialysate pump target speed override command @param pump_id: unsigned int - concentrate pump ID @param speed: float - target speed value to override pump 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) speed_byte_array = float_to_bytearray(speed) pump_id_byte_array = integer_to_bytearray(pump_id) payload = reset_byte_array + speed_byte_array + pump_id_byte_array return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_DIALYSATE_PUMPS_MEASURED_SPEED_OVERRIDE_REQUEST, entity_name = f'DD {dd_enum_repository.DDDialysatePumpNames(pump_id).name} Dialysate Pump measured speed', override_text = str(speed), logger = self.logger, can_interface = self.can_interface) def cmd_dialysate_pump_target_pressure_override(self, pump_id: int, pressure: float, reset: int = NO_RESET) -> int: """ Constructs and sends the dialysate pump target speed override command @param pump_id: unsigned int - concentrate pump ID @param pressure: float - target speed value to override dialysate pump 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) pressure_byte_array = float_to_bytearray(pressure) pump_id_byte_array = integer_to_bytearray(pump_id) payload = reset_byte_array + pressure_byte_array + pump_id_byte_array return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_DIALYSATE_PUMPS_TARGET_PRESSURE_OVERRIDE_REQUEST, entity_name = f'DD {dd_enum_repository.DDDialysatePumpNames(pump_id).name} Dialysate Pump target pressure', override_text = str(pressure), logger = self.logger, can_interface = self.can_interface) def cmd_dialysate_pump_measured_current_override(self, pump_id: int, current: float, reset: int = NO_RESET) -> int: """ Constructs and sends the dialysate pump measured current override command @param pump_id: unsigned int - concentrate pump ID @param current: float - target speed value to override dialysate pump 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) current_byte_array = float_to_bytearray(current) pump_id_byte_array = integer_to_bytearray(pump_id) payload = reset_byte_array + current_byte_array + pump_id_byte_array return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_DIALYSATE_PUMPS_MEASURED_CURRENT_OVERRIDE_REQUEST, entity_name = f'DD {dd_enum_repository.DDDialysatePumpNames(pump_id).name} Dialysate Pump measured current', override_text = str(current), logger = self.logger, can_interface = self.can_interface) def cmd_dialysate_pump_measured_direction_override(self, pump_id: int, direction: float, reset: int = NO_RESET) -> int: """ Constructs and sends the dialysate pump measured direction override command @param pump_id: unsigned int - concentrate pump ID @param direction: float - target speed value to override pump 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) direction_byte_array = float_to_bytearray(direction) pump_id_byte_array = integer_to_bytearray(pump_id) payload = reset_byte_array + direction_byte_array + pump_id_byte_array return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_DIALYSATE_PUMPS_MEASURED_DIRECTION_OVERRIDE_REQUEST, entity_name = f'DD {dd_enum_repository.DDDialysatePumpNames(pump_id).name} Dialysate Pump measured direction', override_text = str(direction), logger = self.logger, can_interface = self.can_interface) def cmd_dialysate_set_start_stop(self, pump_id: int, command: int, speed: int, control: int ) -> int: """ Constructs and sends the dialysate pump start stop command @param pump_id: unsigned int - dialysate pump ID @param command: int - value to command the dialysate pump @param speed: integer - rpm to set the speed to @return: 1 if successful, zero otherwise """ pmp = integer_to_bytearray(pump_id) cmd = integer_to_bytearray(command) rpm = integer_to_bytearray(speed) ctl = integer_to_bytearray(control) payload = pmp + cmd + rpm + ctl return cmd_generic_override( payload = payload, reset = NO_RESET, channel_id = DenaliChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_DIALYSATE_PUMPS_START_STOP_OVERRIDE_REQUEST, entity_name = f'DD {dd_enum_repository.DDDialysatePumpNames(pump_id).name} Dialysate Pump start & stop', override_text = str(cmd), logger = self.logger, can_interface = self.can_interface)