/**************************************************************************
*
* 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 ModeStandby.h
*
* @author (last) Quang Nguyen
* @date (last) 24-Aug-2020
*
* @author (original) Dara Navaei
* @date (original) 05-Nov-2019
*
***************************************************************************/

#ifndef __MODE_STANDBY_H__
#define __MODE_STANDBY_H__

#include "DGCommon.h"
#include "DGDefs.h"

/**
 *  @defgroup DGStandbyMode DGStandbyMode
 *  @brief Standby mode module. Manages standby mode functions via a state machine.
 *
 *  @addtogroup DGStandbyMode
 *  @{
 */

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

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

void initStandbyMode( void );           // initialize this module
void transitionToStandbyMode( void );   // prepares for transition to standby mode
U32  execStandbyMode( void );           // execute the standby mode state machine (call from OperationModes)

void waterSampleCommandHandler( SAMPLE_WATER_CMD_T sampleWaterCmd );
BOOL requestDGStart( void );            // HD requests DG start (go to generation idle mode)

BOOL startDGFlush( void );              // HD start flush mode

BOOL startDGHeatDisinfect( void );      // HD start heat disinfect mode
DG_STANDBY_MODE_STATE_T getCurrentStandbyState( void );  // get the current state of the standby mode.

BOOL testSetFilterFlushTimePeriodOverride( U32 value );
BOOL testResetFilterFlushTimePeriodOverride( void );

BOOL startDGChemicalDisinfect( void );  // HD start chemical disinfect mode

/**@}*/

#endif