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

#ifndef __MODE_GENP_DEF_H__
#define __MODE_GENP_DEF_H__

#include "FPCommon.h"
#include "FPDefs.h"

/**
 *  @defgroup FPGenPermeateDefeaturedMode FPGenPermeateDefeaturedMode
 *  @brief Generate Permeate Defeatured unit. Manages water generation functions via a state machine.
 *
 *  @addtogroup FPGenPermeateDefeaturedMode
 *  @{
 */

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

/// Generate Permeate mode data structure
typedef struct
{
    U32 genPermeateDefExecState;                       ///< Generate Permeate Defeatured execution state
} GEN_PERMEATE_DEF_MODE_DATA_T;

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

void initGenPermeateDefeaturedMode( void );                                          // Initialize this gen permeate mode unit
U32 transitionToGenPermeateDefeaturedMode( void );                                   // Transition to gen permeate mode
U32 execGenPermeateDefeaturedMode( void );                                           // Execute the gen permeate mode state machine (call from OperationModes)
BOOL requestGenWaterDefStart( void );                                                // request to start gen permeate in defeatured mode
BOOL requestGenWaterDefStop( void );                                                 // request to stop gen permeate in defeatured mode
BOOL getGenPermeateRequest( void );                                                  // get function to retrieve request status

FP_GENP_DEF_MODE_STATE_T getCurrentGenPermeateDefState( void );                      // Get the current state of the gen water mode

BOOL testGenPermeateDefDataPublishIntervalOverride( MESSAGE_T *message );            // override broadcast interval for defeatued gen permeate

/**@}*/

#endif