/**************************************************************************
*
* 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    Bubble.h
*
* @author  (last)      Peman Montazemi
* @date    (last)      11-May-2021
*
* @author  (original)  Peman Montazemi
* @date    (original)  06-May-2021
*
***************************************************************************/

#ifndef __BUBBLE_H__
#define __BUBBLE_H__

#include "HDCommon.h"

/**
 *  @defgroup Bubble Bubble
 *  @brief Air bubble detectors monitor module. Monitors the
 *  bubble detector.
 *
 *  SMD - Venous Air Bubble Detector Part No. DIA8413
 *  SMD - Arterial Air Bubble Detector Part No. DIA8309
 *
 *  @addtogroup Bubble
 *  @{
 */

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

/// Enumeration of air bubble detectors status.
typedef enum BubblesStatus
{
    BUBBLE_DETECTED = 0,                    ///< Air bubble detector senses bubble
    BUBBLE_NOT_DETECTED,                    ///< Air bubble detector does not sense any bubble
    NUM_OF_BUBBLE_STATUS                    ///< Number of air bubble detector status
} BUBBLE_STATUS_T;

/// Air bubble detectors names
typedef enum bubblesNames
{
    ADA = 0,                                ///< Arterial air bubble detector
    ADV,                                    ///< Venous air bubble detector
    NUM_OF_BUBBLES                          ///< Number of air bubble detectors
} BUBBLES_T;

/// Bubble detectors data publish
typedef struct
{
    U32 statusADA;                          ///< Arterial bubble detector status
    U32 stateADA;                           ///< Arterial bubble detector state
    U32 statusADV;                          ///< Venous bubble detector status
    U32 stateADV;                           ///< Venous bubble detector state
} BUBBLES_DATA_T;

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

void initBubbles( void );
void execBubbles( void );
void selfTestBubble( BUBBLES_T );

BUBBLE_STATUS_T getBubbleStatus( BUBBLES_T bubble );
SELF_TEST_STATUS_T getBubbleSelfTestStatus( BUBBLES_T bubble );

BOOL testSetBubblesDataPublishIntervalOverride( U32 value );
BOOL testResetBubblesDataPublishIntervalOverride( void );

BOOL testSetBubbleStatusOverride( BUBBLE_STATUS_T status, BUBBLES_T bubble );
BOOL testResetBubbleStatusOverride( BUBBLES_T bubble );

/**@}*/

#endif