/**************************************************************************
*
* Copyright (c) 2020-2023 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    ModeChemicalDisinfect.h
*
* @author  (last)      Dara Navaei
* @date    (last)      24-Oct-2021
*
* @author  (original)  Sean
* @date    (original)  04-Apr-2020
*
***************************************************************************/

#ifndef __MODE_CHEMICAL_DISINFECT_H__
#define __MODE_CHEMICAL_DISINFECT_H__

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

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

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

/// Chemical disinfect UI data
typedef struct
{
    U32 chemDisinfectTargetTime;           ///< Target time during chemical disinfect.
    U32 chemDisinfectCountdownTime;        ///< Chemical disinfect count down time.
} MODE_CHEMICAL_DISINFECT_UI_DATA_T;

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

void initChemicalDisinfectMode( void );           // initialize this module
U32 transitionToChemicalDisinfectMode( void );   // prepares for transition to chemical disinfection mode
U32  execChemicalDisinfectMode( void );           // execute the chemical disinfection mode state machine (call from OperationModes)

DG_CHEM_DISINFECT_STATE_T getCurrentChemicalDisinfectState( void );  // get the current state of the chemical disinfection mode.

BOOL stopChemicalDisinfect( void );

/**@}*/

#endif