/**************************************************************************
*
* Copyright (c) 2024-2025 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    ModeGenPermeate.h
*
* @author  (last)      Michael Garthwaite
* @date    (last)      03-Mar-2025
*
* @author  (original)  Michael Garthwaite
* @date    (original)  03-Mar-2025
*
***************************************************************************/

#ifndef __MODE_GEN_PERMEATE_H__
#define __MODE_GEN_PERMEATE_H__

#include "ROCommon.h"
#include "RODefs.h"

/**
 *  @defgroup ROGenPermeateMode ROGenPermeateMode
 *  @brief Generate Permeate unit. Manages permeate generation functions via a state machine.
 *
 *  @addtogroup ROGenPermeateMode
 *  @{
 */

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

/// Generate permeate mode data structure
typedef struct
{
    U32 genPermeateExecState;                          ///< Generate Permeate execution state
    F32 setFlowRate;                                   ///< Permeate flow rate requested by the DD.
} GEN_PERMEATE_MODE_DATA_T;

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

void initGenPermeateMode( void );                          // Initialize this gen permeate mode unit
U32  transitionToGenPermeateMode( void );                  // Transition to gen permeate mode
U32  execGenPermeateMode( void );                          // Execute the gen permeate mode state machine (call from OperationModes)
void execGenPermeateMonitor( void );                       // Permeate generation monitor

RO_GENP_MODE_STATE_T getCurrentGenPermeateState( void );   // Get the current state of the gen permeate mode

/**@}*/


#endif