########################################################################### # # Copyright (c) 2019-2020 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 temperature_sensors.py # # @author (last) Peter Lucia # @date (last) 26-Aug-2020 # @author (original) Dara Navaei # @date (original) 02-Jun-2020 # ############################################################################ import struct from ..utils.conversions import integer_to_bytearray from ..utils.conversions import float_to_bytearray from .constants import NO_RESET from ..protocols.CAN import (DenaliMessage, DenaliChannels) from ..utils.base import _AbstractSubSystem, _publish from logging import Logger import enum class TemperatureSensorsEnum(enum.Enum): PRIMARY_HEATER_INLET = 0 PRIMARY_HEATER_OUTLET = 1 CONDUCTIVITY_SENSOR_1 = 2 CONDUCTIVITY_SENSOR_2 = 3 DIALYSATE_REDUNDANT = 4 DIALYSATE = 5 PRIMARY_HEATER_THERMOCOUPLE = 6 TRIMMER_HEATER_THERMOCOUPLE = 7 PRIMARY_HEATER_COLD_JUNCTION = 8 TRIMMER_HEATER_COLD_JUNCTION = 9 PRIMARY_HEATER_INTERNAL = 10 TRIMMER_HEATER_INTERNAL = 11 class TemperatureSensors(_AbstractSubSystem): MSG_ID_DG_TEMPERATURE_DATA = 0x2D MSG_ID_TEMPERATURE_SENSORS_PUBLISH_INTERVAL_OVERRIDE = 0xA012 MSG_ID_TEMPERATURE_SENSORS_VALUE_OVERRIDE = 0xA010 # Inlet primary temperature sensor START_POS_INLET_PRIMARY_TEMP = DenaliMessage.PAYLOAD_START_INDEX END_POS_INLET_PRIMARY_TEMP = START_POS_INLET_PRIMARY_TEMP + 4 # Outlet primary temperature sensor START_POS_OUTLET_PRIMARY_TEMP = END_POS_INLET_PRIMARY_TEMP END_POS_OUTLET_PRIMARY_TEMP = START_POS_OUTLET_PRIMARY_TEMP + 4 # Conductivity sensor 1 temperature sensor START_POS_CD1_TEMP = END_POS_OUTLET_PRIMARY_TEMP END_POS_CD1_TEMP = START_POS_CD1_TEMP + 4 # Conductivity sensor 2 temperature sensor START_POS_CD2_TEMP = END_POS_CD1_TEMP END_POS_CD2_TEMP = START_POS_CD2_TEMP + 4 # Outlet redundancy temperature sensor START_POS_OUTLET_REDUNDANCY_TEMP = END_POS_CD2_TEMP END_POS_OUTLET_REDUNDANCY_TEMP = START_POS_OUTLET_REDUNDANCY_TEMP + 4 # Dialysate inlet temperature sensor START_POS_INLET_DIALYSATE_TEMP = END_POS_OUTLET_REDUNDANCY_TEMP END_POS_INLET_DIALYSATE_TEMP = START_POS_INLET_DIALYSATE_TEMP + 4 # Primary heater thermocouple temperature sensor START_POS_PRI_TC_TEMP = END_POS_INLET_DIALYSATE_TEMP END_POS_PRI_TC_TEMP = START_POS_PRI_TC_TEMP + 4 # Trimmer heater thermocouple temperature sensor START_POS_TRI_TC_TEMP = END_POS_PRI_TC_TEMP END_POS_TRI_TC_TEMP = START_POS_TRI_TC_TEMP + 4 # Primary heater cold junction temperature sensor START_POS_PRI_CJ_TEMP = END_POS_TRI_TC_TEMP END_POS_PRI_CJ_TEMP = START_POS_PRI_CJ_TEMP + 4 # Trimmer heater cold junction temperature sensor START_POS_TRI_CJ_TEMP = END_POS_PRI_CJ_TEMP END_POS_TRI_CJ_TEMP = START_POS_TRI_CJ_TEMP + 4 # Primary heater internal temperature START_POS_PRI_INTERNAL_TEMP = END_POS_TRI_CJ_TEMP END_POS_PRI_INTERNAL_TEMP = START_POS_PRI_INTERNAL_TEMP + 4 # Trimmer heater internal temperature START_POS_TRI_INTERNAL_TEMP = END_POS_PRI_INTERNAL_TEMP END_POS_TRI_INTERNAL_TEMP = START_POS_TRI_INTERNAL_TEMP + 4 def __init__(self, can_interface, logger: Logger): super().__init__() self.can_interface = can_interface self.logger = logger self.inlet_primary = 0.0 self.outlet_primary = 0.0 self.cd1 = 0.0 self.cd2 = 0.0 self.outlet_redundancy = 0.0 self.inlet_dialysate = 0.0 self.primary_tc = 0.0 self.trimmer_tc = 0.0 self.primary_cj = 0.0 self.trimmer_cj = 0.0 self.primary_internal = 0.0 self.trimmer_internal = 0.0 if self.can_interface is not None: channel_id = DenaliChannels.dg_sync_broadcast_ch_id msg_id = self.MSG_ID_DG_TEMPERATURE_DATA self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_temperature_sensors_sync) @_publish(["inlet_primary", "outlet_primary", "cd1", "cd2","outlet_redundancy", "inlet_dialysate", "primary_tc", "trimmer_tc", "primary_cj", "trimmer_cj", "primary_internal", "trimmer_internal"]) def _handler_temperature_sensors_sync(self, message): """ Handles published temperature sensors message @param message: published temperature sensors data message @returns none """ sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_INLET_PRIMARY_TEMP:self.END_POS_INLET_PRIMARY_TEMP])) self.inlet_primary = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_OUTLET_PRIMARY_TEMP:self.END_POS_OUTLET_PRIMARY_TEMP])) self.outlet_primary = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_CD1_TEMP:self.END_POS_CD1_TEMP])) self.cd1 = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_CD2_TEMP:self.END_POS_CD2_TEMP])) self.cd2 = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_OUTLET_REDUNDANCY_TEMP:self.END_POS_OUTLET_REDUNDANCY_TEMP])) self.outlet_redundancy = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_INLET_DIALYSATE_TEMP:self.END_POS_INLET_DIALYSATE_TEMP])) self.inlet_dialysate = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_PRI_TC_TEMP:self.END_POS_PRI_TC_TEMP])) self.primary_tc = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_TRI_TC_TEMP:self.END_POS_TRI_TC_TEMP])) self.trimmer_tc = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_PRI_CJ_TEMP:self.END_POS_PRI_CJ_TEMP])) self.primary_cj = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_TRI_CJ_TEMP:self.END_POS_TRI_CJ_TEMP])) self.trimmer_cj = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_PRI_INTERNAL_TEMP:self.END_POS_PRI_INTERNAL_TEMP])) self.primary_internal = sensors_data[0] sensors_data = struct.unpack('f', bytearray( message['message'][self.START_POS_TRI_INTERNAL_TEMP:self.END_POS_TRI_INTERNAL_TEMP])) self.trimmer_internal = sensors_data[0] def cmd_temperature_sensors_broadcast_interval_override(self, ms, reset=NO_RESET): """ Constructs and sends broadcast time interval. Constraints: Must be logged into DG. Given interval must be non-zero and a multiple of the DG priority task interval (10 ms). @param ms: Publish time interval in ms @param reset: integer - 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ 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=self.MSG_ID_TEMPERATURE_SENSORS_PUBLISH_INTERVAL_OVERRIDE, 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_temperature_sensors_override_value(self, sensor_index, sensor_value, reset=NO_RESET): """ 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 : Index of the sensor @param sensor_value: Value of the sensor to override @returns 1 if successful, zero otherwise \details temperature sensor indexes: \n 0 = Primary Heater Inlet 1 = Primary Heater Outlet 2 = Conductivity Sensor 1 3 = Conductivity Sensor 2 4 = Dialysate (Redundant) 5 = 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 """ 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=self.MSG_ID_TEMPERATURE_SENSORS_VALUE_OVERRIDE, 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