Index: leahi_dialin/dd/modules/conductivity_sensors.py =================================================================== diff -u -r7c0309a22098e7c4b0ef1599fc737f6f8929b9ac -ra291930ba38e329e2b373f6d2b2a7564a6b7a09a --- leahi_dialin/dd/modules/conductivity_sensors.py (.../conductivity_sensors.py) (revision 7c0309a22098e7c4b0ef1599fc737f6f8929b9ac) +++ leahi_dialin/dd/modules/conductivity_sensors.py (.../conductivity_sensors.py) (revision a291930ba38e329e2b373f6d2b2a7564a6b7a09a) @@ -7,22 +7,23 @@ # # @file conductivity_sensors.py # -# @author (last) Dara Navaei -# @date (last) 15-May-2023 +# @author (last) Zoltan Miskolci +# @date (last) 07-Jan-2026 # @author (original) Quang Nguyen # @date (original) 20-Jul-2020 # ############################################################################ + + import struct from logging import Logger -from enum import unique -from .constants import RESET, NO_RESET +from leahi_dialin.common.constants import NO_RESET +from leahi_dialin.common.dd_defs import DDConductivitySensorNames from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -from leahi_dialin.common.dd_defs import DDConductivitySensorsEnum -from leahi_dialin.protocols.CAN import DenaliMessage, DenaliChannels -from leahi_dialin.utils.base import AbstractSubSystem, publish, DialinEnum -from leahi_dialin.utils.checks import check_broadcast_interval_override_ms +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 @@ -35,7 +36,6 @@ def __init__(self, can_interface, logger: Logger): """ - @param can_interface: Denali Can Messenger object """ super().__init__() @@ -50,15 +50,16 @@ self._handler_conductivity_sensors_sync) self.dd_conductivity = { - DDConductivitySensorsEnum.D17_COND.name: 0.0, - DDConductivitySensorsEnum.D27_COND.name: 0.0, - DDConductivitySensorsEnum.D29_COND.name: 0.0, - DDConductivitySensorsEnum.D43_COND.name: 0.0, - DDConductivitySensorsEnum.D74_COND.name: 0.0 + DDConductivitySensorNames.D17_COND.name: 0.0, + DDConductivitySensorNames.D27_COND.name: 0.0, + DDConductivitySensorNames.D29_COND.name: 0.0, + DDConductivitySensorNames.D43_COND.name: 0.0, + DDConductivitySensorNames.D74_COND.name: 0.0 } self.dd_conductivity_timestamp = 0.0 + @publish(["msg_id_dd_conductivity_data", "dd_conductivity", "dd_conductivity_timestamp"]) def _handler_conductivity_sensors_sync(self, message, timestamp=0.0): """ @@ -68,24 +69,24 @@ @param message: published DD conductivity sensor data message @return: None """ - - self.dd_conductivity[DDConductivitySensorsEnum.D17_COND.name] = struct.unpack('f', bytearray( + self.dd_conductivity[DDConductivitySensorNames.D17_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] - self.dd_conductivity[DDConductivitySensorsEnum.D27_COND.name] = struct.unpack('f', bytearray( + self.dd_conductivity[DDConductivitySensorNames.D27_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] - self.dd_conductivity[DDConductivitySensorsEnum.D29_COND.name] = struct.unpack('f', bytearray( + self.dd_conductivity[DDConductivitySensorNames.D29_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] - self.dd_conductivity[DDConductivitySensorsEnum.D43_COND.name] = struct.unpack('f', bytearray( + self.dd_conductivity[DDConductivitySensorNames.D43_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] - self.dd_conductivity[DDConductivitySensorsEnum.D74_COND.name] = struct.unpack('f', bytearray( + self.dd_conductivity[DDConductivitySensorNames.D74_COND.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] self.dd_conductivity_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 @@ -97,37 +98,16 @@ @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_dd_ch_id, + msg_id = MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'DD Conductivity Sensors', + logger = self.logger, + can_interface = self.can_interface) - if not check_broadcast_interval_override_ms(ms): - return False - reset_byte_array = integer_to_bytearray(reset) - ms_byte_array = integer_to_bytearray(ms) - payload = reset_byte_array + ms_byte_array - - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, - message_id=MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override DD conductivity sensor broadcast interval") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - if reset == RESET: - str_res = "reset back to normal: " - else: - str_res = str(ms) + " ms: " - self.logger.debug("Conductivity sensor data broadcast interval overridden to " + str_res + - str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX])) - # 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_readings_override(self, sensor_index: int, conductivity: float, reset: int = NO_RESET) -> int: """ Constructs and sends the conductivity value override command @@ -139,36 +119,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_index) payload = reset_byte_array + cond_byte_array + sensor_byte_array - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, - message_id=MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_READINGS_OVERRIDE_REQUEST.value, - payload=payload) + sensor_name = DDConductivitySensorNames(sensor_index).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.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', + 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 conductivity sensor value for sensor " + DDConductivitySensorsEnum(sensor_index).name - + ": " + 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_index: int, counter: int, reset: int = NO_RESET) -> int: """ Constructs and sends the conductivity read counter override command @@ -180,36 +148,24 @@ @param counter: int - rad 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_index) payload = reset_byte_array + read_byte_array + sensor_byte_array - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, - message_id=MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_READ_COUNTER_OVERRIDE_REQUEST.value, - payload=payload) + sensor_name = DDConductivitySensorNames(sensor_index).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.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), + 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 conductivity sensor value for sensor " + DDConductivitySensorsEnum[str(sensor_index)].name - + ": " + 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_index: int, counter: int, reset: int = NO_RESET) -> int: """ Constructs and sends the conductivity error count override command @@ -218,32 +174,19 @@ @param counter: int - error 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) error_byte_array = integer_to_bytearray(counter) sensor_byte_array = integer_to_bytearray(sensor_index) payload = reset_byte_array + error_byte_array + sensor_byte_array - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_dd_ch_id, - message_id=MsgIds.MSG_ID_DD_CONDUCTIVITY_SENSOR_ERROR_COUNTER_OVERRIDE_REQUEST.value, - payload=payload) - - if reset == RESET: - str_res = "reset back to normal" - else: - str_res = str(counter) - self.logger.debug("override conductivity sensor value for sensor " + DDConductivitySensorsEnum[str(sensor_index)].name - + ": " + 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 \ No newline at end of file + sensor_name = DDConductivitySensorNames(sensor_index).name.split('_')[0] + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = DenaliChannels.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), + logger = self.logger, + can_interface = self.can_interface)