/**************************************************************************
*
* Copyright (c) 2019-2020 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 DGInterface.h
*
* @author (last) Sean Nash
* @date (last) 05-Oct-2020
*
* @author (original) Sean
* @date (original) 08-Apr-2020
*
***************************************************************************/

#ifndef __DG_H__
#define __DG_H__

#include "HDCommon.h"
#include "DGDefs.h"

/**
 *  @defgroup DGInterface DGInterface
 *  @brief DG interface/monitor module.  Interfaces with and monitors the
 *  DG (dialysate generator) sub-system.
 *
 *  @addtogroup DGInterface
 *  @{
 */

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

#define DRAIN_RESERVOIR_TO_VOLUME_ML        200                 ///< Drain reservoir to this volume (in mL) during treatment.
#ifndef V1_5_SYSTEM
#define FILL_RESERVOIR_TO_VOLUME_ML         1700                ///< Fill reservoir to this volume (in mL) during treatment.
#else
#define FILL_RESERVOIR_TO_VOLUME_ML         1300                ///< Fill reservoir to this volume (in mL) during treatment.
#endif

/// Enumeration of DG reservoirs.
typedef enum DG_Reservoirs
{
    DG_RESERVOIR_1 = 0,        ///< Reservoir #1.
    DG_RESERVOIR_2,            ///< Reservoir #2.
    NUM_OF_DG_RESERVOIRS       ///< Number of reservoirs.
} DG_RESERVOIR_ID_T;

/// Enumeration of DG pressure sensors.
typedef enum DG_PressureSensors
{
    DG_PRESSURE_SENSOR_RO_PUMP_INLET = 0,          ///< RO pump pressure sensor.
    DG_PRESSURE_SENSOR_RO_PUMP_OUTLET,             ///< RO pump pressure sensor.
    DG_PRESSURE_SENSOR_DRAIN_PUMP_INLET,           ///< drain pump inlet pressure.
    DG_PRESSURE_SENSOR_DRAIN_PUMP_OUTLET,          ///< drain pump outlet pressure.
    NUM_OF_DG_PRESSURE_SENSORS                     ///< Number of pressure sensors.
} DG_PRESSURE_SENSORS_T;

/// Payload record structure for an RO pump data message.
typedef struct
{
    U32 setPtPSI;
    F32 measFlowRateMlMin;
    F32 setPWMDutyCyclePct;
} DG_RO_PUMP_DATA_PAYLOAD_T;

/// Payload record structure for a drain pump data message.
typedef struct
{
    U32 setPtRPM;
    F32 setDAC;
} DG_DRAIN_PUMP_DATA_PAYLOAD_T;

/// Payload record structure for a DG pressures data message.
typedef struct
{
    F32 roInPSI;
    F32 roOutPSI;
    F32 drainInPSI;
    F32 drainOutPSI;
} DG_PRESSURES_DATA_PAYLOAD_T;

/// Payload record structure for a reservoirs data message.
typedef struct
{
    U32 resID;
    U32 setFillToVolumeMl;
    U32 setDrainToVolumeMl;
} DG_RESERVOIRS_DATA_PAYLOAD_T;

/// Payload record structure for DG temperature sensors data message.
typedef struct
{
    F32 TPi;
    F32 TPo;
    F32 TD1;
    F32 TD2;
    F32 TRo;
    F32 TDi;
    F32 HtrPrimThermo;
    F32 HtrTrimThermo;
    F32 HtrPrimColdJunc;
    F32 HtrTrimColdJunc;
    F32 HtrPrimInternal;
    F32 HtrTrimInternal;
} DG_TEMPERATURES_T;

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

void initDGInterface( void );
void initTreatmentReservoirMgmt( void );
void execTreatmentReservoirMgmt( void );

DG_OP_MODE_T getDGOpMode( void );
U32 getDGSubMode( void );
DG_RESERVOIR_ID_T getDGActiveReservoir( void );
F32 getDGPressure( DG_PRESSURE_SENSORS_T sensorID );
U32 getDGROPumpPressureSetPt( void );
F32 getDGROPumpFlowRateMlMin( void );
U32 getDGDrainPumpRPMSetPt( void );

void setDGOpMode( U32 opMode, U32 subMode );
void setDialysateTemperatureReadings( F32 temp1, F32 temp2 );
void setDGDialysateTemperatures( F32 primaryHtrTemp, F32 trimmerHtrTemp );
void setDGReservoirsData( DG_RESERVOIR_ID_T resID, U32 fillVol, U32 drainVol );
void setDGPressures( F32 roIn, F32 roOut, F32 drainIn, F32 drainOut );
void setDGROPumpData( U32 presSetPt, F32 flowRate );
void setDGDrainPumpData( U32 rpmSetPt );

void cmdSetDGDialysateTargetTemps( F32 primaryHtrTemp, F32 trimmerHtrTemp );
void cmdStartDG( void );
void cmdStopDG( void );
void cmdSetDGActiveReservoir( DG_RESERVOIR_ID_T resID );
void cmdStartDGFill( U32 fillToVolMl );
void cmdStartDGDrain( U32 drainToVolMl );
void cmdStartDGTrimmerHeater( void );
void cmdStopDGTrimmerHeater( void );
void cmdDGSampleWater( void );

/**@}*/

#endif