/**************************************************************************
 *
 *  Copyright (c) 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
 *
 *  @date 18-Mar-2020
 *  @author S. Nash
 *
 *  @brief header file for Reservoirs service module.
 *
 **************************************************************************/

#ifndef __RESERVOIRS_H__
#define __RESERVOIRS_H__

#include "DGCommon.h"

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

/// Enumeration of reservoirs     TODO - move to a Reservoirs.h in Services?
typedef enum Reservoirs
{
    RESERVOIR_1 = 0,        ///< Reservoir #1.
    RESERVOIR_2,            ///< Reservoir #2.
    NUM_OF_RESERVOIRS       ///< Number of reservoirs.
} RESERVOIR_ID_T;

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

void initReservoirs( void );

BOOL startFill( RESERVOIR_ID_T resID, U32 fillToVolMl, F32 targetPrimeTemp, F32 targetTrimTemp );   // handle fill command from HD
BOOL startDrain( RESERVOIR_ID_T resID, U32 drainToVolMl );                                          // handle drain command from HD

#endif