###########################################################################
#
# 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    water_pumps.py
#
# @author  (last)      Zoltan Miskolci
# @date    (last)      09-Jan-2026
# @author  (original)  Peter Lucia
# @date    (original)  02-Apr-2020
#
############################################################################

from logging import Logger

from leahi_dialin.common.constants import NO_RESET
from leahi_dialin.common.fp_defs import FPPumpNames
from leahi_dialin.common.msg_defs import MsgIds
from leahi_dialin.common.override_templates import cmd_generic_override
from leahi_dialin.protocols.CAN import DenaliChannels
from leahi_dialin.utils.base import AbstractSubSystem
from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray


class FPPumps(AbstractSubSystem):
    """
        Dialin API sub-class for FP water pump driver related commands.
    """

    def __init__(self, can_interface, logger: Logger):
        """
        FPPumps constructor
        """
        super().__init__()
        self.can_interface = can_interface
        self.logger = logger

        # no current registered call back methods


    def cmd_pump_set_speed_rate_override(self, pump: int, rpm: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the boost pump set speed rate command
        Constraints:
            Must be logged into FP.

        @param rpm:  integer - speed set point (in rpm)
        @return: 1 if successful, zero otherwise
        """
        rst = integer_to_bytearray(reset)
        rpm = integer_to_bytearray(rpm)
        pmp = integer_to_bytearray(pump)
        payload = rst + rpm + pmp

        pump_name = FPPumpNames(pump).name
        return cmd_generic_override(
            payload = payload,
            reset = reset,
            channel_id = DenaliChannels.dialin_to_fp_ch_id,
            msg_id = MsgIds.MSG_ID_FP_FLUID_PUMP_SPEED_OVERRIDE_REQUEST,
            entity_name = f'FP {pump_name} Water Pump speed',
            override_text = str(rpm),
            logger = self.logger,
            can_interface = self.can_interface)


    def cmd_pump_set_pwm_request(self, pump: int, pwm: int) -> int:
        """
        Constructs and sends set pwm request for FP pumps \n
        command.
        Constraints:
            Must be logged into FP.

        @param pump: integer - the pump id to set pwm
        @param pwm:  integer - counts to override the pwm ( 0 - 500 )
        @return: 1 if successful, zero otherwise
        """
        spd = integer_to_bytearray(pwm)
        pmp = integer_to_bytearray(pump)
        payload = pmp + spd

        pump_name = FPPumpNames(pump).name
        return cmd_generic_override(
            payload = payload,
            reset = NO_RESET,
            channel_id = DenaliChannels.dialin_to_fp_ch_id,
            msg_id = MsgIds.MSG_ID_FP_FLUID_PUMP_SET_PWM_REQUEST,
            entity_name = f'FP {pump_name} Water Pump PWM',
            override_text = str(pwm),
            logger = self.logger,
            can_interface = self.can_interface)


    def cmd_pump_read_pwm_override(self, pump: int, pwm: float, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the read pwm override for the FP pumps \n
        command.
        Constraints:
            Must be logged into FP.

        @param pwm:  float - pwm in percentage to override with
        @param reset:  integer - 1 to reset a previous override, 0 to override
        @return: 1 if successful, zero otherwise
        """
        rst = integer_to_bytearray(reset)
        rpwm = float_to_bytearray(pwm)
        pmp = integer_to_bytearray(pump)
        payload = rst + rpwm + pmp

        pump_name = FPPumpNames(pump).name
        return cmd_generic_override(
            payload = payload,
            reset = reset,
            channel_id = DenaliChannels.dialin_to_fp_ch_id,
            msg_id = MsgIds.MSG_ID_FP_FLUID_PUMP_SET_PWM_REQUEST,
            entity_name = f'FP {pump_name} Water Pump read PWM',
            override_text = str(pwm),
            logger = self.logger,
            can_interface = self.can_interface)