/**************************************************************************
*
* 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)      Vinayakam Mani
* @date    (last)      04-Sep-2024
*
* @author  (original)  Vinayakam Mani
* @date    (original)  04-Sep-2024
*
***************************************************************************/

#ifndef __PRESSURE_SENSOR_H__
#define __PRESSURE_SENSOR_H__

#include "DDCommon.h"
#include "PressureCommon.h"

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

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

/// Enumeration of pressure sensors monitored by this module.
typedef enum PressureSensors
{
    D9_PRES = 0,                                ///< Hydraulics outlet pressure (PHo/Pn)
    FIRST_DD_PRESSURE_SENSOR = D9_PRES,         ///< Start of DD pressure sensor group
    D66_PRES,                                   ///< Dry Bicarb pressure (PDB/PCb)
    D51_PRES,                                   ///< Spent Dialysate pressure (PDs)
    D18_PRES,                                   ///< Fresh Dialysate pressure (PDf)
    D41_PRES,                                   ///< Transmembrane pressure (Ptm)
    LAST_DD_PRESSURE_SENSOR = D41_PRES,         ///< End of DD pressure sensor group
    M1_PRES,                                    ///< Water inlet pressure before regulator (PRi)
    FIRST_IO_PRESSURE_SENSOR = M1_PRES,         ///< Start of IO pressure sensor group
    M3_PRES,                                    ///< Water inlet pressure after regulator (PRo)
    LAST_IO_PRESSURE_SENSOR = M3_PRES,          ///< End of IO pressure sensor group
    P8_PRES,                                    ///< Water inlet pressure before conductivity sensor
    FIRST_FP_PRESSURE_SENSOR = P8_PRES,         ///< Start of FP pressure sensor group
    P13_PRES,                                   ///< Pressure before RO filter
    P17_PRES,                                   ///< Pressure after RO filter
    LAST_FP_PRESSURE_SENSOR = P17_PRES,         ///< End of FP pressure sensor group
    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 );

BOOL testDDPressureSensorReadingsOverride( MESSAGE_T *message );
BOOL testDDPressureSensorTemperatureReadingsOverride( MESSAGE_T *message );
BOOL testIOFPPressureSensorReadingsOverride( MESSAGE_T *message );
BOOL testIOFPPressureSensorTemperatureReadingsOverride( MESSAGE_T *message );

/**@}*/

#endif