###########################################################################
#
# Copyright (c) 2019-2021 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    fluid_leak.py
#
# @author  (last)      Quang Nguyen
# @date    (last)      07-Jul-2021
# @author  (original)  Peman Montazemi
# @date    (original)  10-Mar-2021
#
############################################################################
import struct
from logging import Logger

from .constants import RESET, NO_RESET
from ..common.msg_defs import MsgIds, MsgFieldPositions
from ..protocols.CAN import DenaliMessage, DenaliChannels
from ..utils.base import AbstractSubSystem, publish
from ..utils.checks import check_broadcast_interval_override_ms
from ..utils.conversions import integer_to_bytearray


class HDFluidLeak(AbstractSubSystem):
    """
    HDFluidLeak

    Hemodialysis Delivery (HD) Dialin API sub-class for fluid leak related commands.
    """

    # Fluid leak detector state
    FLUID_LEAK_DETECTED_STATE = 0  # Wet
    NO_FLUID_LEAK_DETECTED_STATE = 1  # Dry

    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.hd_sync_broadcast_ch_id
            msg_id = MsgIds.MSG_ID_HD_FLUID_LEAK_STATE.value
            self.can_interface.register_receiving_publication_function(channel_id, msg_id,
                                                                       self._handler_fluid_leak_sync)

        self.fluid_leak_state = self.NO_FLUID_LEAK_DETECTED_STATE

    def get_fluid_leak_state(self):
        """
        Gets the current fluid leak state

        @return: List containing fluid leak states: [detected, undetected]
        """
        return self.fluid_leak_state

    @publish(["fluid_leak_state"])
    def _handler_fluid_leak_sync(self, message):
        """
        Handles published fluid leak state messages.  Fluid leak state is captured
        for reference.

        @param message:  published fluid leak state message
        @return: None
        """

        state = struct.unpack('i', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))

        self.fluid_leak_state = state[0]

    def cmd_fluid_leak_detector_override(self, detected: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the fluid leak detector state override command
        Constraints:
            Must be logged into HD.
            Given detector must be one of the detectors listed below.

        @param detected:  unsigned int - detected (0=wet, 1=dry) to override detector with
        @param reset:  integer - 1 to reset a previous override, 0 to override
        @return: 1 if successful, zero otherwise
        """

        rst = integer_to_bytearray(reset)
        det = integer_to_bytearray(detected)
        payload = rst + det

        message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_hd_ch_id,
                                              message_id=MsgIds.MSG_ID_HD_FLUID_LEAK_STATE_OVERRIDE.value,
                                              payload=payload)

        self.logger.debug("Override fluid leak detector state value")

        # Send message
        received_message = self.can_interface.send(message)

        # If there is content...
        if received_message is not None:
            # response payload is OK or not OK
            return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX]
        else:
            self.logger.debug("Timeout!!!!")
            return False

    def cmd_fluid_leak_state_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the fluid leak state broadcast interval override command
        Constraints:
            Must be logged into HD.
            Given interval must be non-zero and a multiple of the HD priority task interval (10 ms).

        @param ms:  integer - interval (in ms) to override with
        @param reset:  integer - 1 to reset a previous override, 0 to override
        @return: 1 if successful, zero otherwise
        """

        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_hd_ch_id,
                                              message_id=MsgIds.MSG_ID_HD_FLUID_LEAK_SEND_INTERVAL_OVERRIDE.value,
                                              payload=payload)

        self.logger.debug("Override HD fluid leak state broadcast interval")

        # 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(ms) + " ms: "
            self.logger.debug("Fluid leak state broadcast interval overridden to " + str_res +
                              str(received_message['message'][DenaliMessage.PAYLOAD_START_INDEX]))
            # response payload is OK or not OK
            return received_message['message'][DenaliMessage.PAYLOAD_START_INDEX]
        else:
            self.logger.debug("Timeout!!!!")
            return False