/**************************************************************************
*
* 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    GLXferPump.h
*
* @author  (last)      Sean
* @date    (last)      17-Sep-2024
*
* @author  (original)  Sean
* @date    (original)  17-Sep-2024
*
***************************************************************************/

#ifndef __GAS_LIQ_XFER_PUMP_H__
#define __GAS_LIQ_XFER_PUMP_H__

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

#include "TDCommon.h"

/**
 *  @defgroup GLXferPump GLXferPump
 *  @brief Gas/Liquid Transfer Pump driver unit. Provides low level functions
 *  to control a gas/liquid transfer pump.
 *
 *  @addtogroup GLXferPump
 *  @{
 */

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

/// Enumeration of air pump motor states.
typedef enum AirPumpMotorStates
{
    AIR_PUMP_MOTOR_OFF = 0,                                                                     ///< Air Pump Off.
    AIR_PUMP_MOTOR_ON,                                                                          ///< Air Pump On.
    NUM_OF_AIR_PUMP_MOTOR_STATES,                                                               ///< Number of air pump motor states.
} AIR_PUMP_MOTOR_STATE_T;

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

void initGasLiqXferPumpDriver(void);
void setAirPumpMotorState( AIR_PUMP_MOTOR_STATE_T state );
AIR_PUMP_MOTOR_STATE_T getAirPumpMotorState( void );

BOOL testSetAirPump( MESSAGE_T *message );

/**@}*/

#endif