/**************************************************************************
*
* 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    LevelSensors.h
*
* @author  (last)      Sean
* @date    (last)      03-Oct-2024
*
* @author  (original)  Sean
* @date    (original)  03-Oct-2024
*
***************************************************************************/

#ifndef __LEVEL_SENSORS_H__
#define __LEVEL_SENSORS_H__

#include "TDCommon.h"

/**
 *  @defgroup LevelSensors LevelSensors
 *  @brief The Level sensors unit provides low-level functions to monitor a
 *  high and low level sensor for an air trap.
 *
 *  @addtogroup LevelSensors
 *  @{
 */

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

/// Enumeration of air trap level sensors monitored by this module.
typedef enum AirTrapLevelSensors
{
    H17_LEVL = 0,                           ///< Lower air trap sensor
    AIR_TRAP_LEVEL_FIRST = H17_LEVL,        ///< First air trap level sensor
    H16_LEVL,                               ///< Upper air trap sensor
    NUM_OF_AIR_TRAP_LEVEL_SENSORS           ///< Number of air trap sensors
} AIR_TRAP_LEVEL_SENSORS_T;

/// Enumeration of air trap level sensor levels.
typedef enum AirTrapLevelSensorLevels
{
    AIR_TRAP_LEVEL_AIR = 0,                 ///< Air trap level sensor detects air
    AIR_TRAP_LEVEL_FLUID,                   ///< Air trap level sensor detects fluid
    NUM_OF_AIR_TRAP_LEVELS                  ///< Number of air trap level sensor levels
} AIR_TRAP_LEVELS_T;

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

void initLevelSensors( void );
void readLevelSensors( void );
AIR_TRAP_LEVELS_T getLevelSensorState( AIR_TRAP_LEVEL_SENSORS_T sensor );
AIR_TRAP_LEVELS_T getRawLevelSensorState( AIR_TRAP_LEVEL_SENSORS_T sensor );

BOOL testRawLevelSensorOverride( MESSAGE_T *message );
BOOL testLevelSensorOverride( MESSAGE_T *message );

/**@}*/

#endif