########################################################################### # # 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 from ..common.msg_defs import MsgIds, MsgFieldPositions from ..protocols.CAN import DenaliMessage, DenaliChannels from ..utils.base import AbstractSubSystem, publish, DialinEnum from ..utils.checks import check_broadcast_interval_override_ms from ..utils.conversions import integer_to_bytearray, float_to_bytearray @unique class DGTemperaturesNames(DialinEnum): INLET_PRIMARY_HEATER = 0 HEAT_DISINFECT = 1 OUTLET_PRIMARY_HEATER = 2 CONDUCTIVITY_SENSOR_1 = 3 CONDUCTIVITY_SENSOR_2 = 4 OUTLET_DIALYSATE_REDUNDANT = 5 INLET_DIALYSATE = 6 PRIMARY_HEATER_THERMOCOUPLE = 7 TRIMMER_HEATER_THERMOCOUPLE = 8 PRIMARY_HEATER_COLD_JUNCTION = 9 TRIMMER_HEATER_COLD_JUNCTION = 10 PRIMARY_HEATER_INTERNAL = 11 TRIMMER_HEATER_INTERNAL = 12 FPGA_BOARD_SENSOR = 13 LOAD_CELL_A1_B1 = 14 LOAD_CELL_A2_B2 = 15 INTERNAL_THDO_RTD = 16 INTERNAL_TDI_RTD = 17 INTERNAL_THD_RTD = 18 INTERNAL_COND_TEMP_SENSOR = 19 BARO_TEMP_SENSOR = 20 class TemperatureSensors(AbstractSubSystem): def __init__(self, can_interface, logger: Logger): super().__init__() self.can_interface = can_interface self.logger = logger # Dictionary of the temperature sensors self.dg_temperatures_timestamp = 0.0 self.dialysate_inlet_moving_avg = 0.0 self.redundant_outlet_moving_avg = 0.0 self.temperatures = {DGTemperaturesNames.INLET_PRIMARY_HEATER.name: 0.0, DGTemperaturesNames.HEAT_DISINFECT.name: 0.0, DGTemperaturesNames.OUTLET_PRIMARY_HEATER.name: 0.0, DGTemperaturesNames.CONDUCTIVITY_SENSOR_1.name: 0.0, DGTemperaturesNames.CONDUCTIVITY_SENSOR_2.name: 0.0, DGTemperaturesNames.OUTLET_DIALYSATE_REDUNDANT.name: 0.0, DGTemperaturesNames.INLET_DIALYSATE.name: 0.0, DGTemperaturesNames.PRIMARY_HEATER_THERMOCOUPLE.name: 0.0, DGTemperaturesNames.TRIMMER_HEATER_THERMOCOUPLE.name: 0.0, DGTemperaturesNames.PRIMARY_HEATER_COLD_JUNCTION.name: 0.0, DGTemperaturesNames.TRIMMER_HEATER_COLD_JUNCTION.name: 0.0, DGTemperaturesNames.PRIMARY_HEATER_INTERNAL.name: 0.0, DGTemperaturesNames.TRIMMER_HEATER_INTERNAL.name: 0.0, DGTemperaturesNames.FPGA_BOARD_SENSOR.name: 0.0, DGTemperaturesNames.LOAD_CELL_A1_B1.name: 0.0, DGTemperaturesNames.LOAD_CELL_A2_B2.name: 0.0, DGTemperaturesNames.INTERNAL_THDO_RTD.name: 0.0, DGTemperaturesNames.INTERNAL_TDI_RTD.name: 0.0, DGTemperaturesNames.INTERNAL_THD_RTD.name: 0.0, DGTemperaturesNames.INTERNAL_COND_TEMP_SENSOR.name: 0.0, DGTemperaturesNames.BARO_TEMP_SENSOR.name: 0.0} if self.can_interface is not None: channel_id = DenaliChannels.dg_sync_broadcast_ch_id msg_id = MsgIds.MSG_ID_DG_TEMPERATURE_DATA.value self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_temperature_sensors_sync) def get_temperatures_values(self, sensor): """ Gets a temperature sensor's value based on the sensor @param sensor: (int) temperature sensor index @return: The temperature of a temperature sensor """ return self.temperatures[DGTemperaturesNames(sensor).name] @publish(["dg_temperatures_timestamp", "dialysate_inlet_moving_avg", "redundant_outlet_moving_avg", "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.temperatures[DGTemperaturesNames.INLET_PRIMARY_HEATER.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.temperatures[DGTemperaturesNames.HEAT_DISINFECT.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] self.temperatures[DGTemperaturesNames.OUTLET_PRIMARY_HEATER.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] self.temperatures[DGTemperaturesNames.CONDUCTIVITY_SENSOR_1.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] self.temperatures[DGTemperaturesNames.CONDUCTIVITY_SENSOR_2.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] self.temperatures[DGTemperaturesNames.OUTLET_DIALYSATE_REDUNDANT.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6]))[0] self.temperatures[DGTemperaturesNames.INLET_DIALYSATE.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7]))[0] self.temperatures[DGTemperaturesNames.PRIMARY_HEATER_THERMOCOUPLE.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8]))[0] self.temperatures[DGTemperaturesNames.TRIMMER_HEATER_THERMOCOUPLE.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_9:MsgFieldPositions.END_POS_FIELD_9]))[0] self.temperatures[DGTemperaturesNames.PRIMARY_HEATER_COLD_JUNCTION.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_10:MsgFieldPositions.END_POS_FIELD_10]))[0] self.temperatures[DGTemperaturesNames.TRIMMER_HEATER_COLD_JUNCTION.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_11:MsgFieldPositions.END_POS_FIELD_11]))[0] self.temperatures[DGTemperaturesNames.PRIMARY_HEATER_INTERNAL.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_12:MsgFieldPositions.END_POS_FIELD_12]))[0] self.temperatures[DGTemperaturesNames.TRIMMER_HEATER_INTERNAL.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_13:MsgFieldPositions.END_POS_FIELD_13]))[0] self.temperatures[DGTemperaturesNames.FPGA_BOARD_SENSOR.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_14:MsgFieldPositions.END_POS_FIELD_14]))[0] self.temperatures[DGTemperaturesNames.LOAD_CELL_A1_B1.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_15:MsgFieldPositions.END_POS_FIELD_15]))[0] self.temperatures[DGTemperaturesNames.LOAD_CELL_A2_B2.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_16:MsgFieldPositions.END_POS_FIELD_16]))[0] self.temperatures[DGTemperaturesNames.INTERNAL_THDO_RTD.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_17:MsgFieldPositions.END_POS_FIELD_17]))[0] self.temperatures[DGTemperaturesNames.INTERNAL_TDI_RTD.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_18:MsgFieldPositions.END_POS_FIELD_18]))[0] self.temperatures[DGTemperaturesNames.INTERNAL_THD_RTD.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_19:MsgFieldPositions.END_POS_FIELD_19]))[0] self.temperatures[DGTemperaturesNames.INTERNAL_COND_TEMP_SENSOR.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_20:MsgFieldPositions.END_POS_FIELD_20]))[0] self.temperatures[DGTemperaturesNames.BARO_TEMP_SENSOR.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_21:MsgFieldPositions.END_POS_FIELD_21]))[0] self.dialysate_inlet_moving_avg = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_22:MsgFieldPositions.END_POS_FIELD_22]))[0] self.redundant_outlet_moving_avg = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_23:MsgFieldPositions.END_POS_FIELD_23]))[0] self.dg_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 DG. Given interval must be non-zero and a multiple of the DG 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_dg_ch_id, message_id=MsgIds.MSG_ID_TEMPERATURE_SENSORS_PUBLISH_INTERVAL_OVERRIDE.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 DG. 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 @details temperature sensor indexes: \n 0 = Primary Heater Inlet 1 = Heat Disinfect 2 = Primary Heater Outlet 3 = Conductivity Sensor 1 4 = Conductivity Sensor 2 5 = Outlet Dialysate (Redundant) 6 = Inlet Dialysate 7 = Primary Heater Thermocouple 8 = Trimmer Heater Thermocouple 9 = Primary Heater Cold Junction 10 = Trimmer Heater Cold Junction 11 = Primary Heater Internal 12 = Trimmer Heater Internal 13 = FPGA board 14 = Load cell A1/B1 15 = Load cell A2/B2 16 = Internal THDO RTD 17 = Internal TDI RTD 18 = Internal conductivity temp sensor 19 = Barometric temperature sensor """ 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_dg_ch_id, message_id=MsgIds.MSG_ID_TEMPERATURE_SENSORS_VALUE_OVERRIDE.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