/**************************************************************************
*
* 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    Ultrafiltration.h
*
* @author  (last)      Vinayakam Mani
* @date    (last)      23-Jul-2025
*
* @author  (original)  Vinayakam Mani
* @date    (original)  23-Jul-2025
*
***************************************************************************/

#ifndef __ULTRA_FILTERATION_H__
#define __ULTRA_FILTERATION_H__

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

/**
 *  @defgroup Ultrafiltration Ultrafiltration
 *  @brief Ultrafiltration control unit. Performs ultrafiltration functions via a state machine.
 *
 *  @addtogroup Ultrafiltration
 *  @{
 */

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

/// ultrafiltration data structure
typedef struct
{
    U32 ufExecState;                                                    ///< Ultrafiltration execution state
    F32 ufRate;                                                         ///< Ultrafiltration rate from TD
    F32 compUFrate;                                                     ///< Compensated UF rate
    U32 isUFRequested;                                                  ///< Ultrafiltration run or puase request
} UF_DATA_T;

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

void initUltrafiltration( void );                                        // Initialize ultrafiltration unit
void transitionToUltrafiltration( void );                                // Prepares for transition to ultrafiltration execution
U32 execUFControl( void );                                               // Execute the ultrafiltration state machine
UF_EXEC_STATE_T getCurrentUFExecState( void );                           // Get the current state of the balancing chamber execution
void signalUFRateUpdate( void );                                         // Update UF rate when there is a change in rate

BOOL testDDUFDataPublishIntervalOverride( MESSAGE_T *message );          // To override the UF data publish interval

/**@}*/

#endif