Index: leahi_dialin/fp/modules/flow_sensors.py =================================================================== diff -u -r5b9473d9ca6a66d4d03c509fae6051710895b498 -r38e8dd31728056dbb7f9304c98ab16d7147b75a2 --- leahi_dialin/fp/modules/flow_sensors.py (.../flow_sensors.py) (revision 5b9473d9ca6a66d4d03c509fae6051710895b498) +++ leahi_dialin/fp/modules/flow_sensors.py (.../flow_sensors.py) (revision 38e8dd31728056dbb7f9304c98ab16d7147b75a2) @@ -7,81 +7,68 @@ # # @file flow_sensors.py # -# @author (last) Micahel Garthwaite -# @date (last) 17-Aug-2023 +# @author (last) Zoltan Miskolci +# @date (last) 09-Jan-2026 # @author (original) Peter Lucia # @date (original) 02-Apr-2020 # ############################################################################ + import struct -from enum import unique 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 fp_enum_repository from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions -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 -@unique -class FPFlowSensorNames(DialinEnum): - P7_FLOW = 0 # Water inlet flow sensor (FMS P7) - P16_FLOW = 1 # RO outlet flow sensor (FMP P16) - - class FPFlowSensors(AbstractSubSystem): """ - API sub-class for FP flow sensor 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 - msg_id = MsgIds.MSG_ID_RO_FLOW_DATA.value - self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_flow_sensor_sync) + self.msg_id_fp_flow_data = MsgIds.MSG_ID_FP_FLOW_DATA.value + self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_fp_flow_data, self._handler_flow_sensor_sync) + self.fp_flows = { + fp_enum_repository.FPFlowSensorNames.P7_FLOW.name: 0.0, + fp_enum_repository.FPFlowSensorNames.P16_FLOW.name: 0.0 + } - self.p7_flow = 0.0 - self.p16_flow = 0.0 - self.p7_temp = 0.0 - self.p16_temp = 0.0 - self.fp_flow_timestamp = 0 - @publish(["fp_flows_timestamp", - "p7_flow", "p16_flow", - "p7_temp", "p16_temp"]) + + @publish(["msg_id_fp_flow_data", "fp_flows", "fp_flows_timestamp"]) def _handler_flow_sensor_sync(self, message, timestamp=0.0): """ Handles published flow sensor message @param message: published flow sensor data message @returns none """ - self.p7_flow = struct.unpack('f', bytearray( + self.fp_flows[fp_enum_repository.FPFlowSensorNames.P7_FLOW.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] - self.p16_flow = struct.unpack('f', bytearray( + self.fp_flows[fp_enum_repository.FPFlowSensorNames.P16_FLOW.name] = struct.unpack('f', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] - self.p7_temp = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] - self.p16_temp = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] - self.fp_flows_timestamp = timestamp + self.fp_flow_timestamp = timestamp + def cmd_flow_sensor_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends an FP flow sensor broadcast interval override command message. @@ -93,29 +80,16 @@ @param reset: (int) 1 to reset a previous override, 0 to override @returns 1 if successful, zero otherwise """ - if not check_broadcast_interval_override_ms(ms): - return False + return cmd_generic_broadcast_interval_override( + ms = ms, + reset = reset, + channel_id = DenaliChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_FLOWS_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'FP Flow Sensor', + logger = self.logger, + can_interface = self.can_interface) - reset_value = integer_to_bytearray(reset) - interval_value = integer_to_bytearray(ms) - payload = reset_value + interval_value - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_RO_FLOWS_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("Sending {} ms publish interval to the FP flow sensor module".format(ms)) - # Send message - received_message = self.can_interface.send(message) - - # If there is content in message - if received_message is not None: - # Response payload is OK or not - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_flow_rate_override(self, flow_sensor: int, rate: int, reset: int = NO_RESET) -> int: """ Constructs and sends flow rate override command. @@ -128,22 +102,20 @@ """ reset_value = integer_to_bytearray(reset) lvl = integer_to_bytearray(flow_sensor) - sts = float_to_bytearray(rate) + sts = integer_to_bytearray(rate) payload = reset_value + sts + lvl - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_RO_FLOW_RATE_OVERRIDE_REQUEST.value, - payload=payload) - # Send message - received_message = self.can_interface.send(message) + sensor_name = fp_enum_repository.FPFlowSensorNames(flow_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_FLOW_RATE_OVERRIDE_REQUEST, + entity_name = f'FP {sensor_name} Flow Sensor flow rate', + override_text = f'{str(rate)}', + logger = self.logger, + can_interface = self.can_interface) - # If there is content in message - if received_message is not None: - # Response payload is OK or not - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False def cmd_flow_temp_override(self, flow_sensor: int, temp: float, reset: int = NO_RESET) -> int: """ @@ -159,17 +131,68 @@ lvl = integer_to_bytearray(flow_sensor) sts = float_to_bytearray(temp) payload = reset_value + sts + lvl - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_RO_FLOW_TEMP_OVERRIDE_REQUEST.value, - payload=payload) - # Send message - received_message = self.can_interface.send(message) + sensor_name = fp_enum_repository.FPFlowSensorNames(flow_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_FLOW_TEMP_OVERRIDE_REQUEST, + entity_name = f'FP {sensor_name} Flow Sensor temperature', + override_text = f'{str(temp)} C', + logger = self.logger, + can_interface = self.can_interface) - # If there is content in message - if received_message is not None: - # Response payload is OK or not - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False \ No newline at end of file + + def cmd_filtered_flow_rate_override(self, flow_sensor: int, rate: float, reset: int = NO_RESET) -> int: + """ + Constructs and sends filtered flow rate override command. + Must be logged into FP. + + @param flow_sensor: integer - the sensor to override its value. + @param rate: integer - the rate value to override. + @param reset: integer - 1 to reset a previous override, 0 to override + @returns 1 if successful, zero otherwise + """ + reset_value = integer_to_bytearray(reset) + lvl = integer_to_bytearray(flow_sensor) + sts = float_to_bytearray(rate) + payload = reset_value + sts + lvl + + sensor_name = fp_enum_repository.FPFlowSensorNames(flow_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_FILTERED_FLOW_RATE_OVERRIDE_REQUEST, + entity_name = f'FP {sensor_name} Flow Sensor filtered flow rate', + override_text = f'{str(rate)}', + logger = self.logger, + can_interface = self.can_interface) + + + def cmd_filtered_flow_temp_override(self, flow_sensor: int, temp: float, reset: int = NO_RESET) -> int: + """ + Constructs and sends filtered flow temp override command. + Must be logged into FP. + + @param flow_sensor: integer - the sensor to override its value + @param temp: float - the temperature value to override + @param reset: integer - 1 to reset a previous override, 0 to override + @returns 1 if successful, zero otherwise + """ + reset_value = integer_to_bytearray(reset) + lvl = integer_to_bytearray(flow_sensor) + sts = float_to_bytearray(temp) + payload = reset_value + sts + lvl + + sensor_name = fp_enum_repository.FPFlowSensorNames(flow_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_FILTERED_FLOW_TEMP_OVERRIDE_REQUEST, + entity_name = f'FP {sensor_name} Flow Sensor filtered temperature', + override_text = f'{str(temp)} C', + logger = self.logger, + can_interface = self.can_interface)