/**************************************************************************
*
* Copyright (c) 2020-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    ConcentratePumps.h
*
* @author  (last)      Vinayakam Mani
* @date    (last)      19-Sep-2024
*
* @author  (original)  Vinayakam Mani
* @date    (original)  19-Sep-2024
*
***************************************************************************/

#ifndef __CONCENTRATE_PUMPS_H__
#define __CONCENTRATE_PUMPS_H__

#include "DDCommon.h"
//#include "NVDataMgmt.h"

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

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

#define CONCENTRATE_PUMP_MAX_SPEED              48.0F           ///< Maximum speed for concentrate pump in mL/min

#define PARK_CONC_PUMPS                         TRUE            ///< For park parameter to requestConcentratePumpOff().
#define NO_PARK_CONC_PUMPS                      FALSE           ///< For park parameter to requestConcentratePumpOff().

/// Enumeration of concentrate pumps.
typedef enum ConcentratePumps
{
    CONCENTRATEPUMPS_CP1_ACID = 0,                              ///< Acid concentrate pump
    CONCENTRATEPUMPS_FIRST = CONCENTRATEPUMPS_CP1_ACID,         ///< First concentrate pump in list
    CONCENTRATEPUMPS_CP2_BICARB,                                ///< Bicarbonate concentrate pump
    NUM_OF_CONCENTRATE_PUMPS                                    ///< Number of concentrate pumps
} CONCENTRATE_PUMPS_T;

/// Concentrate pump data struct.
typedef struct
{
    F32 cp1CurrentSetSpeed;                                     ///< Concentrate pump CP1 current set speed
    F32 cp1MeasuredSpeed;                                       ///< Concentrate pump CP1 measured speed
    F32 cp2CurrentSetSpeed;                                     ///< Concentrate pump CP2 current set speed
    F32 cp2MeasuredSpeed;                                       ///< Concentrate pump CP2 measured speed
    U32 cp1TargetRevCount;                                      ///< Concentrate pump CP1 target revolution count
    U32 cp1MeasuredRevCount;                                    ///< Concentrate pump CP1 measured revolution count
    U32 cp2TargetRevCount;                                      ///< Concentrate pump CP1 target revolution count
    U32 cp2MeasuredRevCount;                                    ///< Concentrate pump CP1 measured revolution count
    U32 cp1State;                                               ///< Concentrate pump CP1 current state
    U32 cp2State;                                               ///< Concentrate pump CP2 current state
    F32 cp1PulseUS;                                             ///< Concentrate pump CP1 pulse in microseconds
    F32 cp2PulseUS;                                             ///< Concentrate pump CP2 pulse in microseconds
    F32 cp1TargetSpeed;                                         ///< Concentrate pump CP1 target speed
    F32 cp2TargetSpeed;                                         ///< Concentrate pump CP2 target speed
    BOOL cp1Parked;                                             ///< Concentrate pump CP1 parked status
    BOOL cp2Parked;                                             ///< Concentrate pump CP2 parked status
    BOOL cp1ParkFault;                                          ///< Concentrate pump CP1 park fault status
    BOOL cp2ParkFault;                                          ///< Concentrate pump CP2 park fault status
} CONCENTRATE_PUMP_DATA_T;

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

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

SELF_TEST_STATUS_T execConcenratePumpsSelfTest( void );

void requestConcentratePumpOn( CONCENTRATE_PUMPS_T pumpId );
void requestConcentratePumpOff( CONCENTRATE_PUMPS_T pumpId, BOOL park );

void setConcentratePumpTargetSpeed( CONCENTRATE_PUMPS_T pumpId, F32 targetSpeed_ml_min, F32 targetVolume_ml );
F32  getConcentratePumpTargetFlowMLPM( CONCENTRATE_PUMPS_T pumpId );
F32  getMeasuredPumpSpeedMLPM( CONCENTRATE_PUMPS_T pumpId );
F32  getPumpTargetSpeed( CONCENTRATE_PUMPS_T pumpId );
BOOL getConcPumpParkRequest( CONCENTRATE_PUMPS_T pumpId );
BOOL getConcPumpIsParked( CONCENTRATE_PUMPS_T pumpId );
BOOL getConcPumpParkIsFaulted( CONCENTRATE_PUMPS_T pumpId );
U16 getConcPumpTargetRevolutionCount( CONCENTRATE_PUMPS_T pumpId );
BOOL handleConcentratePumpParkRequest( void );
BOOL isConcPumpParkInProgress( CONCENTRATE_PUMPS_T pumpId );

BOOL testConcentratePumpDataPublishIntervalOverride( MESSAGE_T *message );
BOOL testConcentratePumpTargetSpeedOverride( MESSAGE_T *message );
BOOL testConcentratePumpMeasuredSpeedOverride( MESSAGE_T *message );
BOOL testConcentratePumpParkedOverride( MESSAGE_T *message );
BOOL testConcentratePumpParkCmdFaultedOverride( MESSAGE_T *message );
BOOL testConcentratePumpTargetRevCountOverride( MESSAGE_T *message );

BOOL testConcentratePumpStartStopOverride( MESSAGE_T *message );      // Concentrate pump start/stop request
BOOL testConcentratePumpParkRequestOverride( MESSAGE_T *message );    // Concentrate pump stop/park request

/**@}*/

#endif