Index: leahi_dialin/fp/modules/ro_pump.py =================================================================== diff -u -rec8a2600b9e8cf6fe7e02c200a1c24221ca86863 -ra291930ba38e329e2b373f6d2b2a7564a6b7a09a --- leahi_dialin/fp/modules/ro_pump.py (.../ro_pump.py) (revision ec8a2600b9e8cf6fe7e02c200a1c24221ca86863) +++ leahi_dialin/fp/modules/ro_pump.py (.../ro_pump.py) (revision a291930ba38e329e2b373f6d2b2a7564a6b7a09a) @@ -7,26 +7,25 @@ # # @file ro_pump.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 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.common.constants import NO_RESET from leahi_dialin.common.fp_defs import ROPumpNames, FPPumpAttributes -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.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 FPROPump(AbstractSubSystem): """ Dialin API sub-class for FP RO pump controller related commands. @@ -62,6 +61,7 @@ self.ro_pump_timestamp = 0.0 + @publish(["msg_id_fp_ro_pump_data", "ro_pump", "ro_pump_timestamp" ]) def _handler_pump_sync(self, message, timestamp=0.0): """ @@ -71,7 +71,6 @@ @param message: published FP ro pump data message @return: none """ - self.ro_pump[ROPumpNames.P12_PUMP.name][FPPumpAttributes.STATE.name] = struct.unpack('i', bytearray( message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0] self.ro_pump[ROPumpNames.P12_PUMP.name][FPPumpAttributes.DUTY_CYCLE.name] = struct.unpack('i', bytearray( @@ -93,6 +92,7 @@ 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 @@ -104,38 +104,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_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 @@ -151,29 +129,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 = DenaliChannels.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 @@ -189,29 +155,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 = DenaliChannels.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 @@ -227,29 +181,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 = DenaliChannels.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 @@ -259,20 +201,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 = DenaliChannels.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)