/**************************************************************************
*
* Copyright (c) 2022-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    ModeHeatDisinfectActiveCool.h
*
* @author  (last)      Dara Navaei
* @date    (last)      18-Dec-2022
*
* @author  (original)  Dara Navaei
* @date    (original)  18-Dec-2022
*
***************************************************************************/


#ifndef APP_MODES_MODEHEATDISINFECTACTIVECOOL_H_
#define APP_MODES_MODEHEATDISINFECTACTIVECOOL_H_

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

/**
 *  @defgroup DGHeatDisinfectActiveCoolMode DGHeatDisinfectActiveCoolMode
 *  @brief Heat disinfection active cool mode module. Manages the state machine for the heat disinfect active cool mode.
 *
 *  @addtogroup DGHeatDisinfectActiveCoolMode
 *  @{
 */

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

/// Heat disinfect active cool data publish struct
typedef struct
{
    U32 heatDisinfectActivCoolState;                            ///< Heat disinfect active cool state.
    U32 overallElapsedTime;                                     ///< Overall elapsed time in heat disinfect active cool mode.
    U32 stateElapsedTime;                                       ///< Current heat disinfect active cool elapsed time.
    U32 cancellationMode;                                       ///< Heat disinfect active cool cancellation mode.
} MODE_HEAT_DISINFECT_ACTIVE_COOL_DATA_T;

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

void initHeatDisinfectActiveCoolMode( void );                                 // Initialize this module
U32 transitionToHeatDisinfectActiveCoolMode( void );                         // Prepares for transition to heat disinfect mode
U32  execHeatDisinfectActiveCoolMode( void );                                 // Execute the heat disinfect mode state machine (call from OperationModes)

DG_HEAT_DISINFECT_ACTIVE_COOL_STATE_T getCurrentHeatDisinfectActiveCoolState( void );     // get the current state of the heat disinfect mode

BOOL stopDGHeatDisinfectActiveCool( void );                                   // Stop DG heat disinfect

/**@}*/

#endif