Index: leahi_dialin/common/msg_ids.py =================================================================== diff -u -r9a9f63852d6f00feabda7a5ef672f8c81ae9b7e4 -r351b713da824c7d6d7f73d0b33ddf1fd53621f1a --- leahi_dialin/common/msg_ids.py (.../msg_ids.py) (revision 9a9f63852d6f00feabda7a5ef672f8c81ae9b7e4) +++ leahi_dialin/common/msg_ids.py (.../msg_ids.py) (revision 351b713da824c7d6d7f73d0b33ddf1fd53621f1a) @@ -172,6 +172,11 @@ MSG_ID_DD_CONCENTRATE_PUMPS_START_STOP_OVERRIDE_REQUEST = 0xA02D MSG_ID_DD_HEATERS_START_STOP_OVERRIDE_REQUEST = 0xA02E MSG_ID_DD_VALVES_OPEN_CLOSE_STATE_OVERRIDE_REQUEST = 0xA02F + MSD_ID_DD_RO_COMMUNICATION_STATUS_OVERRIDE_REQUEST = 0xA030 + MSG_ID_DD_BAL_CHAMBER_DATA_PUBLISH_OVERRIDE_REQUEST = 0xA031 + MSG_ID_DD_BAL_CHAMBER_SWITCH_FREQ_OVERRIDE_REQUEST = 0xA032 + MSG_ID_DD_DIAL_DELIVERY_IN_PROGRESS_OVERRIDE_REQUEST = 0xA033 + MSG_ID_DD_DIAL_DELIVERY_GOOD_TO_DELIVER_OVERRIDE_REQUEST = 0xA034 MSG_ID_TD_DEBUG_EVENT = 0xFFF1 MSG_ID_DD_DEBUG_EVENT = 0xFFF2 Index: leahi_dialin/dd/modules/balancing_chamber.py =================================================================== diff -u --- leahi_dialin/dd/modules/balancing_chamber.py (revision 0) +++ leahi_dialin/dd/modules/balancing_chamber.py (revision 351b713da824c7d6d7f73d0b33ddf1fd53621f1a) @@ -0,0 +1,159 @@ +########################################################################### +# +# 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) Micahel Garthwaite +# @date (last) 07-Mar-2023 +# @author (original) Micahel Garthwaite +# @date (original) 29-Oct-2020 +# +############################################################################ +import struct +from enum import unique +from logging import Logger + +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 + +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 + msg_id = MsgIds.MSG_ID_DD_BAL_CHAMBER_DATA.value + self.can_interface.register_receiving_publication_function(channel_id, msg_id, + 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.dd_bal_chamber_timestamp = 0 + + @publish(["dd_bal_chamber_timestamp", + "execution_state", "switching_state", + "switching_frequency", + "switching_period", "bal_chamber_fill_in_progress", + "current_bal_chamber_switching_counter", + "is_pressure_stabilized_during_fill"]) + 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_6]))[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.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 + """ + + if not check_broadcast_interval_override_ms(ms): + return False + + reset_byte_array = integer_to_bytearray(reset) + ms_byte_array = integer_to_bytearray(ms) + payload = reset_byte_array + ms_byte_array + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, + message_id=MsgIds.MSG_ID_DD_BAL_CHAMBER_DATA_PUBLISH_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("override DD Balancing Chamber data broadcast interval") + + # 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.error("Timeout!!!!") + return False + + def cmd_switch_frequency_override(self, frequency: float, reset: int = NO_RESET) -> int: + """ + Constructs and sends the switch frequency override command + + @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 + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, + message_id=MsgIds.MSG_ID_DD_BAL_CHAMBER_SWITCH_FREQ_OVERRIDE_REQUEST.value, + payload=payload) + + if reset == RESET: + str_res = "reset back to normal" + else: + str_res = str(frequency) + self.logger.debug("override switch frequency " + ": " + str_res) + + # 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.error("Timeout!!!!") + return False \ No newline at end of file Index: leahi_dialin/dd/modules/gen_dialysate.py =================================================================== diff -u --- leahi_dialin/dd/modules/gen_dialysate.py (revision 0) +++ leahi_dialin/dd/modules/gen_dialysate.py (revision 351b713da824c7d6d7f73d0b33ddf1fd53621f1a) @@ -0,0 +1,200 @@ +########################################################################### +# +# 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 gen_dialysate.py +# +# @author (last) Micahel Garthwaite +# @date (last) 07-Mar-2023 +# @author (original) Micahel Garthwaite +# @date (original) 29-Oct-2020 +# +############################################################################ +import struct +from enum import unique +from logging import Logger + +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 + +class DDGenDialysate(AbstractSubSystem): + """ + Gen Dialysate + + Dialysate Delivery (DD) Dialin API sub-class for gen dialysate 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 + msg_id = MsgIds.MSG_ID_DD_BAL_CHAMBER_DATA.value + self.can_interface.register_receiving_publication_function(channel_id, msg_id, + self._handler_balancing_chamber_sync) + + self.execution_state = 0 + self.dialysate_delivery_in_progress = 0 + self.floater_level = 0 + self.bicarb_level = 0 + self.spent_chamber_level = 0 + self.hydraulics_negative_pressure = 0.0 + self.hydraulics_positive_pressure = 0.0 + self.spent_dialysate_pressure = 0.0 + self.dialysate_good_to_deliver = 0 + self.dd_gen_dialysate_timestamp = 0 + + @publish(["dd_gen_dialysate_timestamp", + "execution_state", "dialysate_delivery_in_progress", + "floater_level", + "bicarb_level", "spent_chamber_level", + "hydraulics_negative_pressure", + "hydraulics_positive_pressure", "spent_dialysate_pressure", + "dialysate_good_to_deliver"]) + 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.dialysate_delivery_in_progress = struct.unpack('I', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] + self.floater_level = struct.unpack('I', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] + self.bicarb_level = struct.unpack('I', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] + self.spent_chamber_level = struct.unpack('I', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_6]))[0] + self.hydraulics_negative_pressure = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6]))[0] + self.hydraulics_positive_pressure = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7]))[0] + self.spent_dialysate_pressure = struct.unpack('f', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8]))[0] + self.dialysate_good_to_deliver = struct.unpack('I', bytearray( + message['message'][MsgFieldPositions.START_POS_FIELD_9:MsgFieldPositions.END_POS_FIELD_9]))[0] + self.dd_gen_dialysate_timestamp = timestamp + + def cmd_gen_dialysate_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the gen dialysate 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 + """ + + if not check_broadcast_interval_override_ms(ms): + return False + + reset_byte_array = integer_to_bytearray(reset) + ms_byte_array = integer_to_bytearray(ms) + payload = reset_byte_array + ms_byte_array + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, + message_id=MsgIds.MSG_ID_DD_GEND_MODE_DATA_PUBLISH_OVERRIDE_REQUEST.value, + payload=payload) + + self.logger.debug("override DD Gen Dialysate data broadcast interval") + + # 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.error("Timeout!!!!") + return False + + def cmd_dialysate_delivery_in_progress_override(self, in_progress: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the dialysate delivery in progress override command + + @param in_progress: int - value to override in progress status + @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) + inprog = integer_to_bytearray(in_progress) + payload = reset_byte_array + inprog + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, + message_id=MsgIds.MSG_ID_DD_DIAL_DELIVERY_IN_PROGRESS_OVERRIDE_REQUEST.value, + payload=payload) + + if reset == RESET: + str_res = "reset back to normal" + else: + str_res = str(in_progress) + self.logger.debug("override dialysate delivery in progress to " + ": " + str_res) + + # 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.error("Timeout!!!!") + return False + + def cmd_dialysate_delivery_good_to_deliver_override(self, delivery: int, reset: int = NO_RESET) -> int: + """ + Constructs and sends the dialysate delivery good to deliver override command + + @param delivery: int - value to override in delivery status + @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) + dev = integer_to_bytearray(delivery) + payload = reset_byte_array + dev + + message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, + message_id=MsgIds.MSG_ID_DD_DIAL_DELIVERY_GOOD_TO_DELIVER_OVERRIDE_REQUEST.value, + payload=payload) + + if reset == RESET: + str_res = "reset back to normal" + else: + str_res = str(delivery) + self.logger.debug("override dialysate good to delivery to " + ": " + str_res) + + # 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.error("Timeout!!!!") + return False \ No newline at end of file