########################################################################### # # Copyright (c) 2019-2021 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 air_trap.py # # @author (last) Quang Nguyen # @date (last) 07-Jul-2021 # @author (original) Sean Nash # @date (original) 21-Sep-2020 # ############################################################################ import struct from logging import Logger from .constants import RESET, NO_RESET from ..common.msg_defs import MsgIds, MsgFieldPositions from ..protocols.CAN import DenaliMessage, DenaliChannels from ..utils.base import AbstractSubSystem, publish from ..utils.checks import check_broadcast_interval_override_ms from ..utils.conversions import integer_to_bytearray, float_to_bytearray class HDAirTrap(AbstractSubSystem): """ HDAirTrap Hemodialysis Delivery (HD) Dialin API sub-class for air trap related commands. """ # Air trap level sensor IDs LOWER_LEVEL_SENSOR = 0 UPPER_LEVEL_SENSOR = 1 # Air trap level sensor levels AIR_DETECTED_AT_LEVEL = 0 FLUID_DETECTED_AT_LEVEL = 1 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.hd_sync_broadcast_ch_id msg_id = MsgIds.MSG_ID_HD_AIR_TRAP_DATA.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_air_trap_sync) self.lower_level = self.AIR_DETECTED_AT_LEVEL self.upper_level = self.AIR_DETECTED_AT_LEVEL def get_air_trap_levels(self): """ Gets the current air trap levels @return: List containing air trap levels: [Lower, Upper] """ return [self.lower_level, self.upper_level] def get_air_trap_lower_level(self): """ Gets the current air trap lower level reading @return: 0 for air, 1 for fluid at lower level """ return self.lower_level def get_air_trap_upper_level(self): """ Gets the current air trap upper level reading @return: 0 for air, 1 for fluid at upper level """ return self.upper_level @publish(["lower_level", "upper_level"]) def _handler_air_trap_sync(self, message): """ Handles published air trap data messages. Air trap data are captured for reference. @param message: published air trap data message @return: None """ lower = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1])) upper = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2])) self.lower_level = lower[0] self.upper_level = upper[0] def cmd_air_trap_level_sensor_override(self, sensor: int, detected: int, reset: int = NO_RESET) -> int: """ Constructs and sends the air trap level sensor override command Constraints: Must be logged into HD. Given sensor must be one of the sensors listed below. @param sensor: unsigned int - sensor ID @param detected: unsigned int - detected (0=air, 1=fluid) to override sensor with @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise Air trap sensor IDs: \n 0 = Lower level \n 1 = Upper level \n """ rst = integer_to_bytearray(reset) det = float_to_bytearray(detected) idx = integer_to_bytearray(sensor) payload = rst + det + idx message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_hd_ch_id, message_id=MsgIds.MSG_ID_HD_AIR_TRAP_LEVEL_SENSOR_OVERRIDE.value, payload=payload) self.logger.debug("override air trap level sensor detection value for sensor " + str(sensor)) # 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_trap_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the air trap data broadcast interval override command Constraints: Must be logged into HD. Given interval must be non-zero and a multiple of the HD 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 rst = integer_to_bytearray(reset) mis = integer_to_bytearray(ms) payload = rst + mis message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_hd_ch_id, message_id=MsgIds.MSG_ID_HD_AIR_TRAP_SEND_INTERVAL_OVERRIDE.value, payload=payload) self.logger.debug("override HD air trap data broadcast interval") # 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 trap 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