/**************************************************************************
*
* Copyright (c) 2020-2022 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    ModeChemicalDisinfectFlush.h
*
* @author  (last)
* @date    (last)
*
* @author  (original)  Steve Jarpe
* @date    (original)  10-Dec-2020
*
***************************************************************************/

#ifndef APP_MODES_MODECHEMICALDISINFECTFLUSH_H_
#define APP_MODES_MODECHEMICALDISINFECTFLUSH_H_

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

/**
 *  @defgroup DGChemicalDisinfectFlushMode DGChemicalDisinfecFlushMode
 *  @brief Chemical disinfect flush mode module. Manages chemical disinfect flush mode functions via a state machine.
 *
 *  @addtogroup DGChemicalDisinfectFlushMode
 *  @{
 */

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

/// Chemical disinfect UI data
typedef struct
{
    U32 chemDisinfectFlushTargetTime;           ///< Target time during chemical disinfect.
    U32 chemDisinfectFlushCountdownTime;        ///< Chemical disinfect count down time.
} MODE_CHEMICAL_DISINFECT_FLUSH_UI_DATA_T;

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

void initChemicalDisinfectFlushMode( void );           // initialize this module
U32 transitionToChemicalDisinfectFlushMode( void );    // prepares for transition to chemical disinfect flush mode
U32  execChemicalDisinfectFlushMode( void );           // execute the chemical disinfect flush mode state machine (call from OperationModes)

DG_CHEM_DISINFECT_FLUSH_STATE_T getCurrentChemicalDisinfectFlushState( void );  // get the current state of the chemical disinfect flush mode.

BOOL stopChemicalDisinfectFlush( void );

#endif