/**************************************************************************
*
* Copyright (c) 2019-2020 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 DrainPump.h
*
* @author (last) Quang Nguyen
* @date (last) 25-Aug-2020
*
* @author (original) Sean
* @date (original) 08-Apr-2020
*
***************************************************************************/

#ifndef __DRAIN_PUMP_H__
#define __DRAIN_PUMP_H__

#include "DGCommon.h"

/**
 *  @defgroup DrainPump DrainPump
 *  @brief Drain Pump monitor/controller module. Controls and monitors the drain pump.
 *  Drain pump manufacturer: Diener, PN: 01006-PM-0 Rev A.
 *  The pump shall produce flow rates of 100-2000 ml/min at 1 bar differential pressure.
 *  The motor used shall be either Diener part number MA0250 or MA0297.
 *
 *  @addtogroup DrainPump
 *  @{
 */

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

#define MIN_DRAIN_PUMP_RPM       300     ///< Minimum RPM target for drain pump (though zero is allowed if turning pump off).
#define MAX_DRAIN_PUMP_RPM       3000    ///< Maximum RPM target for drain pump.

/// Drain pump data publish
typedef struct
{
    U32 rpmSetPoint;            ///< Drain pump speed set point (for open loop)
    U32 pumpDACSet;             ///< Drain pump DAC set value
    U32 drainPumpState;         ///< Drain pump state machine state
    U32 drainPumpRPM;           ///< Drain pump current RPM
    F32 trgtOutletPrsr;         ///< Drain pump target outlet pressure
} DRAIN_PUMP_DATA_T;

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

void initDrainPump( void );
void execDrainPumpMonitor( void );
void execDrainPumpController( void );

SELF_TEST_STATUS_T execDrainPumpSelfTest( void );

BOOL setDrainPumpTargetRPM( U32 rpm );
BOOL setDrainPumpTargetRPMDelayed( U32 rpm, U32 delayMs );

BOOL setDrainPumpTargetOutletPressure( F32 pressure );
BOOL setDrainPumpTargetOutletPressureDelayed( F32 pressure, U32 delayMs );

void signalDrainPumpHardStop( void );

U32 getDrainPumpTargetRPM( void );
U32 getDrainPumpMeasuredRPM( void );
F32 getDrainPumpTargetOutletPressure( void );

BOOL isDrainPumpOn( void );

F32 getFlushLineVolume( void );

BOOL testSetDrainPumpDataPublishIntervalOverride( U32 value );
BOOL testResetDrainPumpDataPublishIntervalOverride( void );

BOOL testSetTargetDrainPumpRPM( U32 value );

BOOL testSetTargetDrainPumpOutletPressure( F32 value );

BOOL testSetDrainPumpMeasuredRPMOverride( U32 value );
BOOL testResetDrainPumpMeasuredRPMOverride( void );

/**@}*/

#endif