###########################################################################
#
# 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    ultrafiltration.py
#
# @author  (last)      Zoltan Miskolci
# @date    (last)      04-May-2026
# @author  (original)  Micahel Garthwaite
# @date    (original)  29-Oct-2020
#
############################################################################

# Module imports
from logging import Logger
from typing import Union

# Project imports
from leahi_dialin.common.constants import NO_RESET
from leahi_dialin.common.generic_defs import DataTypes
from leahi_dialin.common import dd_enum_repository
from leahi_dialin.common.msg_ids import MsgIds
from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override
from leahi_dialin.protocols.CAN import CanMessenger, CanChannels
from leahi_dialin.utils.abstract_classes import AbstractSubSystem
from leahi_dialin.utils.base import publish
from leahi_dialin.utils import DialinEnum


class DDUltrafiltration(AbstractSubSystem):
    """
    Ultrafiltration

    Dialysate Delivery (DD) Dialin API sub-class for post gen dialysate related commands.
    """

    def __init__(self, can_interface: CanMessenger, logger: Logger):
        """
        @param can_interface: Leahi Can Messenger object
        """
        super().__init__()

        self.can_interface = can_interface
        self.logger = logger

        if self.can_interface is not None:
            self.can_interface.register_receiving_publication_function(channel_id = CanChannels.dd_sync_broadcast_ch_id,
                                                                       message_id = MsgIds.MSG_ID_DD_UF_DATA.value,
                                                                       function = self._handler_ultrafiltration_sync)

        self.uf_timestamp = 0.0                                 #: The timestamp of the latest message
        self.uf_exec_state = 0
        self.uf_rate = 0.0
        self.compensated_uf_rate = 0.0
        self.is_uf_requested = False



# ============================================================ Properties ============================================================
    @property
    def uf_exec_state(self) -> int:
        """
        The Ultrafiltration execution state
        """
        return self._uf_exec_state

    @uf_exec_state.setter
    def uf_exec_state(self, value: Union[int, DialinEnum]):
        if isinstance(value, int):
            self._uf_exec_state = value
        else:
            self._uf_exec_state = value


    @property
    def uf_rate(self) -> float:
        """
        The Ultrafiltration rate
        """
        return self._uf_rate

    @uf_rate.setter
    def uf_rate(self, value: float):
        self._uf_rate = value


    @property
    def compensated_uf_rate(self) -> float:
        """
        The Compensated Ultrafiltration rate
        """
        return self._compensated_uf_rate

    @compensated_uf_rate.setter
    def compensated_uf_rate(self, value: float):
        self._compensated_uf_rate = value


    @property
    def is_uf_requested(self) -> bool:
        """
         Is Ultrafiltration requested or not
        """
        return self._is_uf_requested

    @is_uf_requested.setter
    def is_uf_requested(self, value: bool):
        self._is_uf_requested = value



# ============================================================ Handlers ============================================================
    @publish(["msg_id_dd_uf_data", "uf_exec_state","uf_rate",
              "compensated_uf_rate", "is_uf_requested",
              "uf_timestamp"])
    def _handler_ultrafiltration_sync(self, message, timestamp=0.0):
        """
        Handles published ultrafiltration data messages.

        @param message: published ultrafiltration data message
        @return: None
        """
        msg_list =[]
        # msg_list.append((type(self).uf_exec_state,          DataTypes.U32))
        msg_list.append((type(self).uf_rate,                DataTypes.F32))
        msg_list.append((type(self).compensated_uf_rate,    DataTypes.F32))
        msg_list.append((type(self).is_uf_requested,        DataTypes.BOOL))

        self.process_into_vars(decoder_list = msg_list, message = message)
        self.uf_timestamp = timestamp



# ============================================================ Overrides and Requests ============================================================
    def cmd_uf_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the broadcast time interval override for ultrafiltration data.
        Constraints:
            Must be logged into DD.
            Given interval must be non-zero and a multiple of the DD general task interval (50 ms).

        @param ms: (int) Publish time interval in ms
        @param reset: (int) 1 to reset a previous override, 0 to override
        @returns 1 if successful, zero otherwise
        """
        return cmd_generic_broadcast_interval_override(
            ms = ms,
            reset = reset,
            channel_id = CanChannels.dialin_to_dd_ch_id,
            msg_id = MsgIds.MSG_ID_DD_UF_DATA_PUBLISH_OVERRIDE_REQUEST,
            module_name = 'DD Ultrafiltration',
            logger = self.logger,
            can_interface = self.can_interface)