/**************************************************************************
*
* Copyright (c) 2021 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 DialysateFlow.h
*
* @author (last) H. Nguyen
* @date (last) 19-Oct-2021
*
* @author (original) H. Nguyen
* @date (original) 19-Oct-2021
*
***************************************************************************/

#ifndef __DIALYSATE_FLOW_H__
#define __DIALYSATE_FLOW_H__

#include "DGCommon.h"

/**
 *  @defgroup Dialysate Flow Meter
 *  @brief Dialysate flow rate monitor module.  Monitors the dialysate flow meter.
 *  The dialysate flow meter is manufactured by ?, PN: ?
 *
 *  @addtogroup Dialysate Flow Meter
 *  @{
 */

// ********** public definitions **********
#define MAX_DIALYSATE_FLOWRATE_LPM             1.4     ///< Maximum target Dialysate flow rate in L/min.
#define MIN_DIALYSATE_FLOWRATE_LPM             0.2     ///< Minimum target Dialysate flow rate in L/min.

/// Dialysate flow meter data struct.
typedef struct
{
    F32 measuredDialysateFlowRate;             ///< Dialysate flow meter rate average measurement.
} DIALYSATE_FLOW_METER_DATA_T;

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

void execDialysateFlowMeterMonitor( void );
F32  getMeasuredDialysateFlowRate( void );
void initDialysateFlowMeter( void );
//BOOL isDialysateFlowMeterRunning( void );
BOOL testSetDialysateMeterDataPublishIntervalOverride( U32 value );
BOOL testSetTargetDialysateMeterFlow( F32 flow );

/**@}*/

#endif