/**************************************************************************
*
* 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 ConcentratePumps.h
*
* @author (last) Quang Nguyen
* @date (last) 30-Sep-2020
*
* @author (original) Quang Nguyen
* @date (original) 30-Sep-2020
*
***************************************************************************/

#ifndef __CONCENTRATEPUMPS_H__
#define __CONCENTRATEPUMPS_H__

#include "DGCommon.h"

/**
 *  @defgroup ConcentratePumps ConcentratePumps
 *  @brief Concentrate pumps monitor and control module. Monitors and control concentrate pump with an open loop approach.
 *
 *  @addtogroup ConcentratePumps
 *  @{
 */

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

/// Enumeration of concentrate pumps.
typedef enum ConcentratePumps
{
    CONCENTRATEPUMPS_CP1 = 0,       ///< Acid concentrate pump
    CONCENTRATEPUMPS_CP2,           ///< Bicarbonate concentrate pump
    NUM_OF_CONCENTRATE_PUMPS        ///< Number of concentrate pumps
} CONCENTRATE_PUMPS_T;

/// Concentrate pump data struct.
typedef struct
{
    F32 cp1TargetSpeed;              ///< Concentrate pump CP1 target speed
    F32 cp1MeasuredSpeed;            ///< Concentrate pump CP1 measured speed
    F32 cp2TargetSpeed;              ///< Concentrate pump CP2 target speed
    F32 cp2MeasuredSpeed;            ///< Concentrate pump CP2 measured speed
} CONCENTRATE_PUMP_DATA_T;

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

void initConcentratePump( void );
void execConcentratePumpMonitor( void );
void execConcentratePumpController( void );

void requestConcentratePumpsOn( CONCENTRATE_PUMPS_T pumpId );
void requestConcentratePumpsOff( CONCENTRATE_PUMPS_T pumpId );

void setConcentratePumpTargetSpeed( CONCENTRATE_PUMPS_T pumpId, F32 targetSpeed_ml_min );

BOOL testSetConcentratePumpDataPublishIntervalOverride( U32 value );
BOOL testResetConcentratePumpDataPublishIntervalOverride( void );
BOOL testSetConcentratePumpTargetSpeedOverride( U32 pumpId, F32 value );
BOOL testSetConcentratePumpMeasuredSpeedOverride( U32 pumpId, F32 value );
BOOL testResetConcentratePumpMeasuredSpeedOverride( U32 pumpId );

/**@}*/

#endif