########################################################################### # # Copyright (c) 2020-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 conductivity_sensors.py # # @author (last) Zoltan Miskolci # @date (last) 09-Jan-2026 # @author (original) Quang Nguyen # @date (original) 20-Jul-2020 # ############################################################################ import struct from logging import Logger from leahi_dialin.common.constants import NO_RESET from leahi_dialin.common.fp_defs import fp_enum_repository from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override from leahi_dialin.protocols.CAN import DenaliChannels from leahi_dialin.utils.base import AbstractSubSystem, publish from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray class FPConductivitySensors(AbstractSubSystem): """ Dialin API sub-class for conductivity sensors related commands. """ def __init__(self, can_interface, logger: Logger): """ @param can_interface: Denali 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.fp_conductivity_timestamp = 0.0 self.ro_rejection_ratio_timestamp = 0.0 self.fp_conductivity = { fp_enum_repository.FPConductivitySensorNames.P9_COND.name: 0.0, fp_enum_repository.FPConductivitySensorNames.P18_COND.name: 0.0 } self.ro_rejection_ratio = { 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 } @publish(["msg_id_fp_conductivity_data", "fp_conductivity", "fp_conductivity_timestamp"]) def _handler_conductivity_sensors_sync(self, message, timestamp=0.0): """ Handles published FP conductivity sensor data messages. Conductivity sensor data are captured for reference. @param message: published conductivity sensor data message @return: None """ self.fp_conductivity[fp_enum_repository.FPConductivitySensorNames.P9_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.fp_conductivity[fp_enum_repository.FPConductivitySensorNames.P18_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] self.fp_conductivity_timestamp = timestamp @publish(["msg_id_ro_rejection_ratio_data", "ro_rejection_ratio", "ro_rejection_ratio_timestamp"]) def _handler_ro_rejection_ratio_sync(self, message, timestamp=0.0): """ Handles published FP RO Rejection Ratio data messages. RO Rejection Ratio data are captured for reference. @param message: Published RO Rejection Ratio data message @return: None """ self.ro_rejection_ratio[fp_enum_repository.FPRORejectionRatioNames.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[fp_enum_repository.FPRORejectionRatioNames.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[fp_enum_repository.FPRORejectionRatioNames.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[fp_enum_repository.FPRORejectionRatioNames.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[fp_enum_repository.FPRORejectionRatioNames.GEN_PERMEATE_STATE.name] = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] self.ro_rejection_ratio_timestamp = timestamp def cmd_conductivity_sensor_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the FP conductivity sensor data broadcast interval override command Constraints: Must be logged into FP. Given interval must be non-zero and a multiple of the FP general task interval (50 ms). @param ms: integer - interval (in ms) to override with @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ return cmd_generic_broadcast_interval_override( ms = ms, reset = reset, channel_id = DenaliChannels.dialin_to_fp_ch_id, msg_id = MsgIds.MSG_ID_FP_CONDUCTIVITY_PUBLISH_INTERVAL_OVERRIDE_REQUEST, module_name = 'FP Conductivity Sensor', logger = self.logger, can_interface = self.can_interface) def cmd_ro_rejection_ratio_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the FP RO Rejection Ratio broadcast interval override command Constraints: Must be logged into FP. Given interval must be non-zero and a multiple of the FP general task interval (50 ms). @param ms: integer - interval (in ms) to override with @param reset: integer - 1 to reset a previous override, 0 to override @return: 1 if successful, zero otherwise """ return cmd_generic_broadcast_interval_override( ms = ms, reset = reset, channel_id = DenaliChannels.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, can_interface = self.can_interface) def cmd_conductivity_sensor_readings_override(self, sensor: int, conductivity: float, reset: int = NO_RESET) -> int: """ Constructs and sends the FP conductivity value override command. Constraints: Must be logged into FP. @param sensor: unsigned int - sensor ID @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 sensor_name = fp_enum_repository.FPConductivitySensorNames(sensor).name.split('_')[0] return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.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) 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 @param sensor: unsigned int - sensor ID @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 sensor_name = fp_enum_repository.FPConductivitySensorNames(sensor).name.split('_')[0] return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.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) 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 @param sensor: unsigned int - sensor ID @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 sensor_name = fp_enum_repository.FPConductivitySensorNames(sensor).name.split('_')[0] return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.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) 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 return cmd_generic_override( payload = payload, reset = reset, channel_id = DenaliChannels.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)