/**************************************************************************
*
* 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)      Sean Nash
* @date    (last)      09-Nov-2024
*
* @author  (original)  Sean Nash
* @date    (original)  09-Nov-2024
*
***************************************************************************/

#ifndef __TEMPERATURE_SENSORS_H__
#define __TEMPERATURE_SENSORS_H__

#include "ROCommon.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
{
    P23_TEMP = 0,                                               ///< Tank temperature sensor at hottest point.
    TEMP_SENSOR_FIRST = P23_TEMP,                               ///< First temp sensor.
    P22_TEMP,                                                   ///< Pre-tank temperature sensor at coldest point.
    P10_TEMP,                                                   ///< Inlet conductivity sensor temperature.
    P19_TEMP,                                                   ///< Outlet conductivity sensor temperature.
    NUM_OF_TEMPERATURE_SENSORS                                  ///< Number of temperature sensors
} TEMPERATURE_SENSOR_T;

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

void initTemperatureSensors( void );

void readTemperatureSensors( void );
void monitorTemperatureSenors( void );

F32 getTemperatureValue( TEMPERATURE_SENSOR_T sensorIndex );
//U32 getTemperatureSensorsReadCount( void );
//
BOOL testMeasuredTemperatureOverride( MESSAGE_T *message );
//BOOL testTemperatureReadCounterOverride( MESSAGE_T *message );

/**@}*/

#endif