/**************************************************************************
*
* 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 PersistentAlarm.h
*
* @author (last) Quang Nguyen
* @date (last) 02-Sep-2020
*
* @author (original) Quang Nguyen
* @date (original) 17-Aug-2020
*
***************************************************************************/

#ifndef __PERSISTENTALARM_H__
#define __PERSISTENTALARM_H__

#include "Common.h"

/**
 *  @defgroup PersistentAlarm PersistentAlarm
 *  @brief Persistent alarm monitor module.
 *  Check for persistent error and throw appropriate alarm.
 *
 *  @addtogroup PersistentAlarm
 *  @{
 */

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

typedef enum PersistentAlarm
{
#ifdef _HD_
#endif
#ifdef _DG_
    PERSISTENT_ALARM_INLET_WATER_HIGH_TEMPERATURE,      ///< Inlet water high temperature persistent alarm 
    PERSISTENT_ALARM_INLET_WATER_LOW_TEMPERATURE,       ///< Inlet water low temperature persistent alarm
    PERSISTENT_ALARM_INLET_WATER_HIGH_CONDUCTIVITY,     ///< Inlet water high conductivity persistent alarm
    PERSISTENT_ALARM_INLET_WATER_LOW_CONDUCTIVITY,      ///< Inlet water low conductivity persistent alarm
    PERSISTENT_ALARM_RO_REJECTION_RATIO_OUT_OF_RANGE,   ///< RO rejection ratio out of range persistent alarm
    PERSISTENT_ALARM_INLET_WATER_LOW_PRESSURE,          ///< Inlet water low pressure persistent alarm
    PERSISTENT_ALARM_INLET_WATER_PRESSURE_FAULT,        ///< Inlet water pressure fault persistent alarm
    PERSISTENT_ALARM_RO_FLOW_RATE_OUT_OF_UPPER_RANGE,   ///< RO pump flow rate out of upper range
    PERSISTENT_ALARM_RO_FLOW_RATE_OUT_OF_LOWER_RANGE,   ///< RO pump flow rate out of lower range
    PERSISTENT_ALARM_RO_PUMP_PRESSURE_OUT_OF_RANGE,     ///< RO pump pressure out of range
    PERSISTENT_ALARM_DRAIN_PUMP_RPM_OUT_OF_RANGE,       ///< Drain pump RPM out of range
#endif
    NUM_OF_PERSISTENT_ALARM                             ///< Number of persistent alarms
} PERSISTENT_ALARM_T;

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

void initPersistentAlarm( PERSISTENT_ALARM_T alarmIndex, ALARM_ID_T alarm, BOOL isClearable,
                          F32 persistentClearCount, F32 persistentTriggerCount );
void checkPersistentAlarm( PERSISTENT_ALARM_T const alarmIndex, BOOL const isOutOfRange, F32 const data );

/**@}*/

#endif