/**************************************************************************
*
* Copyright (c) 2024-2024 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    ModePreGenDialysate.h
*
* @author  (last)      Vinayakam Mani
* @date    (last)      17-Apr-2025
*
* @author  (original)  Vinayakam Mani
* @date    (original)  17-Apr-2025
*
***************************************************************************/

#ifndef __MODE_PRE_GEN_DIALYSATE_H__
#define __MODE_PRE_GEN_DIALYSATE_H__

#include "DDCommon.h"
#include "DDDefs.h"

/**
 *  @defgroup DDPreGenDialysateMode DDPreGenDialysateMode
 *  @brief PreGen Dialysate mode unit. Manages PreGen Dialysate mode functions via a state machine.
 *
 *  @addtogroup DDPreGenDialysateMode
 *  @{
 */

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

/// Pre-Gen dialysate mode data structure
typedef struct
{
    U32 preGenDialysateExecState;                       ///< Pre Generate dialysate execution state
} PRE_GEN_DIALYSATE_STATE_DATA_T;

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

void initPreGenDialysateMode( void );                                           // initialize this unit
U32 transitionToPreGenDialysateMode( void );                                    // prepares for transition to pre-gen dialysate mode
U32 execPreGenDialysateMode( void );                                            // execute the pre-gen dilaysate mode state machine (call from OperationModes)
DD_PRE_GEN_DAILYSATE_STATE_T getCurrentPreGenDialysateState( void );            // get the current state of the pre-gen dialysate mode.
BOOL requestDDGenDialStart( void );                                             // start generate dialysate delivery
BOOL requestDDPreGenStop( void );                                               // stop pregenerate dialysate delivery

BOOL testDDPreGenDialysateDataPublishIntervalOverride( MESSAGE_T *message );    // pre-gen dialysate publish override request
BOOL testDDstartGenDialysateOverride( MESSAGE_T *message );                     // start gen dialysate override request

/**@}*/

#endif