Index: leahi_dialin/dd/modules/conductivity_sensors.py =================================================================== diff -u -r784a986cc5c71b4297c8993bfa3d386388f6972e -r6ce1aaaa1c5ce4ef44d51d7c805c81e34cdb2499 --- leahi_dialin/dd/modules/conductivity_sensors.py (.../conductivity_sensors.py) (revision 784a986cc5c71b4297c8993bfa3d386388f6972e) +++ leahi_dialin/dd/modules/conductivity_sensors.py (.../conductivity_sensors.py) (revision 6ce1aaaa1c5ce4ef44d51d7c805c81e34cdb2499) @@ -8,23 +8,25 @@ # @file conductivity_sensors.py # # @author (last) Zoltan Miskolci -# @date (last) 07-Jan-2026 +# @date (last) 04-May-2026 # @author (original) Quang Nguyen # @date (original) 20-Jul-2020 # ############################################################################ - -import struct +# Module imports from logging import Logger +# Project imports from leahi_dialin.common.constants import NO_RESET -from leahi_dialin.common.dd_defs import dd_enum_repository -from leahi_dialin.common.global_vars import GlobalVariables -from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions +from leahi_dialin.common import dd_enum_repository +from leahi_dialin.common import fp_enum_repository +from leahi_dialin.common.generic_defs import DataTypes +from leahi_dialin.common.msg_defs import MsgIds from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels -from leahi_dialin.utils.base import AbstractSubSystem, publish +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, float_to_bytearray @@ -35,34 +37,66 @@ Dialysate Delivery (DD) API sub-class for conductivity sensors related commands. """ - 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.dd_sync_broadcast_ch_id - self.msg_id_dd_conductivity_data = MsgIds.MSG_ID_DD_CONDUCTIVITY_DATA.value - self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_dd_conductivity_data, - self._handler_conductivity_sensors_sync) + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.dd_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_DATA.value, + function = self._handler_conductivity_sensors_sync) - self.dd_conductivity = { - dd_enum_repository.DDConductivitySensorNames.D17_COND.name: 0.0, - dd_enum_repository.DDConductivitySensorNames.D27_COND.name: 0.0, - dd_enum_repository.DDConductivitySensorNames.D29_COND.name: 0.0, - dd_enum_repository.DDConductivitySensorNames.D43_COND.name: 0.0, - dd_enum_repository.DDConductivitySensorNames.D74_COND.name: 0.0 - } - if GlobalVariables().HW_BETA_1_9: - self.dd_conductivity[dd_enum_repository.DDConductivitySensorNames.D98_COND.name] = 0.0 + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.dd_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_VERSION_RESPONSE.value, + function = self._handler_conductivity_version_sync) - self.dd_conductivity_timestamp = 0.0 + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.dd_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_CAL_RESPONSE.value, + function = self._handler_conductivity_cal_sync) + self.dd_conductivity_timestamp = 0.0 #: The timestamp of the last conductivity message + self.dd_conductivity_cal_timestamp = 0.0 #: The timestamp of the last calibration response message + self.dd_conductivity_version_timestamp = 0.0 #: The timestamp of the last version response message + #: The Conductivity Sensors data in dictionary format + self.dd_conductivity = { + dd_enum_repository.DDConductivitySensorNames.D17_COND.name: { + dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name: 0.0 + }, + dd_enum_repository.DDConductivitySensorNames.D27_COND.name: { + dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name: 0.0 + }, + dd_enum_repository.DDConductivitySensorNames.D29_COND.name: { + dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name: 0.0 + }, + dd_enum_repository.DDConductivitySensorNames.D43_COND.name: { + dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name: 0.0 + }, + dd_enum_repository.DDConductivitySensorNames.D74_COND.name: { + dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name: 0.0, + dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name: 0.0 + }, + } + @publish(["msg_id_dd_conductivity_data", "dd_conductivity", "dd_conductivity_timestamp"]) def _handler_conductivity_sensors_sync(self, message, timestamp=0.0): """ @@ -72,30 +106,53 @@ @param message: published DD conductivity sensor data message @return: None """ - self.dd_conductivity[dd_enum_repository.DDConductivitySensorNames.D17_COND.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] + sensor_list =[] + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D17_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D27_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D29_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D43_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D74_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D17_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D27_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D29_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D43_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D74_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D17_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D27_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D29_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D43_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D74_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D17_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D27_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D29_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D43_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name, DataTypes.F32)) + sensor_list.append((dd_enum_repository.DDConductivitySensorNames.D74_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name, DataTypes.F32)) - self.dd_conductivity[dd_enum_repository.DDConductivitySensorNames.D27_COND.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] - - self.dd_conductivity[dd_enum_repository.DDConductivitySensorNames.D29_COND.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] - - self.dd_conductivity[dd_enum_repository.DDConductivitySensorNames.D43_COND.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] - - self.dd_conductivity[dd_enum_repository.DDConductivitySensorNames.D74_COND.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] - - if GlobalVariables().HW_BETA_1_9: - if dd_enum_repository.DDConductivitySensorNames.D98_COND.name not in self.dd_conductivity: - self.dd_conductivity[dd_enum_repository.DDConductivitySensorNames.D98_COND.name] = 0.0 - self.dd_conductivity[dd_enum_repository.DDConductivitySensorNames.D98_COND.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6]))[0] - + self.process_into_dict(dict_to_update = self.dd_conductivity, + decoder_list = sensor_list, + message = message) self.dd_conductivity_timestamp = timestamp + @publish(["msg_id_dd_conductivity_version_data", "dd_conductivity_resistance", "dd_conductivity_version_timestamp"]) + def _handler_conductivity_version_sync(self, message, timestamp=0.0): + """ + Handles published DD conductivity sensor version response messages. + @param message: published DD conductivity sensor resistance data message + @return: None + """ + #TODO: complete response handler + self.dd_conductivity_version_timestamp = timestamp + @publish(["msg_id_dd_conductivity_cal_data", "dd_conductivity_resistance", "dd_conductivity_cal_timestamp"]) + def _handler_conductivity_cal_sync(self, message, timestamp=0.0): + """ + Handles published DD conductivity sensor calibration response messages. + @param message: published DD conductivity sensor resistance data message + @return: None + """ + #TODO: complete response handler + self.dd_conductivity_cal_timestamp = timestamp + def cmd_conductivity_sensor_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the conductivity sensor data broadcast interval override command @@ -110,7 +167,7 @@ return cmd_generic_broadcast_interval_override( ms = ms, reset = reset, - channel_id = DenaliChannels.dialin_to_dd_ch_id, + channel_id = CanChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_PUBLISH_INTERVAL_OVERRIDE_REQUEST, module_name = 'DD Conductivity Sensors', logger = self.logger, @@ -138,7 +195,7 @@ return cmd_generic_override( payload = payload, reset = reset, - channel_id = DenaliChannels.dialin_to_dd_ch_id, + channel_id = CanChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_READINGS_OVERRIDE_REQUEST, entity_name = f'DD {sensor_name} Conductivity Sensor reading', override_text = f'{str(conductivity)} microsiemens/cm', @@ -167,7 +224,7 @@ return cmd_generic_override( payload = payload, reset = reset, - channel_id = DenaliChannels.dialin_to_dd_ch_id, + channel_id = CanChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_READINGS_OVERRIDE_REQUEST, entity_name = f'DD {sensor_name} Conductivity Sensor read counter', override_text = str(counter), @@ -192,7 +249,7 @@ return cmd_generic_override( payload = payload, reset = reset, - channel_id = DenaliChannels.dialin_to_dd_ch_id, + channel_id = CanChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_ERROR_COUNTER_OVERRIDE_REQUEST, entity_name = f'DD {sensor_name} Conductivity Sensor error counter', override_text = str(counter), @@ -218,10 +275,111 @@ return cmd_generic_override( payload = payload, reset = 0, - channel_id = DenaliChannels.dialin_to_dd_ch_id, + channel_id = CanChannels.dialin_to_dd_ch_id, msg_id = MsgIds.MSG_ID_DD_SET_CONDUCTIVITY_MODEL_REQUEST, entity_name = f'DD set Conductivity Model ID', override_text = str(model_id), logger = self.logger, can_interface = self.can_interface) + def cmd_conductivity_sensor_resistance_override(self, sensor_index: int, conductivity: float, reset: int = NO_RESET) -> int: + """ + Constructs and sends the conductivity resistance override command + Constraints: + Must be logged into DD. + Given sensor_index must be one of the sensors defined in ConductivitySensorsEnum + + Note: Override only works for Teensy conductivity sensor implementation. D79 is not installed with Teensy sensors. + + @param sensor_index: unsigned int - index of the sensor + @param conductivity: float - conductivity 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) + cond_byte_array = float_to_bytearray(conductivity) + sensor_byte_array = integer_to_bytearray(sensor_index) + payload = reset_byte_array + cond_byte_array + sensor_byte_array + + sensor_name = dd_enum_repository.DDConductivitySensorNames(sensor_index).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_dd_ch_id, + msg_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_RESISTANCE_OVERRIDE_REQUEST, + entity_name = f'DD {sensor_name} Conductivity Sensor resistance', + override_text = f'{str(conductivity)} ohms', + logger = self.logger, + can_interface = self.can_interface) + + def cmd_conductivity_sensor_filtered_readings_override(self, sensor_index: int, conductivity: float, reset: int = NO_RESET) -> int: + """ + Constructs and sends the conductivity value override command + Constraints: + Must be logged into DD. + Given sensor_index must be one of the sensors defined in ConductivitySensorsEnum + + @param sensor_index: unsigned int - index of the sensor + @param conductivity: float - conductivity 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) + cond_byte_array = float_to_bytearray(conductivity) + sensor_byte_array = integer_to_bytearray(sensor_index) + payload = reset_byte_array + cond_byte_array + sensor_byte_array + + sensor_name = dd_enum_repository.DDConductivitySensorNames(sensor_index).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_dd_ch_id, + msg_id = MsgIds.MSG_ID_DD_FILTERED_COND_SENSOR_READINGS_OVERRIDE_REQUEST, + entity_name = f'DD {sensor_name} Conductivity Sensor reading', + override_text = f'{str(conductivity)} microsiemens/cm', + logger = self.logger, + can_interface = self.can_interface) + + def cmd_conductivity_sensor_version_request(self, sensor_index: int ) -> None: + """ + Constructs and sends the conductivity version request command + Constraints: + Must be logged into DD. + Given sensor_index must be one of the sensors defined in ConductivitySensorsEnum + + @param sensor_index: unsigned int - index of the sensor + @return: None. Reponse handler will retrieve version data. + """ + sensor_byte_array = integer_to_bytearray(sensor_index) + payload = sensor_byte_array + + cmd_generic_override(payload = payload, + reset = None, + channel_id = CanChannels.dialin_to_dd_ch_id, + msg_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_VERSION_REQUEST, + entity_name = 'DD Conductivity Version Request', + override_text = 'N/A', + logger = self.logger, + can_interface = self.can_interface) + + def cmd_conductivity_sensor_calibration_request(self, sensor_index: int ) -> None: + """ + Constructs and sends the conductivity sensor calibration request command + Constraints: + Must be logged into DD. + Given sensor_index must be one of the sensors defined in ConductivitySensorsEnum + + @param sensor_index: unsigned int - index of the sensor + @return: None. Response handler will retrieve version data. + """ + sensor_byte_array = integer_to_bytearray(sensor_index) + payload = sensor_byte_array + + cmd_generic_override(payload = payload, + reset = None, + channel_id = CanChannels.dialin_to_dd_ch_id, + msg_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_CAL_REQUEST, + entity_name = 'DD Conductivity Calibration Request', + override_text = 'N/A', + logger = self.logger, + can_interface = self.can_interface) \ No newline at end of file