Index: leahi_dialin/fp/modules/conductivity_sensors.py =================================================================== diff -u -r1f6d8db8a800b32a70eb1176fcbd5263550a7180 -ra291930ba38e329e2b373f6d2b2a7564a6b7a09a --- leahi_dialin/fp/modules/conductivity_sensors.py (.../conductivity_sensors.py) (revision 1f6d8db8a800b32a70eb1176fcbd5263550a7180) +++ leahi_dialin/fp/modules/conductivity_sensors.py (.../conductivity_sensors.py) (revision a291930ba38e329e2b373f6d2b2a7564a6b7a09a) @@ -8,19 +8,20 @@ # @file conductivity_sensors.py # # @author (last) Zoltan Miskolci -# @date (last) 04-Dec-2025 +# @date (last) 09-Jan-2026 # @author (original) Quang Nguyen # @date (original) 20-Jul-2020 # ############################################################################ + import struct from logging import Logger -from .constants import RESET, NO_RESET +from leahi_dialin.common.constants import NO_RESET +from leahi_dialin.common.fp_defs import FPConductivitySensorNames, FPRORejectionRatioEnum 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.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 @@ -32,7 +33,6 @@ def __init__(self, can_interface, logger: Logger): """ - @param can_interface: Denali Can Messenger object """ super().__init__() @@ -51,8 +51,8 @@ self.ro_rejection_ratio_timestamp = 0.0 self.fp_conductivity = { - FPConductivitySensorsEnum.P9_COND.name: 0.0, - FPConductivitySensorsEnum.P18_COND.name: 0.0 + FPConductivitySensorNames.P9_COND.name: 0.0, + FPConductivitySensorNames.P18_COND.name: 0.0 } self.ro_rejection_ratio = { @@ -73,10 +73,9 @@ @param message: published conductivity sensor data message @return: None """ - - self.fp_conductivity[FPConductivitySensorsEnum.P9_COND.name] = struct.unpack('f', bytearray( + self.fp_conductivity[FPConductivitySensorNames.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( + self.fp_conductivity[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 @@ -91,7 +90,6 @@ @param message: Published RO Rejection Ratio data message @return: None """ - 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( @@ -117,13 +115,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, 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,8 +136,7 @@ @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, @@ -160,36 +156,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 = 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) - 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 +182,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 = 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) - 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 +208,42 @@ @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 = 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) - 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) - - 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) - - # 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 + 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)