###########################################################################
#
# 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)      07-Jan-2026
# @author  (original)  Micahel Garthwaite
# @date    (original)  29-Oct-2020
#
############################################################################

import struct
from logging import Logger

from leahi_dialin.common.constants import NO_RESET
from leahi_dialin.common.msg_defs import MsgIds, MsgFieldPositions
from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override
from leahi_dialin.protocols.CAN import DenaliChannels
from leahi_dialin.utils.base import AbstractSubSystem, publish


class DDUltrafiltration(AbstractSubSystem):
    """
    Ultrafiltration

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

    def __init__(self, can_interface, 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:
            channel_id = DenaliChannels.dd_sync_broadcast_ch_id
            self.msg_id_dd_uf_data = MsgIds.MSG_ID_DD_UF_DATA.value
            self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_dd_uf_data,
                                                                       self._handler_ultrafiltration_sync)

        self.uf_exec_state = 0
        self.uf_rate = 0.0
        self.compensated_uf_rate = 0.0
        self.is_uf_requested = 0
        self.uf_timestamp = 0.0


    @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
        """
        self.uf_exec_state = struct.unpack('I', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0]
        self.uf_rate = struct.unpack('f', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_2:MsgFieldPositions.END_POS_FIELD_2]))[0]
        self.compensated_uf_rate = struct.unpack('f', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_3:MsgFieldPositions.END_POS_FIELD_3]))[0]
        self.is_uf_requested = struct.unpack('I', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_4:MsgFieldPositions.END_POS_FIELD_4]))[0]

        self.uf_timestamp = timestamp


    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 = DenaliChannels.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)