/**************************************************************************
*
* 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 **********

#define AIR_PUMP_MOTOR_OFF          0               ///< Power level setting (PWM) for H12 air pump to turn pump off.
#define AIR_PUMP_MOTOR_MAX_PWM      255             ///< Power level setting (PWM) maximum for H12 air pump.
#define AIR_PUMP_MOTOR_FILL_PWM     50              ///< Power level setting (PWM) for H12 air pump to fill (raise level) the air trap.
#define AIR_PUMP_MOTOR_LOWER_PWM    150             ///< Power level setting (PWM) for H12 air pump to lower the level of the air trap.

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

void initGasLiqXferPumpDriver( void );
void setAirPumpMotorPower( U08 power );
U08 getAirPumpMotorPower( void );

BOOL testSetAirPump( MESSAGE_T *message );

/**@}*/

#endif