########################################################################### # # Copyright (c) 2021-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 temperatures.py # # @author (last) Micahel Garthwaite # @date (last) 28-Jul-2023 # @author (original) Dara Navaei # @date (original) 01-Dec-2021 # ############################################################################ import struct from enum import unique from logging import Logger from .constants import NO_RESET, 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 DDTemperaturesNames(DialinEnum): D1_TEMP = 0 # Heat exchanger Inlet temperature sensor X6_TEMP = 1 # Heat exchanger Outlet temperature sensor D4_TEMP = 2 # Hydraulics primary heater temperature sensor D50_TEMP = 3 # Trimmer heater temperature sensor BARO_TEMP = 4 # Barometric temperature sensor BRD_TEMP = 5 # DD board temperature sensor ( thermistor ) D17_COND = 6 # Bicarb only conductivity sensor temp D27_COND = 7 # Acid and Bicarb mix conductivity sensor - 1 temp D29_COND = 8 # Acid and Bicarb mix conductivity sensor - 2 temp D43_COND = 9 # Spent dialysate conductivity sensor temp class DDTemperatureSensors(AbstractSubSystem): def __init__(self, can_interface, logger: Logger): super().__init__() self.can_interface = can_interface self.logger = logger # Dictionary of the temperature sensors self.dd_temperatures_timestamp = 0.0 self.dd_temperatures = {DDTemperaturesNames.D1_TEMP.name: 0.0, DDTemperaturesNames.X6_TEMP.name: 0.0, DDTemperaturesNames.D4_TEMP.name: 0.0, DDTemperaturesNames.D50_TEMP.name: 0.0, DDTemperaturesNames.BARO_TEMP.name: 0.0, DDTemperaturesNames.BRD_TEMP.name: 0.0, DDTemperaturesNames.D17_COND.name: 0.0, DDTemperaturesNames.D27_COND.name: 0.0, DDTemperaturesNames.D29_COND.name: 0.0, DDTemperaturesNames.D43_COND.name: 0.0,} if self.can_interface is not None: channel_id = DenaliChannels.dd_sync_broadcast_ch_id msg_id = MsgIds.MSG_ID_DD_TEMPERATURE_DATA.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_temperature_sensors_sync) @publish(["dd_temperatures_timestamp", "dd_temperatures"]) def _handler_temperature_sensors_sync(self, message,timestamp=0.0): """ Handles published temperature sensors message @param message: published temperature sensors data message @returns none """ self.dd_temperatures[DDTemperaturesNames.D1_TEMP.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.dd_temperatures[DDTemperaturesNames.X6_TEMP.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] self.dd_temperatures[DDTemperaturesNames.D4_TEMP.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] self.dd_temperatures[DDTemperaturesNames.D50_TEMP.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] self.dd_temperatures[DDTemperaturesNames.BARO_TEMP.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] self.dd_temperatures[DDTemperaturesNames.BRD_TEMP.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6]))[0] self.dd_temperatures[DDTemperaturesNames.D17_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7]))[0] self.dd_temperatures[DDTemperaturesNames.D27_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8]))[0] self.dd_temperatures[DDTemperaturesNames.D29_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_9:MsgFieldPositions.END_POS_FIELD_9]))[0] self.dd_temperatures[DDTemperaturesNames.D43_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_10:MsgFieldPositions.END_POS_FIELD_10]))[0] self.dd_temperatures_timestamp = timestamp def cmd_temperatures_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends broadcast time interval. 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: (int) Publish time interval in ms @param reset: (int) 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ if not check_broadcast_interval_override_ms(ms): return False reset_value = integer_to_bytearray(reset) interval_value = integer_to_bytearray(ms) payload = reset_value + interval_value message = DenaliMessage.build_message( channel_id=DenaliChannels.dialin_to_dd_ch_id, message_id=MsgIds.MSG_ID_DD_TEMPERATURE_SENSOR_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, payload=payload) self.logger.debug("Sending {} ms publish interval to the Temperature Sensors module".format(ms)) # Send message received_message = self.can_interface.send(message) # If there is content in message if received_message is not None: # Response payload is OK or not return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] else: self.logger.debug("Timeout!!!!") return False def cmd_temperatures_value_override(self, sensor_index: int, sensor_value: float, reset: int = NO_RESET) -> int: """ Constructs and sends the value override of a temperature sensor. Constraints: Must be logged into DD. Given sensor_index must be one of the sensors listed below. @param sensor_index : (int) Index of the sensor @param sensor_value: (float) Value of the sensor to override @param reset: (int) whether to reset the override value. The default is NO_RESET @returns 1 if successful, zero otherwise """ rst = integer_to_bytearray(reset) value = float_to_bytearray(sensor_value) index = integer_to_bytearray(sensor_index) payload = rst + value + index message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, message_id=MsgIds.MSG_ID_DD_TEMPERATURE_SENSOR_MEASURED_TEMPERATURE_OVERRIDE_REQUEST.value, payload=payload) self.logger.debug("Setting sensor {} to {} C".format(sensor_index, sensor_value)) # Send message received_message = self.can_interface.send(message) # If there is content in message if received_message is not None: # Response payload is OK or not return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] else: self.logger.debug("Timeout!!!!") return False def cmd_temperature_sensor_read_counter_override(self, sensor: int, counter: int, reset: int = NO_RESET) -> int: """ Constructs and sends the temperature value override command @param sensor: unsigned int - sensor ID @param counter: float - temperature value to override sensor 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) read_byte_array = integer_to_bytearray(counter) sensor_byte_array = integer_to_bytearray(sensor) payload = reset_byte_array + read_byte_array + sensor_byte_array message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, message_id=MsgIds.MSG_ID_DD_TEMPERATURE_SENSOR_READ_COUNTER_OVERRIDE_REQUEST.value, payload=payload) if reset == RESET: str_res = "reset back to normal" else: str_res = str(counter) + " celsius" self.logger.debug("override conductivity sensor value for sensor " + str(sensor) + ": " + 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_baro_sensor_read_counter_override(self, counter: int, reset: int = NO_RESET) -> int: """ Constructs and sends the barometer sensor read counter override command @param counter: int - barometer sensor read counter value to override sensor 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) read_byte_array = integer_to_bytearray(counter) payload = reset_byte_array + read_byte_array message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, message_id=MsgIds.MSG_ID_DD_TEMPERATURE_SENSOR_BARO_READ_COUNTER_OVERRIDE_REQUEST.value, payload=payload) if reset == RESET: str_res = "reset back to normal" else: str_res = str(counter) self.logger.debug("override baro sensor value for sensor " + ": " + 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_baro_sensor_crc_override(self, crc: int, reset: int = NO_RESET) -> int: """ Constructs and sends the barometer sensor CRC override command @param crc: int - the crc value to override sensor 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) read_byte_array = integer_to_bytearray(crc) payload = reset_byte_array + read_byte_array message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, message_id=MsgIds.MSG_ID_DD_TEMPERATURE_SENSOR_BARO_CRC_OVERRIDE_REQUEST.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.error("Timeout!!!!") return False