###########################################################################
#
# 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    buttons.py
#
# @author  (last)      Micahel Garthwaite
# @date    (last)      05-Nov-2024
# @author  (original)  Peter Lucia
# @date    (original)  14-Oct-2024
#
############################################################################
import struct
from logging import Logger

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


class TDButtons(AbstractSubSystem):
    """
    Treatment Delivery (TD) Dialin API sub-class for button related commands.
    """

    def __init__(self, can_interface: DenaliCanMessenger, logger: Logger):
        """
        TD_Buttons constructor

        @param can_interface: the Denali CAN interface object
        """

        super().__init__()
        self.can_interface = can_interface
        self.logger = logger
        self.poweroff_timeout_expired = False

        if self.can_interface is not None:
            self.can_interface.register_receiving_publication_function(DenaliChannels.td_to_ui_ch_id,
                                                                       MsgIds.MSG_ID_OFF_BUTTON_PRESS_REQUEST.value,
                                                                       self._handler_poweroff_timeout_occurred)
        self.td_power_off_timestamp = 0.0

    def reset_poweroff_timeout_expired(self):
        """
        Resets the dialin poweroff timeout flag to False

        @return: None
        """

        self.poweroff_timeout_expired = False

    @publish(['td_power_off_timestamp', "poweroff_timeout_expired"])
    def _handler_poweroff_timeout_occurred(self, message, timestamp=0.0):
        """
        Poweroff timeout occurred handler

        @param message: The poweroff timeout occurred message string
        @return: None
        """
        if len(message["message"]) < 16:
            self.logger.debug("Poweroff message id detected, but was the wrong length.")
            return

        mode = struct.unpack('h', bytearray(
            message["message"][MsgFieldPositions.START_POS_FIELD_1: MsgFieldPositions.START_POS_FIELD_1 + 2]))

        if len(mode) > 0:
            self.poweroff_timeout_expired = bool(mode[0])
        self.td_power_off_timestamp = timestamp

    def cmd_off_button_override(self, state: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the Off button override command
        See TD/App/Controllers/Buttons.c
        Constraints:
            Must be logged into TD.
            Given state must be a 0 or 1.

        @param state:  integer - 1 to override off button to "pressed", 0 to "released"
        @param reset:  integer - 1 to reset a previous override, 0 to override
        @return: 1 if successful, zero otherwise
        """

        rst = integer_to_bytearray(reset)
        sta = integer_to_bytearray(state)
        payload = rst + sta

        message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id,
                                              message_id=MsgIds.MSG_ID_TD_OFF_BUTTON_OVERRIDE_REQUEST.value,
                                              payload=payload)

        self.logger.debug("override off button")

        # 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 = ("pressed" if state != 0 else "released")

            self.logger.debug("Off button 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

    def cmd_stop_button_override(self, state: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the Stop button override command
        See TD/App/Controllers/Buttons.c
        Constraints:
            Must be logged into TD.
            Given state must be a 0 or 1.

        @param state:  integer - 1 to override stop button to "pressed", 0 to "released"
        @param reset:  integer - 1 to reset a previous override, 0 to override
        @return: 1 if successful, zero otherwise
        """

        rst = integer_to_bytearray(reset)
        sta = integer_to_bytearray(state)
        payload = rst + sta

        message = DenaliMessage.build_message(channel_id=DenaliChannels.dialin_to_td_ch_id,
                                              message_id=MsgIds.MSG_ID_TD_STOP_BUTTON_OVERRIDE_REQUEST.value,
                                              payload=payload)

        self.logger.debug("override stop button")

        # 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 = ("pressed" if state != 0 else "released")
            self.logger.debug("Stop button 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