########################################################################### # # 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 flow_sensors.py # # @author (last) Zoltan Miskolci # @date (last) 09-Jan-2026 # @author (original) Peter Lucia # @date (original) 02-Apr-2020 # ############################################################################ import struct from logging import Logger from leahi_dialin.common.constants import NO_RESET from leahi_dialin.common.fp_defs import FPFlowSensorNames 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 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 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 = { FPFlowSensorNames.P7_FLOW.name: 0.0, 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): """ Handles published flow sensor message @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] 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. 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: (int) Publish time interval in ms @param reset: (int) 1 to reset a previous override, 0 to override @returns 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_FLOWS_PUBLISH_INTERVAL_OVERRIDE_REQUEST, module_name = 'FP Flow Sensor', logger = self.logger, can_interface = self.can_interface) def cmd_flow_rate_override(self, flow_sensor: int, rate: int, reset: int = NO_RESET) -> int: """ Constructs and sends 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 = integer_to_bytearray(rate) payload = reset_value + sts + lvl sensor_name = 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) def cmd_flow_temp_override(self, flow_sensor: int, temp: float, reset: int = NO_RESET) -> int: """ Constructs and sends 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 = 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) 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 = 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 = 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)