Index: leahi_dialin/fp/modules/flow_sensors.py =================================================================== diff -u -r070dbb7a7bbd42c2879768f1eb592bcb188db1c9 -r1f2bf6d939eb4033dbedb7d7005494cc12fccbc6 --- leahi_dialin/fp/modules/flow_sensors.py (.../flow_sensors.py) (revision 070dbb7a7bbd42c2879768f1eb592bcb188db1c9) +++ leahi_dialin/fp/modules/flow_sensors.py (.../flow_sensors.py) (revision 1f2bf6d939eb4033dbedb7d7005494cc12fccbc6) @@ -7,53 +7,55 @@ # # @file flow_sensors.py # -# @author (last) Micahel Garthwaite -# @date (last) 17-Aug-2023 +# @author (last) Zoltan Miskolci +# @date (last) 05-May-2026 # @author (original) Peter Lucia # @date (original) 02-Apr-2020 # ############################################################################ -import struct -from enum import unique + +# 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 FPFlowSensorNames -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 +# Project imports +from leahi_dialin.common.constants import NO_RESET +from leahi_dialin.common import fp_enum_repository +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 class FPFlowSensors(AbstractSubSystem): """ - API sub-class for FP flow sensor 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.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.can_interface.register_receiving_publication_function(channel_id = CanChannels.fp_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_FP_FLOW_DATA.value, + function = self._handler_flow_sensor_sync) + self.fp_flow_timestamp = 0 #: The timestamp of the last message + + #: The Flow Sensors data in dictionary format self.fp_flows = { - FPFlowSensorNames.P7_FLOW.name: 0.0, - FPFlowSensorNames.P16_FLOW.name: 0.0 + fp_enum_repository.FPFlowSensorNames.P7_FLOW.name: 0.0, + fp_enum_repository.FPFlowSensorNames.P16_FLOW.name: 0.0 } - self.fp_flow_timestamp = 0 @publish(["msg_id_fp_flow_data", "fp_flows", "fp_flows_timestamp"]) def _handler_flow_sensor_sync(self, message, timestamp=0.0): @@ -63,13 +65,16 @@ @param message: published flow sensor data message @returns none """ - self.fp_flows[FPFlowSensorNames.P7_FLOW.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] - self.fp_flows[FPFlowSensorNames.P16_FLOW.name] = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] + sensor_list =[] + sensor_list.append((fp_enum_repository.FPFlowSensorNames.P7_FLOW.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPFlowSensorNames.P16_FLOW.name, DataTypes.F32)) + self.process_into_dict(dict_to_update = self.fp_flows, + decoder_list = sensor_list, + message = message) 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. @@ -81,29 +86,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 = CanChannels.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_FP_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. @@ -118,20 +110,18 @@ lvl = integer_to_bytearray(flow_sensor) 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_FP_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 = CanChannels.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: """ @@ -147,20 +137,18 @@ 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_FP_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 = CanChannels.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 def cmd_filtered_flow_rate_override(self, flow_sensor: int, rate: float, reset: int = NO_RESET) -> int: """ @@ -176,20 +164,18 @@ lvl = integer_to_bytearray(flow_sensor) sts = float_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_FP_FILTERED_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 = CanChannels.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) - # 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_filtered_flow_temp_override(self, flow_sensor: int, temp: float, reset: int = NO_RESET) -> int: """ @@ -205,17 +191,14 @@ 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_FP_FILTERED_FLOW_TEMP_OVERRIDE_REQUEST.value, - payload=payload) - # 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 \ No newline at end of file + sensor_name = fp_enum_repository.FPFlowSensorNames(flow_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_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)