/**************************************************************************
*
* Copyright (c) 2024-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    TemperatureSensors.h
*
* @author  (last)      Vinayakam Mani
* @date    (last)      24-Sep-2024
*
* @author  (original)  Vinayakam Mani
* @date    (original)  24-Sep-2024
*
***************************************************************************/

#ifndef __TEMPERATURE_SENSORS_H__
#define __TEMPERATURE_SENSORS_H__

#include "DDCommon.h"
//#include "NVDataMgmt.h"

/**
 *  @defgroup TemperatureSensors TemperatureSensors
 *  @brief Temperature Sensors driver module. Reads and processes the temperature sensors.
 *  2 wire/ 3 wire RTD : PT1000 temperature sensor interfaced to FPGA ADC.
 *
 *  @addtogroup TemperatureSensors
 *  @{
 */

// ********** public definitions **********

/// Enumeration of temperature sensors.
typedef enum SENSORS_NAME
{
    TEMPSENSORS_INLET_HEAT_EXCHANGER = 0,                       ///< First temp sensor to scan
    TEMPSENSORS_FIRST = TEMPSENSORS_INLET_HEAT_EXCHANGER,       ///< Heat exchanger Inlet temperature sensor
    TEMPSENSORS_OUTLET_HEAT_EXCHANGER,                          ///< Heat exchanger Outlet temperature sensor
    TEMPSENSORS_HYDRAULICS_PRIMARY_HEATER,                      ///< Hydraulics primary heater temperature sensor
    TEMPSENSORS_TRIMMER_HEATER,                                 ///< Trimmer heater temperature sensor
    TEMPSENSORS_BAROMETRIC_TEMP_SENSOR,                         ///< Barometric temperature sensor
    TEMPSENSORS_BOARD_TEMPERATURE,                              ///< DD board temperature sensor ( thermistor )
    NUM_OF_TEMPERATURE_SENSORS                                  ///< Number of temperature sensors
} TEMPERATURE_SENSORS_T;

// ********** public function prototypes **********

void initTemperatureSensors( void );

F32 getTemperatureValue( U32 sensorIndex );
S32 getBaroSensorTemperatureDiff( void );
void readTemperatureSensors( void );
void monitorTemperatureSenors( void );
U32 getTemperatureSensorsReadCount( void );
U32 getBaroTempSensorsReadCount( void );
void setBaroSensorCoefficientReadStartTime( void );

BOOL testMeasuredTemperatureOverride( MESSAGE_T *message );
BOOL testTemperatureReadCounterOverride( MESSAGE_T *message );
BOOL testBaroTemperatureReadCounterOverride( MESSAGE_T *message );
BOOL testBaroTemperatureCRCOverride( MESSAGE_T *message );

/**@}*/

#endif