/**************************************************************************
*
* 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)      Sean
* @date    (last)      30-Jul-2024
*
* @author  (original)  Sean
* @date    (original)  30-Jul-2024
*
***************************************************************************/

#ifndef __MODE_STANDBY_H__
#define __MODE_STANDBY_H__

#include "TDCommon.h"
#include "TDDefs.h"

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

// ********** 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)

BOOL signalUserInitiateTreatment( MESSAGE_T *message );         // User has initiated/cancelled treatment workflow
void signalAlarmActionToStandbyMode( ALARM_ACTION_T action );   // Execute alarm action as appropriate for Standby mode

/**@}*/

#endif