Index: leahi_dialin/fp/modules/ro_pump.py =================================================================== diff -u -rb4df138485c0c52360b6f43d7bd9e92e1c15969a -r465679409a5fe6f6007ddffca1fd3e89ead9d9c4 --- leahi_dialin/fp/modules/ro_pump.py (.../ro_pump.py) (revision b4df138485c0c52360b6f43d7bd9e92e1c15969a) +++ leahi_dialin/fp/modules/ro_pump.py (.../ro_pump.py) (revision 465679409a5fe6f6007ddffca1fd3e89ead9d9c4) @@ -7,31 +7,34 @@ # # @file ro_pump.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 enum import unique -from leahi_dialin.utils.base import DialinEnum -from .constants import RESET, NO_RESET -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 +# 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 FPROPump(AbstractSubSystem): """ Dialin API sub-class for FP RO pump controller related commands. """ - def __init__(self, can_interface, logger: Logger): + def __init__(self, can_interface: CanMessenger, logger: Logger): """ FPROPump constructor """ @@ -40,24 +43,29 @@ self.logger = logger if self.can_interface is not None: - channel_id = DenaliChannels.fp_sync_broadcast_ch_id - msg_id = MsgIds.MSG_ID_FP_RO_PUMP_DATA.value - self.can_interface.register_receiving_publication_function(channel_id, msg_id, - self._handler_pump_sync) - self.ro_pump_timestamp = 0.0 - self.p12_pump_state = 0 - self.p12_pump_duty_cycle = 0 - self.p12_pump_fb_duty_cycle = 0 - self.p12_pump_speed = 0.0 - self.p12_target_pressure = 0.0 - self.p12_target_flow = 0.0 - self.p12_target_duty_cycle = 0.0 - self.p12_pump_duty_cycle_pct = 0.0 - self.p12_pump_fb_duty_cycle_pct = 0.0 + self.can_interface.register_receiving_publication_function(channel_id = CanChannels.fp_sync_broadcast_ch_id, + message_id = MsgIds.MSG_ID_FP_RO_PUMP_DATA.value, + function = self._handler_pump_sync) - @publish(["ro_pump_timestamp", "p12_pump_state", "p12_pump_duty_cycle", "p12_pump_fb_duty_cycle", - "p12_pump_speed", "p12_target_pressure", "p12_target_flow", "p12_target_duty_cycle", - "p12_pump_duty_cycle_pct", "p12_pump_fb_duty_cycle_pct" ]) + self.ro_pump_timestamp = 0.0 #: The timestamp of the last message + + # The RO Pump data in dictionary format + self.ro_pump = { + fp_enum_repository.FPROPumpNames.P12_PUMP.name: { + fp_enum_repository.FPPumpAttributes.STATE.name: fp_enum_repository.FPROPumpStates.PUMP_OFF_STATE.value, + fp_enum_repository.FPPumpAttributes.DUTY_CYCLE.name: 0, + fp_enum_repository.FPPumpAttributes.FB_DUTY_CYCLE.name: 0, + fp_enum_repository.FPPumpAttributes.SPEED.name: 0.0, + fp_enum_repository.FPPumpAttributes.TARGET_PRES.name: 0.0, + fp_enum_repository.FPPumpAttributes.TARGET_FLOW.name: 0.0, + fp_enum_repository.FPPumpAttributes.TARGET_DUTY_CYCLE_PCT.name: 0.0, + fp_enum_repository.FPPumpAttributes.DUTY_CYCLE_PCT.name: 0.0, + fp_enum_repository.FPPumpAttributes.FB_DUTY_CYCLE_PCT.name: 0.0 + } + } + + + @publish(["msg_id_fp_ro_pump_data", "ro_pump", "ro_pump_timestamp" ]) def _handler_pump_sync(self, message, timestamp=0.0): """ Handles published FP ro pump data messages. FP ro pump data is captured @@ -66,28 +74,23 @@ @param message: published FP ro pump data message @return: none """ + sensor_list =[] + sensor_list.append((fp_enum_repository.FPROPumpNames.P12_PUMP.name, fp_enum_repository.FPPumpAttributes.STATE.name, DataTypes.U32)) + sensor_list.append((fp_enum_repository.FPROPumpNames.P12_PUMP.name, fp_enum_repository.FPPumpAttributes.DUTY_CYCLE.name, DataTypes.U32)) + sensor_list.append((fp_enum_repository.FPROPumpNames.P12_PUMP.name, fp_enum_repository.FPPumpAttributes.FB_DUTY_CYCLE.name, DataTypes.U32)) + sensor_list.append((fp_enum_repository.FPROPumpNames.P12_PUMP.name, fp_enum_repository.FPPumpAttributes.SPEED.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPROPumpNames.P12_PUMP.name, fp_enum_repository.FPPumpAttributes.TARGET_PRES.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPROPumpNames.P12_PUMP.name, fp_enum_repository.FPPumpAttributes.TARGET_FLOW.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPROPumpNames.P12_PUMP.name, fp_enum_repository.FPPumpAttributes.TARGET_DUTY_CYCLE_PCT.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPROPumpNames.P12_PUMP.name, fp_enum_repository.FPPumpAttributes.DUTY_CYCLE_PCT.name, DataTypes.F32)) + sensor_list.append((fp_enum_repository.FPROPumpNames.P12_PUMP.name, fp_enum_repository.FPPumpAttributes.FB_DUTY_CYCLE_PCT.name, DataTypes.F32)) - self.p12_pump_state = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] - self.p12_pump_duty_cycle = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0] - self.p12_pump_fb_duty_cycle = struct.unpack('i', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0] - self.p12_pump_speed = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0] - self.p12_target_pressure = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0] - self.p12_target_flow = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_6:MsgFieldPositions.END_POS_FIELD_6]))[0] - self.p12_target_duty_cycle = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_7:MsgFieldPositions.END_POS_FIELD_7]))[0] - self.p12_pump_duty_cycle_pct = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_8:MsgFieldPositions.END_POS_FIELD_8]))[0] - self.p12_pump_fb_duty_cycle_pct = struct.unpack('f', bytearray( - message['message'][MsgFieldPositions.START_POS_FIELD_9:MsgFieldPositions.END_POS_FIELD_9]))[0] - + self.process_into_dict(dict_to_update = self.ro_pump, + decoder_list = sensor_list, + message = message) self.ro_pump_timestamp = timestamp + def cmd_ro_pump_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int: """ Constructs and sends the FP RO pump broadcast interval override command @@ -99,38 +102,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 = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_RO_PUMP_PUBLISH_INTERVAL_OVERRIDE_REQUEST, + module_name = 'FP RO Pump', + logger = self.logger, + can_interface = self.can_interface) - if not check_broadcast_interval_override_ms(ms): - return False - rst = integer_to_bytearray(reset) - mis = integer_to_bytearray(ms) - payload = rst + mis - - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_RO_PUMP_PUBLISH_INTERVAL_OVERRIDE_REQUEST.value, - payload=payload) - - self.logger.debug("override FP pump broadcast interval") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - # self.logger.debug(received_message) - if reset == RESET: - str_res = "reset back to normal" - else: - str_res = str(mis) - - self.logger.debug("broadcast overridden to " + str_res) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_ro_pump_target_pressure_override(self, pressure: float, reset: int = NO_RESET) -> int: """ Constructs and sends the target pressure override for the RO pump. This will drive @@ -146,29 +127,17 @@ prs = float_to_bytearray(pressure) payload = rst + prs - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_RO_PUMP_TARGET_PRESSURE_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_RO_PUMP_TARGET_PRESSURE_OVERRIDE_REQUEST, + entity_name = f'FP P12 RO Pump target pressure', + override_text = f'{str(pressure)} psi', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override RO pump target pressure") - # 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(pressure) - - self.logger.debug("RO target pressure overridden to " + str_res) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_ro_pump_target_flow_override(self, flow: int, reset: int = NO_RESET) -> int: """ Constructs and sends the target flow override for the RO pump. This will drive @@ -184,29 +153,17 @@ flw = integer_to_bytearray(flow) payload = rst + flw - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_RO_PUMP_TARGET_FLOW_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_RO_PUMP_TARGET_FLOW_OVERRIDE_REQUEST, + entity_name = f'FP P12 RO Pump target flow', + override_text = f'{str(flow)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override RO pump target flow") - # 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(flow) - - self.logger.debug("RO target flow overridden to " + str_res) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_ro_pump_target_pwm_override(self, duty_cycle: float, reset: int = NO_RESET) -> int: """ Constructs and sends the target duty cycle override for the RO pump. This will drive @@ -222,29 +179,17 @@ pwm = float_to_bytearray(duty_cycle) payload = rst + pwm - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_RO_PUMP_TARGET_PWM_OVERRIDE_REQUEST.value, - payload=payload) + return cmd_generic_override( + payload = payload, + reset = reset, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_RO_PUMP_TARGET_PWM_OVERRIDE_REQUEST, + entity_name = f'FP P12 RO Pump target PWM', + override_text = f'{str(duty_cycle)}', + logger = self.logger, + can_interface = self.can_interface) - self.logger.debug("override RO pump target pwm") - # 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(duty_cycle) - - self.logger.debug("RO target pwm overridden to " + str_res) - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False - def cmd_ro_pump_set_hard_stop(self) -> int: """ Constructs and sends the hard stop for the RO pump. This will stop @@ -254,20 +199,12 @@ @return: 1 if successful, zero otherwise """ - - message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_fp_ch_id, - message_id=MsgIds.MSG_ID_FP_RO_PUMP_STOP_REQUEST.value) - - self.logger.debug("hard stopping RO pump") - - # Send message - received_message = self.can_interface.send(message) - - # If there is content... - if received_message is not None: - self.logger.debug(" RO pump stopped ") - # response payload is OK or not OK - return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX] - else: - self.logger.debug("Timeout!!!!") - return False + return cmd_generic_override( + payload = None, + reset = NO_RESET, + channel_id = CanChannels.dialin_to_fp_ch_id, + msg_id = MsgIds.MSG_ID_FP_RO_PUMP_STOP_REQUEST, + entity_name = f'FP P12 RO Pump hard stop', + override_text = f'Active', + logger = self.logger, + can_interface = self.can_interface)