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

#ifndef __PRESSURE_SENSOR_H__
#define __PRESSURE_SENSOR_H__

#include "ROCommon.h"
#include "PressureCommon.h"

/**
 *  @defgroup PressureSensor PressureSensor
 *  @brief Pressure sensors driver module.  Reads the various RO pressure
 *  sensors raw pressure and temperature value.
 *
 *  @addtogroup PressureSensor
 *  @{
 */

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

/// Enumeration of pressure sensors monitored by this unit.
typedef enum PressureSensors
{
    M1_PRES = 0,                            ///< Water inlet pressure before regulator
    PRESSURE_SENSOR_FIRST = M1_PRES,        ///< First pressure to scan
    M3_PRES,                                ///< Water inlet pressure after regulator
    P8_PRES,                                ///< Water inlet pressure before conductivity sensor
    P13_PRES,                               ///< Pressure before RO filter
    P17_PRES,                               ///< Pressure after RO filter
    X1_PRES,                                ///< Pressure before RO pump
    NUM_OF_PRESSURE_SENSORS                 ///< Number of pressure sensors
} PRESSURE_SENSORS_T;

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

void initPressureSensor( void );
void readPressureSensors( void );
F32 getPressure( PRESSURE_SENSORS_T sensor );
F32 getPressureSensorTemperature( PRESSURE_SENSORS_T sensor );
U32 getPressureSensorReadCount( PRESSURE_SENSORS_T sensor );
U32 getPressureSensorErrorCount( PRESSURE_SENSORS_T sensor );

BOOL testPressureSensorReadingsOverride( MESSAGE_T *message );
BOOL testPressureSensorTemperatureReadingsOverride( MESSAGE_T *message );
BOOL testPressureSensorReadCounterOverride( MESSAGE_T *message );
BOOL testPressureSensorErrorCounterOverride( MESSAGE_T *message );

/**@}*/

#endif