/**************************************************************************
*
* 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
*
* @author (last) Sean Nash
* @date (last) 29-May-2020
*
* @author (original) Dara Navaei
* @date (original) 05-Nov-2019
*
***************************************************************************/

#ifndef __OP_MODES_H__
#define __OP_MODES_H__

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

/**
 *  @defgroup HDOperationModes HDOperationModes
 *  @brief Operation Modes module.
 *
 *  @addtogroup HDOperationModes
 *  @{
 */

// ********** 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( HD_OP_MODE_T newMode );               // Request a transition to a new operation mode
HD_OP_MODE_T getCurrentOperationMode( void );                       // Get the current operation mode
void initiateAlarmAction( ALARM_ACTION_T action );                  // Initiate an alarm or alarm recovery action according to current op mode

/**@}*/

#endif