########################################################################### # # 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 treatment.py # # @author (last) Michael Garthwaite # @date (last) 22-Apr-2025 # @author (original) Michael Garthwaite # @date (original) 22-Apr-2025 # ############################################################################ import struct from logging import Logger from enum import unique from .constants import RESET, NO_RESET 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.utils.conversions import integer_to_bytearray, float_to_bytearray @unique class TDTreatmentParameters(DialinEnum): TREATMENT_PARAM_BLOOD_FLOW = 0 # Blood flow rate (in mL/min) TREATMENT_PARAM_DIALYSATE_FLOW = 1 # Dialysate flow rate (in mL/min) TREATMENT_PARAM_TREATMENT_DURATION = 2 # Treatment duration (in minutes) TREATMENT_PARAM_SALINE_BOLUS_VOLUME = 3 # Saline bolus volume (in mL) TREATMENT_PARAM_HEPARIN_STOP_TIME = 4 # Heparin stop time (in minutes) TREATMENT_PARAM_HEPARIN_TYPE = 5 # Heparin type (enum) TREATMENT_PARAM_ACID_CONCENTRATE = 6 # Acid concentrate type (enum) TREATMENT_PARAM_BICARB_CONCENTRATE = 7 # Bicarbonate concentrate type (enum) TREATMENT_PARAM_DIALYZER_TYPE = 8 # Dialysate type (enum) TREATMENT_PARAM_BP_MEAS_INTERVAL = 9 # Blood pressure measurement interval (in minutes) TREATMENT_PARAM_RINSEBACK_FLOW_RATE = 10 # Rinseback flow rate (in mL/min) TREATMENT_PARAM_RINSEBACK_VOLUME = 11 # Rinseback volume (in mL) TREATMENT_PARAM_ART_PRES_LIMIT_WINDOW = 12 # Arterial pressure alarm limit window (in mmHg) TREATMENT_PARAM_VEN_PRES_LIMIT_WINDOW = 13 # Venous pressure alarm limit window (in mmHg) TREATMENT_PARAM_VEN_PRES_LIMIT_ASYMMETRIC = 14 # Venous pressure alarm limit asymmetric (in mmHg) TREATMENT_PARAM_TMP_PRES_LIMIT_WINDOW = 15 # TMP alarm limit window (in mmHg) TREATMENT_PARAM_DIALYSATE_TEMPERATURE = 16 # Dialysate temperature (in degC) TREATMENT_PARAM_HEPARIN_DISPENSE_RATE = 17 # Heparin dispense rate (in mL/hr) TREATMENT_PARAM_HEPARIN_BOLUS_VOLUME = 18 # Heparin bolus volume (in mL) TREATMENT_PARAM_UF_VOLUME = 19 # Ultrafiltration volume (in liters) - provided separately by UI NUM_OF_TREATMENT_PARAMS = 20 # Total number of treatment parameters class TDTreatment(AbstractSubSystem): """ Treatment Delivery (TD) Dialin API sub-class for treatment related commands. """ def __init__(self, can_interface, logger: Logger): """ TDTreatment constructor """ super().__init__() self.can_interface = can_interface self.logger = logger if self.can_interface is not None: channel_id = DenaliChannels.td_sync_broadcast_ch_id msg_id = MsgIds.MSG_ID_TD_TREATMENT_PARAM_RANGES.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_treatment_param_ranges_sync) msg_id = MsgIds.MSG_ID_TD_SALINE_BOLUS_DATA.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_saline_bolus_sync) msg_id = MsgIds.MSG_ID_TD_ULTRAFILTRATION_DATA.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_uf_sync) msg_id = MsgIds.MSG_ID_TD_TREATMENT_TIME_DATA.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_treatment_time_sync) msg_id = MsgIds.MSG_ID_TD_TREATMENT_STATE_DATA.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_treatment_state_sync) msg_id = MsgIds.MSG_ID_TD_RSP_CURRENT_TREATMENT_PARAMETERS.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_resp_treatment_parameters_sync) # Treatment param ranges data self.min_tx_time = 0 self.max_tx_time = 0 self.min_uf_volume = 0.0 self.max_uf_volume = 0.0 self.min_dial_rate = 0 self.max_dial_rate = 0 self.tx_params_timestamp = 0 # Saline Bolus data self.tgt_saline_volume = 0 # in mL self.cum_saline_volume = 0.0 # in mL self.bol_saline_volume = 0.0 # in mL self.saline_bolus_state = 0 self.saline_bolus_timestamp = 0 # UF data self.set_uf_volume = 0.0 # in L self.tgt_uf_rate = 0.0 # in L/hr self.uf_volume_delivered = 0.0 # in L self.uf_state = 0 self.uf_timestamp = 0 # Treatment Time Data self.tx_time_prescribed = 0 self.tx_time_elapsed = 0 self.tx_time_remaining = 0 self.tx_time_timestamp = 0 # Treatment State Data self.tx_sub_mode = 0 self.blood_prime_state = 0 self.dialysis_state = 0 self.isolated_uf_state = 0 self.tx_stop_state = 0 self.rinseback_state = 0 self.tx_recirc_state = 0 self.tx_end_state = 0 self.tx_state_timestamp = 0 # Treatment Parameters Data. Most recent response. self.blood_flow_rate = 0 self.dialysate_flow_rate = 0 self.tx_duration = 0 self.saline_bolus_volume = 0 self.hep_stop_time = 0 self.hep_time = 0 self.acid_con = 0 self.bicarb_con = 0 self.dialyzer_type = 0 self.bp_interval = 0 self.rb_flow_rate = 0 self.rb_volume = 0 self.art_pressure_window = 0 self.venous_pressure_window = 0 self.venous_asymm_window = 0 self.tmp_limit_window = 0 self.dialysate_temp = 0.0 self.hep_dispense_rate = 0.0 self.hep_bolus_vol = 0.0 self.uf_vol = 0.0 self.tx_param_req_timestamp = 0 @publish(["min_tx_time","max_tx_time","min_uf_volume","max_uf_volume", "min_dial_rate","max_dial_rate","tx_params_timestamp"]) def _handler_treatment_param_ranges_sync(self, message, timestamp=0.0): """ Handles published treatment parameter range data messages. @param message: published treatment parameter range data message @return: none """ self.min_tx_time = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.max_tx_time = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] self.min_uf_volume = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] self.max_uf_volume = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] self.min_dial_rate = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] self.max_dial_rate = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6]))[0] self.tx_params_timestamp = timestamp @publish(["tgt_saline_volume","cum_saline_volume","bol_saline_volume", "saline_bolus_state","saline_bolus_timestamp"]) def _handler_saline_bolus_sync(self, message, timestamp=0.0): """ Handles published saline bolus data messages. @param message: published saline bolus data message @return: none """ self.tgt_saline_volume = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.cum_saline_volume = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] self.bol_saline_volume = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] self.saline_bolus_state = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] self.saline_bolus_timestamp = timestamp @publish(["set_uf_volume","tgt_uf_rate","uf_volume_delivered", "uf_state","uf_timestamp"]) def _handler_uf_sync(self, message, timestamp=0.0): """ Handles published ultrafiltration data messages. @param message: published ultrafiltration data message @return: none """ self.set_uf_volume = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.tgt_uf_rate = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] self.uf_volume_delivered = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] self.uf_state = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] self.uf_timestamp = timestamp @publish(["tx_time_prescribed","tx_time_elapsed","tx_time_remaining", "tx_time_timestamp"]) def _handler_treatment_time_sync(self, message, timestamp=0.0): """ Handles published treatment time data messages. @param message: published treatment time data message @return: none """ self.tx_time_prescribed = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.tx_time_elapsed = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] self.tx_time_remaining = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] self.tx_time_timestamp = timestamp @publish(["tx_sub_mode","blood_prime_state","dialysis_state","isolated_uf_state", "tx_stop_state","rinseback_state","tx_recirc_state","tx_end_state","tx_state_timestamp"]) def _handler_treatment_state_sync(self, message, timestamp=0.0): """ Handles published treatment state data messages. @param message: published treatment state data message @return: none """ self.tx_sub_mode = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.blood_prime_state = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] self.dialysis_state = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] self.isolated_uf_state = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] self.tx_stop_state = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] self.rinseback_state = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6]))[0] self.tx_recirc_state = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7]))[0] self.tx_end_state = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8]))[0] self.tx_state_timestamp = timestamp @publish(["blood_flow_rate", "dialysate_flow_rate", "tx_duration", "saline_bolus_volume", "hep_stop_time", "hep_time", "acid_con", "bicarb_con", "dialyzer_type", "bp_interval", "rb_flow_rate", "rb_volume", "art_pressure_window","venous_pressure_window","venous_asymm_window","tmp_limit_window", "dialysate_temp", "hep_dispense_rate", "hep_bolus_vol", "uf_vol"]) def _handler_resp_treatment_parameters_sync(self, message, timestamp=0.0): """ Handles published treatment parameter response data messages. @param message: published treatment parameter response data message @return: none """ self.blood_flow_rate = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.dialysate_flow_rate = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] self.tx_duration = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] self.saline_bolus_volume = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] self.hep_stop_time = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] self.hep_time = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6]))[0] self.acid_con = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7]))[0] self.bicarb_con = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8]))[0] self.dialyzer_type = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_9:MsgFieldPositions.END_POS_FIELD_9]))[0] self.bp_interval = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_10:MsgFieldPositions.END_POS_FIELD_10]))[0] self.rb_flow_rate = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_11:MsgFieldPositions.END_POS_FIELD_11]))[0] self.rb_volume = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_12:MsgFieldPositions.END_POS_FIELD_12]))[0] self.art_pressure_window = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_13:MsgFieldPositions.END_POS_FIELD_13]))[0] self.venous_pressure_window = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_14:MsgFieldPositions.END_POS_FIELD_14]))[0] self.venous_asymm_window = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_15:MsgFieldPositions.END_POS_FIELD_15]))[0] self.tmp_limit_window = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_16:MsgFieldPositions.END_POS_FIELD_16]))[0] self.dialysate_temp = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_17:MsgFieldPositions.END_POS_FIELD_17]))[0] self.hep_dispense_rate = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_18:MsgFieldPositions.END_POS_FIELD_18]))[0] self.hep_bolus_vol = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_19:MsgFieldPositions.END_POS_FIELD_19]))[0] self.uf_vol = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_20:MsgFieldPositions.END_POS_FIELD_20]))[0] self.tx_param_req_timestamp = timestamp def cmd_set_treatment_parameter(self, tx_param_value, tx_param_id: int = 0 ): """ Constraints: Must be logged into TD. @param tx_param_value: varied - value to set the treatment parameter @param tx_param_id: integer - the param id of the treatment paramter @return: 1 if successful, zero otherwise """ idx = integer_to_bytearray(tx_param_id) if tx_param_id <= TDTreatmentParameters.TREATMENT_PARAM_RINSEBACK_VOLUME.value: tpv = integer_to_bytearray(tx_param_value) elif tx_param_id >= TDTreatmentParameters.TREATMENT_PARAM_DIALYSATE_TEMPERATURE.value: tpv = float_to_bytearray(tx_param_value) else: tpv = integer_to_bytearray(tx_param_value) payload = idx + tpv message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, message_id=MsgIds.MSG_ID_TD_SET_TREATMENT_PARAMETER.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