###########################################################################
#
# Copyright (c) 2021-2022 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    flush.py
#
# @author  (last)      Dara Navaei
# @date    (last)      31-May-2022
# @author  (original)  Dara Navaei
# @date    (original)  16-Apr-2021
#
############################################################################
import struct
from enum import unique
from logging import Logger

from ..common.msg_defs import MsgIds, MsgFieldPositions
from ..protocols.CAN import DenaliChannels
from ..utils.base import AbstractSubSystem, publish
from ..common.dg_defs import DGFlushStates, DGFlushUIStates


class FlushMode(AbstractSubSystem):
    """
        Flush Mode class with APIs to set the timing of each of the stages.
    """

    def __init__(self, can_interface, logger: Logger):
        super().__init__()

        self.can_interface = can_interface
        self.logger = logger

        self.flush_state = DGFlushStates.DG_FLUSH_STATE_START.value
        self.overall_elapsed_time = 0
        self.state_elapsed_time = 0
        self.flush_drain_line_volume_l = 0.0
        self.flush_UI_state = DGFlushUIStates.FLUSH_UI_STATE_NOT_RUNNING.value

        if self.can_interface is not None:
            channel_id = DenaliChannels.dg_sync_broadcast_ch_id
            msg_id = MsgIds.MSG_ID_DG_FLUSH_DATA.value
            self.can_interface.register_receiving_publication_function(channel_id, msg_id, self._handler_flush_sync)

    def clear_flush_info(self) -> None:
        """
        Clears public class properties that are updated by the handler.
        Specifically properties updated  by the DG broadcast message
        MSG_ID_DG_FLUSH_DATA.

        @returns : none
        """
        self.flush_state = DGFlushStates.DG_FLUSH_STATE_START.value
        self.overall_elapsed_time = 0
        self.state_elapsed_time = 0

    @publish(["flush_state", "overall_elapsed_time", "state_elapsed_time", "flush_drain_line_volume",
              "flush_UI_state"])
    def _handler_flush_sync(self, message: dict) -> None:
        """
        Handles published flush message

        @param message:  published flush data message
        @returns none
        """
        state = struct.unpack('<i', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0]
        elapsed_time = struct.unpack('<i', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0]
        state_elapsed_time = struct.unpack('<i', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0]
        drain_line_volume = struct.unpack('<f', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0]
        flush_ui_state = struct.unpack('<f', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_5:MsgFieldPositions.END_POS_FIELD_5]))[0]

        self.flush_state = state
        self.overall_elapsed_time = int(elapsed_time / 1000)
        self.state_elapsed_time = int(state_elapsed_time / 1000)
        self.flush_drain_line_volume_l = drain_line_volume
        self.flush_UI_state = flush_ui_state