/**************************************************************************
*
* 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 ModePreTreat.h
*
* @author (last) Sean Nash
* @date (last) 22-Sep-2020
*
* @author (original) Dara Navaei
* @date (original) 05-Nov-2019
*
***************************************************************************/

#ifndef __MODE_PRE_TREAT_H__
#define __MODE_PRE_TREAT_H__

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

/**
 *  @defgroup HDPreTreatmentMode HDPreTreatmentMode
 *  @brief Pre-TreatmentMode module.
 *
 *  @addtogroup HDPreTreatmentMode
 *  @{
 */

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

void initPreTreatmentMode( void );                                  // Initialize this module
void transitionToPreTreatmentMode( void );                          // Prepares for transition to pre-treatment mode
U32  execPreTreatmentMode( void );                                  // Execute the pre-treatment mode state machine (call from OperationModes)
BOOL signalUserBeginningTreatment( void );                          // Signal that user requests treatment begin
void signalAlarmActionToPreTreatmentMode( ALARM_ACTION_T action );  // Execute alarm action as appropriate for pre-treatment mode

/**@}*/

#endif