/**********************************************************************//**
 *
 *  Copyright (c) 2019-2020 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 OperationModes.h
 *
 *  @date 11-Dec-2019
 *  @author S. Nash
 *
 *  @brief Header file for Operation Modes.
 *
 **************************************************************************/

#ifndef __OP_MODES_H__
#define __OP_MODES_H__

#include "DGCommon.h"
#include "DGModes.h"

/**
 *  @defgroup OperationModes OperationModes
 *  @brief Operation Modes module.
 *  Manages the top level operation modes of the DG via a state machine.
 *
 *  @addtogroup OperationModes
 *  @{
 */

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

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

void initOperationModes( void );                   // initialize this module
void execOperationModes( void );                   // execute the operation modes state machine (scheduled periodic call)
void requestNewOperationMode( DG_OP_MODE_T newMode );   // request a transition to a new operation mode
DG_OP_MODE_T getCurrentOperationMode( void );           // get the current operation mode

/**@}*/

#endif