/**************************************************************************
 *
 *  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 L. Baloa
 *
 *  @brief Header file for Operation Modes.
 *
 **************************************************************************/

#ifndef __OP_MODES_H__
#define __OP_MODES_H__

#include "DGCommon.h"

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

typedef enum Op_Modes        // These are in order of priority (highest to lowest)
{
    MODE_FAUL = 0,            // Fault
    MODE_SERV,                // Service
    MODE_INIT,                // Initialization & POST
    MODE_STAN,                // Standby
    MODE_FILL,                // Fill mode
    MODE_DRAI,                // Drain
    MODE_FLUS,                // Flush
    MODE_DISI,                // Disinfect
    MODE_NLEG,                // Not legal
    NUM_OF_MODES
} OP_MODE;

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

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

#endif