Index: leahi_dialin/fp/modules/conductivity_sensors.py =================================================================== diff -u -r1f6d8db8a800b32a70eb1176fcbd5263550a7180 -r6ce1aaaa1c5ce4ef44d51d7c805c81e34cdb2499 --- leahi_dialin/fp/modules/conductivity_sensors.py (.../conductivity_sensors.py) (revision 1f6d8db8a800b32a70eb1176fcbd5263550a7180) +++ leahi_dialin/fp/modules/conductivity_sensors.py (.../conductivity_sensors.py) (revision 6ce1aaaa1c5ce4ef44d51d7c805c81e34cdb2499) @@ -8,20 +8,25 @@ # @file conductivity_sensors.py # # @author (last) Zoltan Miskolci -# @date (last) 04-Dec-2025 +# @date (last) 05-May-2026 # @author (original) Quang Nguyen # @date (original) 20-Jul-2020 # ############################################################################ -import struct + +# Module imports from logging import Logger -from .constants import RESET, NO_RESET -from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -from leahi_dialin.common.fp_defs import FPConductivitySensorsEnum, FPRORejectionRatioEnum -from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels -from leahi_dialin.utils.base import AbstractSubSystem, publish +# Project imports +from leahi_dialin.common.constants import NO_RESET +from leahi_dialin.common import fp_enum_repository, dd_enum_repository +from leahi_dialin.common.fp_defs import BETA_IOFP_COND_SENSOR_OFFSET +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 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 @@ -30,37 +35,51 @@ Dialin 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.fp_sync_broadcast_ch_id - self.can_interface.register_receiving_publication_function(channel_id, MsgIds.MSG_ID_FP_CONDUCTIVITY_DATA.value, - self._handler_conductivity_sensors_sync) - self.can_interface.register_receiving_publication_function(channel_id, MsgIds.MSG_ID_FP_RO_REJECTION_RATIO_DATA.value, - self._handler_ro_rejection_ratio_sync) + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.fp_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_FP_CONDUCTIVITY_DATA.value, + function = self._handler_conductivity_sensors_sync) + + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.fp_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_FP_RO_REJECTION_RATIO_DATA.value, + function = self._handler_ro_rejection_ratio_sync) - self.fp_conductivity_timestamp = 0.0 - self.ro_rejection_ratio_timestamp = 0.0 + self.fp_conductivity_timestamp = 0.0 #: The timestamp of the last Conductivity data message + self.ro_rejection_ratio_timestamp = 0.0 #: The timestamp of the last RO Rejection Ratio data message + #: The Conductivity Sensors data in dictionary format self.fp_conductivity = { - FPConductivitySensorsEnum.P9_COND.name: 0.0, - FPConductivitySensorsEnum.P18_COND.name: 0.0 + + fp_enum_repository.FPConductivitySensorNames.P9_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 + }, + fp_enum_repository.FPConductivitySensorNames.P18_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 + }, } + #: The RO Rejection Ratio data in dictionary format self.ro_rejection_ratio = { - FPRORejectionRatioEnum.RAW_RO_REJECTION_RATIO.name: 0.0, - FPRORejectionRatioEnum.RAW_RO_REJECTION_RATIO_TANK_FILL.name: 0.0, - FPRORejectionRatioEnum.AVG_RO_REJECTION_RATIO.name: 0.0, - FPRORejectionRatioEnum.AVG_RO_REJECTION_RATIO_TANK_FILL.name: 0.0, - FPRORejectionRatioEnum.GEN_PERMEATE_STATE.name: 0 + fp_enum_repository.FPRORejectionRatioNames.RAW_RO_REJECTION_RATIO.name: 0.0, + fp_enum_repository.FPRORejectionRatioNames.RAW_RO_REJECTION_RATIO_TANK_FILL.name: 0.0, + fp_enum_repository.FPRORejectionRatioNames.AVG_RO_REJECTION_RATIO.name: 0.0, + fp_enum_repository.FPRORejectionRatioNames.AVG_RO_REJECTION_RATIO_TANK_FILL.name: 0.0, + fp_enum_repository.FPRORejectionRatioNames.GEN_PERMEATE_STATE.name: 0 } @@ -73,12 +92,19 @@ @param message: published conductivity sensor data message @return: None """ + sensor_list =[] + sensor_list.append((fp_enum_repository.FPConductivitySensorNames.P9_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPConductivitySensorNames.P18_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPConductivitySensorNames.P9_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPConductivitySensorNames.P18_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.CONDUCTIVITY_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPConductivitySensorNames.P9_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPConductivitySensorNames.P18_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.RTD_RESISTANCE.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPConductivitySensorNames.P9_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPConductivitySensorNames.P18_COND.name, dd_enum_repository.DDConductivityResistanceAttributes.UNCOMPENSATED_COND.name, DataTypes.F32)) - self.fp_conductivity[FPConductivitySensorsEnum.P9_COND.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] - self.fp_conductivity[FPConductivitySensorsEnum.P18_COND.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] - + self.process_into_dict(dict_to_update = self.fp_conductivity, + decoder_list = sensor_list, + message = message) self.fp_conductivity_timestamp = timestamp @@ -91,18 +117,16 @@ @param message: Published RO Rejection Ratio data message @return: None """ + sensor_list =[] + sensor_list.append((fp_enum_repository.FPRORejectionRatioNames.RAW_RO_REJECTION_RATIO.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPRORejectionRatioNames.RAW_RO_REJECTION_RATIO_TANK_FILL.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPRORejectionRatioNames.AVG_RO_REJECTION_RATIO.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPRORejectionRatioNames.AVG_RO_REJECTION_RATIO_TANK_FILL.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPRORejectionRatioNames.GEN_PERMEATE_STATE.name, DataTypes.U32)) - self.ro_rejection_ratio[FPRORejectionRatioEnum.RAW_RO_REJECTION_RATIO.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] - self.ro_rejection_ratio[FPRORejectionRatioEnum.RAW_RO_REJECTION_RATIO_TANK_FILL.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] - self.ro_rejection_ratio[FPRORejectionRatioEnum.AVG_RO_REJECTION_RATIO.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] - self.ro_rejection_ratio[FPRORejectionRatioEnum.AVG_RO_REJECTION_RATIO_TANK_FILL.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] - self.ro_rejection_ratio[FPRORejectionRatioEnum.GEN_PERMEATE_STATE.name] = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] - + self.process_into_dict(dict_to_update = self.ro_rejection_ratio, + decoder_list = sensor_list, + message = message) self.ro_rejection_ratio_timestamp = timestamp @@ -117,13 +141,12 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - - cmd_generic_broadcast_interval_override( + return cmd_generic_broadcast_interval_override( ms = ms, reset = reset, - channel_id = DenaliChannels.dialin_to_fp_ch_id, + channel_id = CanChannels.dialin_to_fp_ch_id, msg_id = MsgIds.MSG_ID_FP_CONDUCTIVITY_PUBLISH_INTERVAL_OVERRIDE_REQUEST, - module_name = 'FP conductivity sensor', + module_name = 'FP Conductivity Sensor', logger = self.logger, can_interface = self.can_interface) @@ -139,11 +162,10 @@ @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ - - cmd_generic_broadcast_interval_override( + return cmd_generic_broadcast_interval_override( ms = ms, reset = reset, - channel_id = DenaliChannels.dialin_to_fp_ch_id, + channel_id = CanChannels.dialin_to_fp_ch_id, msg_id = MsgIds.MSG_ID_FP_RO_REJECTION_RATIO_PUBLISH_INTERVAL_OVERRIDE_REQUEST, module_name = 'FP RO Rejection Ratio', logger = self.logger, @@ -160,36 +182,24 @@ @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) payload = reset_byte_array + cond_byte_array + sensor_byte_array - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_CONDUCTIVITY_OVERRIDE_REQUEST.value, - payload=payload) + sensor_name = fp_enum_repository.FPConductivitySensorNames(sensor).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_CONDUCTIVITY_OVERRIDE_REQUEST, + entity_name = f'FP {sensor_name} Conductivity Sensor reading', + override_text = f'{str(conductivity)} microsiemens/cm', + logger = self.logger, + can_interface = self.can_interface) - if reset == RESET: - str_res = "reset back to normal" - else: - str_res = str(conductivity) + " microsiemens/cm" - self.logger.debug("override FP 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_conductivity_sensor_read_counter_override(self, sensor: int, counter: int, reset: int = NO_RESET) -> int: """ Constructs and sends the FP conductivity sensor read override command @@ -198,35 +208,24 @@ @param counter: counter - count 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_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_CONDUCTIVITY_READ_COUNT_OVERRIDE_REQUEST.value, - payload=payload) + sensor_name = fp_enum_repository.FPConductivitySensorNames(sensor).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_CONDUCTIVITY_READ_COUNT_OVERRIDE_REQUEST, + entity_name = f'FP {sensor_name} Conductivity Sensor read counter', + override_text = str(counter), + logger = self.logger, + can_interface = self.can_interface) - if reset == RESET: - str_res = "reset back to normal" - else: - str_res = str(counter) - self.logger.debug("override FP conductivity sensor read counter 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_conductivity_sensor_error_counter_override(self, sensor: int, counter: int, reset: int = NO_RESET) -> int: """ Constructs and sends the FP conductivity error counter override command @@ -235,67 +234,102 @@ @param counter: counter - count value to override error counter @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) error_byte_array = integer_to_bytearray(counter) sensor_byte_array = integer_to_bytearray(sensor) payload = reset_byte_array + error_byte_array + sensor_byte_array - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_CONDUCTIVITY_ERROR_COUNT_OVERRIDE_REQUEST.value, - payload=payload) + sensor_name = fp_enum_repository.FPConductivitySensorNames(sensor).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_CONDUCTIVITY_ERROR_COUNT_OVERRIDE_REQUEST, + entity_name = f'FP {sensor_name} Conductivity Sensor error counter', + override_text = str(counter), + logger = self.logger, + can_interface = self.can_interface) - if reset == RESET: - str_res = "reset back to normal" - else: - str_res = str(counter) - self.logger.debug("override FP conductivity sensor error counter 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_ro_rejection_ratio_override(self, value: float, reset: int = NO_RESET) -> int: """ Constructs and sends the FP RO Rejection Ratio override command @param value: float - 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) value_byte_array = float_to_bytearray(value) payload = reset_byte_array + value_byte_array - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_RO_FILTERED_REJECTION_RATIO_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_RO_FILTERED_REJECTION_RATIO_OVERRIDE_REQUEST, + entity_name = f'FP RO Rejection Ratio', + override_text = str(value), + logger = self.logger, + can_interface = self.can_interface) - if reset == RESET: - str_res = "reset back to normal" - else: - str_res = str(value) - self.logger.debug("override FP RO Rejection ratio value: " + str_res) + 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 FP. + Given sensor_index must be one of the sensors defined in ConductivitySensorsEnum - # Send message - received_message = self.can_interface.send(message) + Note: Override only works for Teensy conductivity sensor implementation. D79 is not installed with Teensy sensors. - # 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 + @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 = fp_enum_repository.FPConductivitySensorNames(sensor_index).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_CONDUCTIVITY_SENSOR_RESISTANCE_OVERRIDE_REQUEST, + entity_name = f'FP {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 FP. + Given sensor_index must be one of the sensors defined in FPConductivitySensorsEnum + + @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 + """ + modified_index = sensor_index + BETA_IOFP_COND_SENSOR_OFFSET + reset_byte_array = integer_to_bytearray(reset) + cond_byte_array = float_to_bytearray(conductivity) + sensor_byte_array = integer_to_bytearray(modified_index) + payload = reset_byte_array + cond_byte_array + sensor_byte_array + + sensor_name = fp_enum_repository.FPConductivitySensorNames(sensor_index).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_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) +