/**************************************************************************
*
* Copyright (c) 2024-2025 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    BubbleDetector.h
*
* @author  (last)      Sean Nash
* @date    (last)      23-Jun-2025
*
* @author  (original)  Sean Nash
* @date    (original)  22-Aug-2024
*
***************************************************************************/

#ifndef __BUBBLE_DETECTOR_H__
#define __BUBBLE_DETECTOR_H__

#include "TDCommon.h"

/**
 *  @defgroup BubbleDetector BubbleDetector
 *  @brief The Bubble Detector unit provides low-level functions for interfacing
 *  with a bubble detector.
 *
 *  @addtogroup BubbleDetector
 *  @{
 */

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

/// Enumeration of bubble detector sensors.
typedef enum Bubble_Detectors
{
    H18_BBLD = 0,                                       ///< H18: Venous bubble detector.
    NUM_OF_BUBBLE_DETECTORS                             ///< Number of used internal ADC channels.
} BUBBLE_DETECTOR_T;

/// Enumeration of bubble detection states.
typedef enum Bubble_States
{
    BUBBLE_DETECTED = 0,                                ///< A bubble is detected.
    NO_BUBBLE_DETECTED,                                 ///< No bubble is detected.
    NUM_OF_BUBBLE_DETECTION_STATES                      ///< Number of bubble detection states.
} BUBBLE_STATE_T;

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

void initBubbleDetector( void );
void readBubbleDetectors( void );
BUBBLE_STATE_T getBubbleDetectedState( BUBBLE_DETECTOR_T sensor );

BOOL testBubbleDetectOverride( MESSAGE_T *message );

/**@}*/

#endif