/**************************************************************************
*
* Copyright (c) 2019-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    ModeStandby.h
*
* @author  (last)      Dara Navaei
* @date    (last)      16-Feb-2023
*
* @author  (original)  Dara Navaei
* @date    (original)  05-Nov-2019
*
***************************************************************************/

#ifndef __MODE_STANDBY_H__
#define __MODE_STANDBY_H__

#include "HDCommon.h"
#include "HDDefs.h"

/**
 *  @defgroup HDStandbyMode HDStandbyMode
 *  @brief StandbyMode module.
 *
 *  @addtogroup HDStandbyMode
 *  @{
 */

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

/// DG disinfects data publish
typedef struct
{
    U32 disinfectSubModeHDState;      ///< HD disinfect sub mode state.
    U32 disinfectDGFlushState;        ///< DG disinfect flush state.
    U32 disinfectDGHeatState;         ///< DG disinfect heat disinfect state.
    U32 disinfectDGChemState;         ///< DG disinfect chem disinfect state.
} DISINFECTS_DATA_T;

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

void initStandbyMode( void );                                   // Initialize this module
U32 transitionToStandbyMode( void );                            // Prepares for transition to standby mode
U32  execStandbyMode( void );                                   // Execute the standby mode state machine (call from OperationModes)

BOOL signalUserInitiateTreatment( void );                       // User has initiated a treatment - go to treatment parameters mode
void signalAlarmActionToStandbyMode( ALARM_ACTION_T action );   // Execute alarm action as appropriate for Standby mode
BOOL signalUserInitiateFlushMode( void );
BOOL signalUserInitiateHeatDisinfectMode( void );
BOOL signalUserInitiateChemicalDisinfectMode( void );
BOOL signalUserInitiateChemcialDisinfectFlushMode( void );
BOOL signalInitiateStandbyDisinfectSubmode( U32 cmd );

BOOL testSetStandbyModePublishIntervalOverride( U32 ms );
BOOL testResetStandbyModePublishIntervalOverride( void );

/**@}*/

#endif