###########################################################################
#
# 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    air_trap.py
#
# @author  (last)      Zoltan Miskolci
# @date    (last)      05-May-2026
# @author  (original)  Sean Nash
# @date    (original)  21-Sep-2020
#
############################################################################

# Module imports
from logging import Logger

# Project imports
from leahi_dialin.common.constants import NO_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.common import td_enum_repository
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.conversions import integer_to_bytearray


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

    def __init__(self, can_interface: CanMessenger, logger: Logger):
        """
        @param can_interface: 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.td_sync_broadcast_ch_id,
                                                                       message_id = MsgIds.MSG_ID_TD_BATTERY_DATA.value,
                                                                       function = self._handler_battery_sync)

        self.battery_broadcast_timestamp = 0.0                        #: The timestamp of the last message

        #: The Battery data in dictionary format
        self.battery_data = {
            td_enum_repository.TDBatteryRegisterNames.x.name: 0,
        }


    @publish(["msg_id_td_battery_data",
              "battery_data",
              "battery_broadcast_timestamp"])
    def _handler_battery_sync(self, message, timestamp=0.0):
        """
        Handles published battery data messages.
        Battery data are captured for reference.

        @param message: published data message
        @return: None
        """
        sensor_list =[]
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.REMAINING_CAPACITY.name,          DataTypes.U32))
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.BATTERY_STATUS.name,              DataTypes.U32))
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.BATTERY_CHARGE_STATUS.name,       DataTypes.U32))
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.BATTERY_I2C_STATUS.name,          DataTypes.U32))
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.FAULT_STATUS.name,                DataTypes.U32))
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.THERMISTOR_PCT.name,              DataTypes.U32))
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.BATTERY_VOLTAGE.name,             DataTypes.U32))
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.SYSTEM_VOLTAGE.name,              DataTypes.U32))
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.BATTERY_CURRENT.name,             DataTypes.U32))
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.RELATIVE_STATE_OF_CHARGE.name,    DataTypes.U32))
        sensor_list.append((td_enum_repository.TDBatteryRegisterNames.FULL_CHARGE_CAPACITY.name,        DataTypes.U32))

        self.process_into_dict(dict_to_update = self.battery_data,
                               decoder_list = sensor_list,
                               message = message)
        
        self.battery_broadcast_timestamp = timestamp


    def cmd_battery_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the battery data broadcast interval override command
        Constraints:
            Must be logged into TD.
            Given interval must be non-zero and a multiple of the TD 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 = CanChannels.dialin_to_td_ch_id,
            msg_id = MsgIds.MSG_ID_TD_BATTERY_PUBLISH_INTERVAL_OVERRIDE_REQUEST,
            module_name = 'TD Battery',
            logger = self.logger,
            can_interface = self.can_interface)


    def cmd_battery_override(self, battery_id: int, power: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the battery override command
        Constraints:
            Must be logged into TD.
            Given interval must be non-zero and a multiple of the TD general task interval (50 ms).

        @param power:  integer - power to override the level lower to it
        @param reset:  integer - 1 to reset a previous override, 0 to override
        @return: 1 if successful, zero otherwise
        """
        payload = integer_to_bytearray(reset)
        payload += integer_to_bytearray(battery_id)
        payload += integer_to_bytearray(power)

        return cmd_generic_override(
            payload = payload,
            reset = reset,
            channel_id = CanChannels.dialin_to_td_ch_id,
            msg_id = MsgIds.MSG_ID_BATTERY_REGISTERS_OVERRIDE_REQUEST,
            entity_name = f'TD Battery power',
            override_text = f'{str(power)}',
            logger = self.logger,
            can_interface = self.can_interface)