###########################################################################
#
# Copyright (c) 2020-2025 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)      09-Jan-2026
# @author  (original)  Dara Navaei
# @date    (original)  09-Nov-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, cmd_generic_override
from leahi_dialin.common.td_defs import TDTemperatureSensorNames
from leahi_dialin.protocols.CAN import DenaliChannels
from leahi_dialin.utils.base import AbstractSubSystem, publish
from leahi_dialin.utils.conversions import integer_to_bytearray, float_to_bytearray


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

    def __init__(self, can_interface, logger: Logger):
        """
        TDTemperatureSensors constructor
        """
        super().__init__()
        self.can_interface = can_interface
        self.logger = logger

        if self.can_interface is not None:
            channel_id = DenaliChannels.td_sync_broadcast_ch_id
            self.msg_id_td_temperature_data = MsgIds.MSG_ID_TD_TEMPERATURE_DATA.value
            self.can_interface.register_receiving_publication_function(channel_id, self.msg_id_td_temperature_data,
                                                                       self._handler_temperature_sync)
        self.td_temperatures_status = {TDTemperatureSensorNames.H23_TEMP.name: 0.0}
        self.td_temperature_timestamp = 0.0


    @publish(["msg_id_td_temperature_data",
        "td_temperatures_status",
        "td_temperature_timestamp"
    ])
    def _handler_temperature_sync(self, message, timestamp=0.0):
        """
        Handles published temperature data messages.  Temperature data are captured
        for reference.

        @param message:  published temperature data message
        @return: none
        """
        baro = struct.unpack('f', bytearray(
            message['message'][MsgFieldPositions.START_POS_FIELD_1:MsgFieldPositions.END_POS_FIELD_1]))[0]

        self.td_temperatures_status[TDTemperatureSensorNames.H23_TEMP.name] = baro
        self.td_temperature_timestamp = timestamp


    def cmd_temperature_sensors_broadcast_interval_override(self, ms: int, reset: int = NO_RESET) -> int:
        """
        Constructs and sends the measured temperature sensors 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 = DenaliChannels.dialin_to_td_ch_id,
            msg_id = MsgIds.MSG_ID_TD_TEMPERATURE_PUBLISH_INTERVAL_OVERRIDE_REQUEST,
            module_name = 'TD Temperature Sensors',
            logger = self.logger,
            can_interface = self.can_interface)


    def cmd_temperature_sensor_override(self, sensor: int, temperature: float,  reset: int = NO_RESET) -> int:
        """
        Constructs and sends the measured temperature sensor override command
    .
        Constraints:
            Must be logged into TD.

        @param sensor: int - sensor ID
        @param temperature:  float - measured temperature in C
        @param reset:  integer - 1 to reset a previous override, 0 to override
        @return: 1 if successful, zero otherwise
        """
        rst = integer_to_bytearray(reset)
        sen = integer_to_bytearray(sensor)
        prs = float_to_bytearray(temperature)
        payload = rst + prs + sen

        sensor_name = TDTemperatureSensorNames(sensor).name.split('_')[0]
        return cmd_generic_override(
            payload = payload,
            reset = NO_RESET,
            channel_id = DenaliChannels.dialin_to_td_ch_id,
            msg_id = MsgIds.MSG_ID_TD_TEMPERATURE_OVERRIDE,
            entity_name = f'TD {sensor_name} Temperature Sensor temperature',
            override_text = f'{str(temperature)} C',
            logger = self.logger,
            can_interface = self.can_interface)