/**************************************************************************
*
* 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 Reservoirs.h
*
* @author (last) Quang Nguyen
* @date (last) 25-Aug-2020
*
* @author (original) Sean
* @date (original) 18-Mar-2020
*
***************************************************************************/

#ifndef __RESERVOIRS_H__
#define __RESERVOIRS_H__

#include "DGCommon.h"

/**
 *  @defgroup Reservoirs Reservoirs
 *  @brief Reservoirs service module. Maintains reservoir set points and handles reservoir related commands from the HD.
 *
 *  @addtogroup Reservoirs
 *  @{
 */

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

/// Enumeration of reservoirs.
typedef enum Reservoirs
{
    RESERVOIR_1 = 0,        ///< Reservoir number 1
    RESERVOIR_2,            ///< Reservoir number 2
    NUM_OF_RESERVOIRS       ///< Number of reservoirs
} RESERVOIR_ID_T;

#pragma pack(push,1)
/// Enumeration of drain command.
typedef struct
{
    U32 targetVolume;       ///< Target volume to drain to (in mL)
    BOOL tareLoadCell;      ///< Flag to tare load call
} DRAIN_CMD_T;
#pragma pack(pop)

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

void initReservoirs( void );
void execReservoirs( void );

BOOL setActiveReservoirCmd( RESERVOIR_ID_T resID );    // handle switch reservoirs command from HD
BOOL startFillCmd( U32 fillToVolMl );                  // handle fill command from HD
BOOL stopFillCmd( void );                              // handle stop fill command from HD
BOOL startDrainCmd( DRAIN_CMD_T drainCmd );            // handle drain command from HD
BOOL stopDrainCmd( void );                             // handle stop drain command from HD
BOOL startTrimmerHeaterCmd( void );                    // handle start trimmer heater control command from HD
BOOL stopTrimmerHeaterCmd( void );                     // handle stop trimmer heater control command from HD

RESERVOIR_ID_T getInactiveReservoir( void );
BOOL hasTargetFillVolumeReached( RESERVOIR_ID_T reservoirId );
BOOL hasTargetDrainVolumeReached( RESERVOIR_ID_T reservoirId , U32 timeout );

void resetReservoirLoadCellsOffset( RESERVOIR_ID_T reservoirId );

BOOL testSetDGActiveReservoirOverride( RESERVOIR_ID_T value );
BOOL testResetDGActiveReservoirOverride( void );
BOOL testSetReservoirFillVolumeMlOverride( U32 value );
BOOL testResetReservoirFillVolumeMlOverride( void );
BOOL testSetReservoirDrainVolumeMlOverride( U32 value );
BOOL testResetReservoirDrainVolumeMlOverride( void );

/**@}*/

#endif