###########################################################################
#
# Copyright (c) 2025-2026 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    drybicart.py
#
# @author  (last)      Zoltan Miskolci
# @date    (last)      04-May-2026
# @author  (original)  Sameer Poyil
# @date    (original)  19-Nov-2025
#
############################################################################

# Module imports
from logging import Logger

# Project imports
from leahi_dialin.common.constants import NO_RESET , RESET
from leahi_dialin.common.generic_defs import DataTypes
from leahi_dialin.common.msg_defs import MsgIds
from leahi_dialin.common.override_templates import cmd_generic_broadcast_interval_override, cmd_generic_override
from leahi_dialin.protocols.CAN import DenaliCanMessenger, DenaliChannels
from leahi_dialin.utils.abstract_classes import AbstractSubSystem
from leahi_dialin.utils.base import publish
from leahi_dialin.utils.conversions import integer_to_bytearray


class DDDryBicart(AbstractSubSystem):
    """
    DryBicart

    Dialysate Delivery (DD) Dialin API sub-class for Dry Bicart related commands.
    """

    def __init__(self, can_interface: DenaliCanMessenger, 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:
            self.can_interface.register_receiving_publication_function(channel_id = DenaliChannels.dd_sync_broadcast_ch_id,
                                                                       message_id = MsgIds.MSG_ID_DD_DRY_BICART_DATA.value,
                                                                       function = self._handler_dry_bicart_sync)

        self.dd_dry_bicart_timestamp = 0                        #: The timestamp of the last message
        self.dd_dry_bicart_fill_execution_state = 0             #: The Dry Bicart fill execution state
        self.dd_bicarb_chamber_fill_execution_state = 0         #: The Bicarb chamber fill execution state
        self.dd_dry_bicart_drain_execution_state = 0            #: The Dry Bicart drain execution state
        self.dd_dry_bicart_fill_cycle_counter = 0               #: The Dry Bicart fill cycle counter
        self.dd_dry_bicart_max_fill_cycle_count = 0             #: The Dry Bicart max fill cycle state
        self.dd_dry_bicart_fill_request = 0                     #: Is fill requested for Dry Bicart or not
        self.dd_bicarb_chamber_fill_request = 0                 #: Is fill requested for Bicarb Chamber or not
        self.dd_dry_bicart_drain_request = 0                    #: Is drain requested for Dry Bicart or not
        self.dd_dry_bicart_last_fill_time = 0                   #: The Dry Bicart last fill time
        self.dd_dry_bicart_current_fill_time = 0                #: The Dry Bicart current fill time
        self.dd_dryBiCartType = 0                               #: The Dry Bicart concentrate option index
        self.dd_dryBiCartDrainTimePeriod = 0                    #: The Dry Bicart drain time period in sec


    @publish(["msg_id_dd_dry_bicart_data",
              "dd_dry_bicart_fill_execution_state", "dd_bicarb_chamber_fill_execution_state", "dd_dry_bicart_drain_execution_state",
              "dd_dry_bicart_fill_cycle_counter", "dd_dry_bicart_max_fill_cycle_count",
              "dd_dry_bicart_fill_request", "dry_bicarb_chamber_fill_request", "dd_dry_bicart_drain_request",
              "dd_dry_bicart_last_fill_time", "dd_dry_bicart_current_fill_time", "dd_dryBiCartType", "dd_dryBiCartDrainTimePeriod",
              "dd_dry_bicart_timestamp"])
    def _handler_dry_bicart_sync(self, message, timestamp=0.0):
        """
        Handles published dry bicart data messages.

        @param message:  published dry bicart data message
        @return: None
        """
        msg_list = []
        msg_list.append(('self.dd_dry_bicart_fill_execution_state',     DataTypes.U32))
        msg_list.append(('self.dd_bicarb_chamber_fill_execution_state', DataTypes.U32))
        msg_list.append(('self.dd_dry_bicart_drain_execution_state',    DataTypes.F32))
        msg_list.append(('self.dd_dry_bicart_fill_cycle_counter',       DataTypes.U32))
        msg_list.append(('self.dd_dry_bicart_max_fill_cycle_count',     DataTypes.U32))
        msg_list.append(('self.dd_dry_bicart_fill_request',             DataTypes.U32))
        msg_list.append(('self.dd_bicarb_chamber_fill_request',         DataTypes.U32))
        msg_list.append(('self.dd_dry_bicart_drain_request',            DataTypes.U32))
        msg_list.append(('self.dd_dry_bicart_last_fill_time',           DataTypes.U32))
        msg_list.append(('self.dd_dry_bicart_current_fill_time',        DataTypes.U32))
        msg_list.append(('self.dd_dryBiCartType',                       DataTypes.U32))
        msg_list.append(('self.dd_dryBiCartDrainTimePeriod',            DataTypes.U32))
        
        self.process_into_vars(decoder_list = msg_list,
                               message = message)
        self.dd_dry_bicart_timestamp = timestamp


    def cmd_dry_bicart_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the dry bicart data broadcast interval override command
        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:  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
        """
        return cmd_generic_broadcast_interval_override(
            ms=ms,
            reset=reset,
            channel_id=DenaliChannels.dialin_to_dd_ch_id,
            msg_id=MsgIds.MSG_ID_DD_DRY_BICART_DATA_PUBLISH_INTERVAL_OVERRIDE_REQUEST,
            module_name='DD Dry Bicart',
            logger=self.logger,
            can_interface=self.can_interface)


    def cmd_bicart_max_fill_cycle_count_override(self, count: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the dry bicart max cycle count override command
        Constraints:
            Must be logged into DD.

        @param count:  int - count value to override max fill cycle count
        @param reset:  integer - 1 to reset a previous override, 0 to override
        @return: 1 if successful, zero otherwise
        """
        cycle_count = integer_to_bytearray(count)
        reset_byte_array = integer_to_bytearray(reset)
        payload = reset_byte_array + cycle_count

        return cmd_generic_override(
            payload=payload,
            reset=reset,
            channel_id=DenaliChannels.dialin_to_dd_ch_id,
            msg_id=MsgIds.MSG_ID_DD_DRY_BICART_FILL_CYCLE_MAX_OVERRIDE_REQUEST,
            entity_name='max fill cycle count',
            override_text=str(count),
            logger=self.logger,
            can_interface=self.can_interface)


    def cmd_dry_bicart_fill_request_override(self, start_stop: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the dry bicart fill request override command
        Constraints:
            Must be logged into DD.

        @param start_stop:  int - value to start or stop dry bicart fill ( start = 1, stop = 0
        @return: 1 if successful, zero otherwise
        """
        request = integer_to_bytearray(start_stop)
        reset_byte_array = integer_to_bytearray(reset)
        payload = reset_byte_array + request

        return cmd_generic_override(
            payload=payload,
            reset=reset,
            channel_id=DenaliChannels.dialin_to_dd_ch_id,
            msg_id=MsgIds.MSG_ID_DD_DRY_BICART_FILL_REQUEST_OVERRIDE_REQUEST,
            entity_name='Bicart Fill Request',
            override_text=str(start_stop),
            logger=self.logger,
            can_interface=self.can_interface)


    def cmd_dry_bicart_bicarb_chamber_fill_request_override(self, start_stop: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the dry bicart bicarbonate chamber F fill request override command
        Constraints:
            Must be logged into DD.

        @param start_stop:  int - value to start or stop dry bicart fill ( start = 1, stop = 0
        @return: 1 if successful, zero otherwise
        """
        request = integer_to_bytearray(start_stop)
        reset_byte_array = integer_to_bytearray(reset)
        payload = reset_byte_array + request

        return cmd_generic_override(
            payload=payload,
            reset=NO_RESET,
            channel_id=DenaliChannels.dialin_to_dd_ch_id,
            msg_id=MsgIds.MSG_ID_DD_BICARB_CHAMBER_FILL_REQUEST_OVERRIDE_REQUEST,
            entity_name='Bicarb Fill Request',
            override_text=str(start_stop),
            logger=self.logger,
            can_interface=self.can_interface)


    def cmd_dry_bicart_drain_request_override(self, start_stop: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the dry bicart drain request override command
        Constraints:
            Must be logged into DD.

        @param start_stop:  int - value to start or stop dry bicart drain ( start = 1, stop = 0
        @return: 1 if successful, zero otherwise
        """
        request = integer_to_bytearray(start_stop)
        reset_byte_array = integer_to_bytearray(reset)
        payload = reset_byte_array + request

        return cmd_generic_override(
            payload=payload,
            reset=reset,
            channel_id=DenaliChannels.dialin_to_dd_ch_id,
            msg_id=MsgIds.MSG_ID_DD_BICART_DRAIN_REQUEST_OVERRIDE_REQUEST,
            entity_name='Bicart Drain Request',
            override_text=str(start_stop),
            logger=self.logger,
            can_interface=self.can_interface)


    def cmd_dry_bicart_cartridge_size_override(self, small_large: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the dry bicart cartridge size override command
        Constraints:
            Must be logged into DD.

        @param small_large:  int - value for small or large dry bicart ( small = 0, large = 1
        @return: 1 if successful, zero otherwise
        """
        cartridge_size = integer_to_bytearray(small_large)
        reset_byte_array = integer_to_bytearray(reset)
        payload = reset_byte_array + cartridge_size

        return cmd_generic_override(
            payload=payload,
            reset=reset,
            channel_id=DenaliChannels.dialin_to_dd_ch_id,
            msg_id=MsgIds.MSG_ID_DD_BICART_CARTRIDGE_SELECT_OVERRIDE_REQUEST,
            entity_name='Bicart Cartridge Size',
            override_text=str(small_large),
            logger=self.logger,
            can_interface=self.can_interface)