/**************************************************************************
*
* 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    Conductivity.h
*
* @author  (last)      Vinayakam Mani
* @date    (last)      10-Sep-2024
*
* @author  (original)  Vinayakam Mani
* @date    (original)  10-Sep-2024
*
***************************************************************************/

#ifndef __CONDUCTIVITY_H__
#define __CONDUCTIVITY_H__

#include "DDCommon.h"
#include "ConductivitySensors.h"

/**
 *  @defgroup Conductivity Conductivity
 *  @brief Conductivity Sensors monitor module. Monitors and filters conductivity sensor readings.
 *
 *
 *
 *  @addtogroup Conductivity
 *  @{
 */

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

/// Conductivity data struct.
typedef struct
{
    F32 d17Cond;                                              ///< CD1 conductivity sensor value
    F32 d27Cond;                                              ///< CD2 conductivity sensor value
    F32 d29Cond;                                              ///< CD3 conductivity sensor value
    F32 d43Cond;                                              ///< CD4 conductivity sensor value
    F32 d74Cond;                                              ///< CD5 conductivity sensor value
} DD_CONDUCTIVITY_DATA_T;

/// Conductivity data struct.
typedef struct
{
    F32 p9Conductivity;                                       ///< (P9) conductivity sensor value
    F32 p18Conductivity;                                      ///< (P18) conductivity sensor value
} FP_CONDUCTIVITY_DATA_T;

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

void initConductivity( void );
void execConductivity( void );
F32 getFilteredConductivity( CONDUCTIVITY_SENSORS_T sensor );
F32 getFilteredConductivitySensorTemperature( CONDUCTIVITY_SENSORS_T sensor );

BOOL testDDConductivitySensorDataPublishIntervalOverride( MESSAGE_T *message );
BOOL testDDConductivitySensorFilteredReadingsOverride( MESSAGE_T *message );
BOOL testDDConductivitySensorFilteredTemperatureReadingsOverride( MESSAGE_T *message );
BOOL testFPConductivitySensorDataPublishIntervalOverride( MESSAGE_T *message );
BOOL testFPConductivitySensorFilteredReadingsOverride( MESSAGE_T *message );
BOOL testFPConductivitySensorFilteredTemperatureReadingsOverride( MESSAGE_T *message );

/**@}*/

#endif