/**************************************************************************
*
* Copyright (c) 2019-2021 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 FluidLeak.h
*
* @author (last) Peman Montazemi
* @date (last) 09-Mar-2021
*
* @author (original) Peman Montazemi
* @date (original) 09-Mar-2021
*
***************************************************************************/

#ifndef __FLUID_LEAK_H__
#define __FLUID_LEAK_H__

#include "DGCommon.h"

/**
 *  @defgroup FluidLeak FluidLeak
 *  @brief Fluid Leak detector monitor module.  Monitors the
 *  fluid leak detector.
 *
 *  @addtogroup FluidLeak
 *  @{
 */

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

/// Enumeration of fluid leak detector states.
typedef enum FluidLeakDetectorStates
{
    FLUID_LEAK_STATE_WET = 0,               ///< Fluid leak detector senses fluid
    FLUID_LEAK_STATE_DRY,                   ///< Fluid leak detector does not sense any fluid
    NUM_OF_FLUID_LEAK_STATES                ///< Number of fluid leak detector states
} FLUID_LEAK_STATES_T;

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

void initFluidLeak( void );
void execFluidLeak( void );

FLUID_LEAK_STATES_T getFluidLeakState( void );

BOOL testSetFluidLeakStatePublishIntervalOverride( U32 value );
BOOL testResetFluidLeakStatePublishIntervalOverride( void );
BOOL testSetFluidLeakStateOverride( FLUID_LEAK_STATES_T state );
BOOL testResetFluidLeakStateOverride( void );

/**@}*/

#endif