/**********************************************************************//**
 *
 *  Copyright (c) 2019-2020 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
 *
 *  @date 7-Apr-2020
 *  @author Dara Navaei
 *
 *  @brief DG temperature sensors controller
 *
 **************************************************************************/

#ifndef __TEMPERATURESENSORS_H__
#define __TEMPERATURESENSORS_H__

#include "Common.h"

/**
 *  @defgroup TemperatureSensors TemperatureSensors
 *  @brief Temperature Sensors driver module.
 *  Reads and processes the temperature sensors.
 *
 *  @addtogroup TemperatureSensors
 *  @{
 */

/// Sensors name
typedef enum SENSORS_NAME
{
    TEMPSENSORS_INLET_PRIMARY_HEATER_TEMP_SENSOR = 0,       ///< Inlet primary heaters temperature sensor
    TEMPSENSORS_OUTLET_PRIMARY_HEATER_TEMP_SENSOR,          ///< Outlet primary heaters temperature sensor
    TEMPSENSORS_CONDUCTIVITY_SENSOR_1_TEMP_SENSOR,          ///< Conductivity sensor 1 temperature sensor
    TEMPSENSORS_CONDUCTIVITY_SENSOR_2_TEMP_SENSOR,          ///< Conductivity sensor 2 temperature sensor
    TEMPSENSORS_OUTLET_REDUNDANCY_TEMP_SENSOR,              ///< Outlet redundancy temperature sensor
    TEMPSENSORS_INLET_DIALYSATE_TEMP_SENSOR,                ///< Inlet dialysate temperature sensor
    TEMPSENSORS_PRIMARY_HEATER_THERMO_COUPLE_TEMP_SENSOR,   ///< Primary heaters internal temperature sensor
    TEMPSENSORS_TRIMMER_HEATER_THERMO_COUPLE_TEMP_SENSOR,   ///< Trimmer heater internal temperature sensor
    TEMPSENSORS_PRIMARY_HEATER_COLD_JUNCTION_TEMP_SENSOR,   ///< Primary heaters cold junction temperature sensor
    TEMPSENSORS_TRIMMER_HEATER_COLD_JUNCTION_TEMP_SENSOR,   ///< Trimmer heater cold junction temperature sensor
    TEMPSENSORS_PRIMARY_HEATER_INTERNAL_TEMP,               ///< Primary heaters internal temperature
    TEMPSENSORS_TRIMMER_HEATER_INTERNAL_TEMP,               ///< Trimmer heater internal temperature
    NUM_OF_TEMPERATURE_SENSORS                              ///< Number of temperature sensors
} TEMPERATURE_SENSORS_T;

void initTemperatureSensors ( void );

SELF_TEST_STATUS_T execTemperatureSensorsSelfTest ( void );

void execTemperatureSensors ( void );

DATA_ARRAY_GET_PROTOTYPE ( F32, getTemperatureValue, sensor );

BOOL testSetMeasuredTemperatureOverride ( U32 sensor, F32 temperature );
BOOL testResetMeasuredTemperatureOverride ( U32 sensor );

BOOL testSetTemperatureSensorsPublishIntervalOverride ( U32 value );
BOOL testResetTemperatureSensorsPublishIntervalOverride ( void );

#endif