/**************************************************************************
*
* Copyright (c) 2024-2024 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)      Michael Garthwaite
* @date    (last)      28-Feb-2025
*
* @author  (original)  Michael Garthwaite
* @date    (original)  28-Feb-2025
*
***************************************************************************/
#ifndef __MODE_STANDBY_H__
#define __MODE_STANDBY_H__

#include "ROCommon.h"
#include "RODefs.h"

/**
 *  @defgroup ROStandbyMode ROStandbyMode
 *  @brief Standby mode unit. Manages the Standby mode functions via a state
 *  machine.
 *
 *  @addtogroup ROStandbyMode
 *  @{
 */

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

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

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

RO_STANDBY_MODE_STATE_T getCurrentStandbyState( void );         // get the current state of the standby mode.

BOOL testROstartGenPermeateOverride( MESSAGE_T *message );      // Overide start gen permeate mode

/**@}*/

#endif