Index: leahi_dialin/td/modules/bubble_detector.py =================================================================== diff -u -rafe332fec54d9d0432dfc0d54aef1debaa92b066 -re45b20cdc5d4c5dcff8cef530b173ca94cb2e422 --- leahi_dialin/td/modules/bubble_detector.py (.../bubble_detector.py) (revision afe332fec54d9d0432dfc0d54aef1debaa92b066) +++ leahi_dialin/td/modules/bubble_detector.py (.../bubble_detector.py) (revision e45b20cdc5d4c5dcff8cef530b173ca94cb2e422) @@ -7,34 +7,37 @@ # # @file air_bubbles.py # -# @author (last) Sean Nash -# @date (last) 04-May-2023 +# @author (last) Zoltan Miskolci +# @date (last) 05-May-2026 # @author (original) Peman Montazemi # @date (original) 18-May-2021 # ############################################################################ -import struct + +# Module imports 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 +# Project imports +from leahi_dialin.common.constants import NO_RESET +from leahi_dialin.common.generic_defs import DataTypes +from leahi_dialin.common.msg_ids import MsgIds +from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override +from leahi_dialin.common import td_enum_repository +from leahi_dialin.protocols.CAN import CanMessenger, CanChannels +from leahi_dialin.utils.abstract_classes import AbstractSubSystem +from leahi_dialin.utils.base import publish from leahi_dialin.utils.conversions import integer_to_bytearray -class TDBubbleDectector(AbstractSubSystem): +class TDBubbleDetector(AbstractSubSystem): """ - TDAirBubbles + TDBubbleDetector Treatment Delivery (TD) Dialin API sub-class for air bubbles related commands. ADA: Air bubble Detector Arterial ADV: Air bubble Detector Venous """ - # Air bubble detectors - ADV = 0 # Air bubble Detector Venous - # Air bubble detectors status BUBBLE_DETECTED_STATUS = 0 # Air bubble detected FLUID_DETECTED_STATUS = 1 # Fluid (no air bubble) detected @@ -43,49 +46,73 @@ AIR_BUBBLE_NORMAL_STATE = 0 # Normal state AIR_BUBBLE_SELF_TEST_STATE = 1 # Self-test state - def __init__(self, can_interface, logger: Logger): + def __init__(self, can_interface: CanMessenger, logger: Logger): """ - - @param can_interface: Denali Can Messenger object + @param can_interface: Can Messenger object """ 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_BUBBLES_DATA.value - self.can_interface.register_receiving_publication_function(channel_id, msg_id, - self._handler_air_bubbles_data_sync) + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.td_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_TD_BUBBLES_DATA.value, + function = self._handler_air_bubbles_data_sync) - self.td_air_bubbles_timestamp = 0.0 - # Initialize status of ADV air bubble detectors to fluid (no air bubble) detected - self.air_bubbles_status = [self.FLUID_DETECTED_STATUS] + self.td_air_bubbles_timestamp = 0.0 #: The timestamp of the last message - # Initialize state of ADV air bubble detectors state machine to normal - self.air_bubbles_state = [self.AIR_BUBBLE_NORMAL_STATE] + #: The TD Bubble Detector data in dictionary format + self.h18_bubble_detector = { + td_enum_repository.TDAirBubbleDetectorNames.H18_ADV.name: { + # Initialize status of ADV air bubble detectors to fluid (no air bubble) detected + td_enum_repository.TDAirBubbleDetectorAttributes.STATUS.name: self.FLUID_DETECTED_STATUS, + # Initialize state of ADV air bubble detectors state machine to normal + td_enum_repository.TDAirBubbleDetectorAttributes.STATE.name: self.AIR_BUBBLE_NORMAL_STATE + } + } - @publish(["td_air_bubbles_timestamp", "air_bubbles_status", "air_bubbles_state"]) + + @publish(["msg_id_td_bubbles_data", "h18_bubble_detector", "td_air_bubbles_timestamp"]) def _handler_air_bubbles_data_sync(self, message, timestamp=0.0): """ - Handles published air bubbles data messages. Air bubble status and state are captured - for ADV detector. + Handles published air bubbles data messages. Air bubble status and state are captured. - @param message: published air bubbles data message as: ADV status, ADV state + @param message: published air bubbles data message as: h18 bubble status, h18 bubble state @return: None """ + sensor_list =[] + sensor_list.append((td_enum_repository.TDAirBubbleDetectorNames.H18_ADV.name, td_enum_repository.TDAirBubbleDetectorAttributes.STATUS.name, DataTypes.U32)) + sensor_list.append((td_enum_repository.TDAirBubbleDetectorNames.H18_ADV.name, td_enum_repository.TDAirBubbleDetectorAttributes.STATE.name, DataTypes.U32)) - adv_status = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) - adv_state = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2])) - - self.air_bubbles_status = [adv_status[0]] - self.air_bubbles_state = [adv_state[0]] + self.process_into_dict(dict_to_update = self.h18_bubble_detector, + decoder_list = sensor_list, + message = message) self.td_air_bubbles_timestamp = timestamp - def cmd_air_bubble_status_override(self, status: int, index: int, reset: int = NO_RESET) -> int: + + def cmd_air_bubbles_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ + Constructs and sends the air bubbles data broadcast interval override command + Constraints: + Must be logged into TD. + Given interval must be positive non-zero and a multiple of the TD priority 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 = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BUBBLE_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'TD Air Bubble Detector', + logger = self.logger, + can_interface = self.can_interface) + + + def cmd_air_bubble_status_override(self, index: int, status: int, reset: int = NO_RESET) -> int: + """ Constructs and sends the air bubble detector status override command Constraints: Must be logged into TD. @@ -96,75 +123,42 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - rst = integer_to_bytearray(reset) i = integer_to_bytearray(index) stat = integer_to_bytearray(status) payload = rst + stat + i - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BUBBLE_OVERRIDE_REQUEST.value, - payload=payload) + sensor_name = td_enum_repository.TDAirBubbleDetectorNames(index).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_td_ch_id, + msg_id = MsgIds.MSG_ID_TD_BUBBLE_OVERRIDE_REQUEST, + entity_name = f'TD {sensor_name} Bubble Detector status', + override_text = f'{str(status)}', + logger = self.logger, + can_interface = self.can_interface) - if index == self.ADV: - self.logger.debug("Override air bubble detector ADV status value") - - # 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 - - def cmd_air_bubbles_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: + def cmd_venous_bubble_alarm_enable(self, enabled: bool = True) -> int: """ - Constructs and sends the air bubbles data broadcast interval override command + Enable/disable venous bubble alarm triggering. Constraints: - Must be logged into TD. - Given interval must be positive non-zero and a multiple of the TD priority task interval (50 ms). + Must be logged into TD tester mode and testing must be activated. - @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 + @param enabled: bool - True enables alarm triggering, False disables it + @return: 1 if successful, 0 otherwise """ + ena = 1 if enabled else 0 + payload = integer_to_bytearray(ena) - if ms > 0 and ms % 50 == 0: - rst = integer_to_bytearray(reset) - mis = integer_to_bytearray(ms) - payload = rst + mis + return cmd_generic_override( + payload=payload, + reset=NO_RESET, + channel_id=CanChannels.dialin_to_td_ch_id, + msg_id=MsgIds.MSG_ID_TD_ENABLE_VENOUS_BUBBLE_ALARM, + entity_name='TD Enable Venous Bubble Alarm', + override_text=f'{ena}', + logger=self.logger, + can_interface=self.can_interface + ) - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id, - message_id=MsgIds.MSG_ID_TD_BUBBLE_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("Override TD air bubbles data broadcast interval to"+str(ms)+"ms") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(ms) + " ms: " - self.logger.debug("Air bubbles data broadcast interval overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - elif ms <= 0: - self.logger.debug("ms must be positive non-zero.") - return False - elif ms % 50 != 0: - self.logger.debug("ms must be a multiple of 50.") - return False - else: - self.logger.debug("ms must be an integer.") - return False \ No newline at end of file