###########################################################################
#
# Copyright (c) 2021-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    temperature_sensors.py
#
# @author  (last)      Zoltan Miskolci
# @date    (last)      05-May-2026
# @author  (original)  Dara Navaei
# @date    (original)  01-Dec-2021
#
############################################################################

# Module imports
from logging import Logger

# Project imports
from leahi_dialin.common.constants import NO_RESET
from leahi_dialin.common import fp_enum_repository
from leahi_dialin.common.fp_defs import BETA_IOFP_COND_SENSOR_OFFSET, BETA_IOFP_PRES_SENSOR_OFFSET
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, float_to_bytearray


class FPTemperatureSensors(AbstractSubSystem):

    def __init__(self, can_interface: DenaliCanMessenger, logger: Logger):
        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.fp_sync_broadcast_ch_id,
                                                                       message_id = MsgIds.MSG_ID_FP_TEMPERATURE_DATA.value,
                                                                       function = self._handler_temperature_sensors_sync)

        self.fp_temperature_sensors_timestamp = 0               #: The timestamp of the last message
        
        # The Temperature data in dictionary format
        self.fp_temperatures = {
            fp_enum_repository.FPTemperatureSensorNames.M3_TEMP.name: 0.0,
            fp_enum_repository.FPTemperatureSensorNames.P8_TEMP.name: 0.0,
            fp_enum_repository.FPTemperatureSensorNames.P13_TEMP.name: 0.0,
            fp_enum_repository.FPTemperatureSensorNames.P17_TEMP.name: 0.0,
            fp_enum_repository.FPTemperatureSensorNames.P46_TEMP.name: 0.0,
            fp_enum_repository.FPTemperatureSensorNames.P10_TEMP.name: 0.0,
            fp_enum_repository.FPTemperatureSensorNames.P19_TEMP.name: 0.0,
            fp_enum_repository.FPTemperatureSensorNames.P7_TEMP.name: 0.0,
            fp_enum_repository.FPTemperatureSensorNames.P16_TEMP.name: 0.0,
            fp_enum_repository.FPTemperatureSensorNames.P7_INTERNAL_TEMP.name: 0.0,
            fp_enum_repository.FPTemperatureSensorNames.P16_INTERNAL_TEMP.name: 0.0
        }


    @publish(["msg_id_fp_temperature_data", "fp_temperatures", "fp_temperatures_timestamp"])
    def _handler_temperature_sensors_sync(self, message,timestamp=0.0):
        """
        Handles published FP temperature sensors message

        @param message:  published FP temperature sensors data message
        @returns none
        """
        sensor_list =[]
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.M3_TEMP.name,           DataTypes.F32))
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.P8_TEMP.name,           DataTypes.F32))
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.P13_TEMP.name,          DataTypes.F32))
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.P17_TEMP.name,          DataTypes.F32))
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.P46_TEMP.name,          DataTypes.F32))
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.P10_TEMP.name,          DataTypes.F32))
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.P19_TEMP.name,          DataTypes.F32))
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.P7_TEMP.name,           DataTypes.F32))
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.P16_TEMP.name,          DataTypes.F32))
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.P7_INTERNAL_TEMP.name,  DataTypes.F32))
        sensor_list.append((fp_enum_repository.FPTemperatureSensorNames.P16_INTERNAL_TEMP.name, DataTypes.F32))

        self.process_into_dict(dict_to_update = self.fp_temperatures,
                               decoder_list = sensor_list,
                               message = message)
        self.fp_temperature_sensors_timestamp = timestamp


    def cmd_temperatures_data_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends broadcast time interval.
        Constraints:
            Must be logged into FP.
            Given interval must be non-zero and a multiple of the FP 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_fp_ch_id,
            msg_id = MsgIds.MSG_ID_FP_TEMPERATURE_SENSOR_PUBLISH_INTERVAL_OVERRIDE_REQUEST,
            module_name = 'FP Temperature Sensors',
            logger = self.logger,
            can_interface = self.can_interface)


    def cmd_temperatures_value_override(self, sensor_index: int, sensor_value: float, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the value override of a temperature sensor.
        Constraints:
            Must be logged into FP.
            Given sensor_index must be one of the sensors listed below.

        @param sensor_index : (int) Index of the sensor
        @param sensor_value: (float) Value of the sensor to override
        @param reset: (int) whether to reset the override value. The default is NO_RESET
        @returns 1 if successful, zero otherwise
        """
        # FP Conductivity Sensors' Temperature Override
        if fp_enum_repository.FPTemperatureSensorNames.FIRST_CONDUCTIVITY_SENSOR.value <= sensor_index <= fp_enum_repository.FPTemperatureSensorNames.LAST_CONDUCTIVITY_SENSOR.value:
            modified_index = sensor_index - fp_enum_repository.FPTemperatureSensorNames.FIRST_CONDUCTIVITY_SENSOR.value + BETA_IOFP_COND_SENSOR_OFFSET
            msg_id = MsgIds.MSG_ID_FP_CONDUCTIVITY_TEMP_OVERRIDE_REQUEST

        # FP Flow Sensors' Temperature Override
        elif fp_enum_repository.FPTemperatureSensorNames.FIRST_FLOW_SENSOR.value <= sensor_index <= fp_enum_repository.FPTemperatureSensorNames.LAST_FLOW_SENSOR.value:
            modified_index = sensor_index - fp_enum_repository.FPTemperatureSensorNames.FIRST_FLOW_SENSOR.value
            msg_id = MsgIds.MSG_ID_FP_FLOW_TEMP_OVERRIDE_REQUEST

        # FP Pressure Sensors' Temperature Override
        else:
            modified_index = sensor_index - fp_enum_repository.FPTemperatureSensorNames.FIRST_PRESSURE_SENSOR.value + BETA_IOFP_PRES_SENSOR_OFFSET
            msg_id = MsgIds.MSG_ID_FP_PRESSURE_TEMP_OVERRIDE_REQUEST
        
        index = integer_to_bytearray(modified_index)
        rst = integer_to_bytearray(reset)
        value = float_to_bytearray(sensor_value)
        payload = rst + value + index
           
        sensor_name = fp_enum_repository.FPTemperatureSensorNames(sensor_index).name.split('_')[0]
        return cmd_generic_override(
            payload = payload,
            reset = reset,
            channel_id = DenaliChannels.dialin_to_fp_ch_id,
            msg_id = msg_id,
            entity_name = f'FP {sensor_name} Temperature Sensor temperature',
            override_text = str(sensor_value),
            logger = self.logger,
            can_interface = self.can_interface)


    def cmd_temperatures_filtered_value_override(self, sensor_index: int, sensor_value: float, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the filtered value override of a temperature sensor.
        Constraints:
            Must be logged into FP.
            Given sensor_index must be one of the sensors listed below.

        @param sensor_index : (int) Index of the sensor
        @param sensor_value: (float) Value of the sensor to override
        @param reset: (int) whether to reset the override value. The default is NO_RESET
        @returns 1 if successful, zero otherwise
        """

        # FP Conductivity Sensors' Temperature Override
        if fp_enum_repository.FPTemperatureSensorNames.FIRST_CONDUCTIVITY_SENSOR.value <= sensor_index <= fp_enum_repository.FPTemperatureSensorNames.LAST_CONDUCTIVITY_SENSOR.value:
            modified_index = sensor_index - fp_enum_repository.FPTemperatureSensorNames.FIRST_CONDUCTIVITY_SENSOR.value + BETA_IOFP_COND_SENSOR_OFFSET
            msg_id = MsgIds.MSG_ID_FP_FILTERED_COND_SENSOR_TEMPERATURE_OVERRIDE_REQUEST

        # FP Flow Sensors' Temperature Override
        elif fp_enum_repository.FPTemperatureSensorNames.FIRST_FLOW_SENSOR.value <= sensor_index <= fp_enum_repository.FPTemperatureSensorNames.LAST_FLOW_SENSOR.value:
            modified_index = sensor_index - fp_enum_repository.FPTemperatureSensorNames.FIRST_FLOW_SENSOR.value
            msg_id = MsgIds.MSG_ID_FP_FILTERED_FLOW_TEMP_OVERRIDE_REQUEST

        # FP Pressure Sensors' Temperature Override
        else:
            modified_index = sensor_index - fp_enum_repository.FPTemperatureSensorNames.FIRST_PRESSURE_SENSOR.value + BETA_IOFP_PRES_SENSOR_OFFSET
            msg_id = MsgIds.MSG_ID_FP_PRESSURE_SENSOR_FILTER_TEMPERATURE_OVERRIDE_REQUEST

        index = integer_to_bytearray(modified_index)
        rst = integer_to_bytearray(reset)
        value = float_to_bytearray(sensor_value)
        payload = rst + value + index

        sensor_name = fp_enum_repository.FPTemperatureSensorNames(sensor_index).name.split('_')[0]
        return cmd_generic_override(
            payload=payload,
            reset=reset,
            channel_id=DenaliChannels.dialin_to_fp_ch_id,
            msg_id=msg_id,
            entity_name=f'FP {sensor_name} Temperature Sensor filtered temperature',
            override_text=str(sensor_value),
            logger=self.logger,
            can_interface=self.can_interface)