/**************************************************************************
*
* 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 Heaters.h
*
* @author (last) Quang Nguyen
* @date (last) 21-Aug-2020
*
* @author (original) Dara Navaei
* @date (original) 23-Apr-2020
*
***************************************************************************/

#ifndef _HEATERS_H_
#define _HEATERS_H_

#include "DGCommon.h"

/**
 *  @defgroup Heaters Heaters
 *  @brief Heaters driver modules. Controls the primary and trimmer heaters.
 *  The primary heaters are manufactured by Heatron, PN: UEL14EXK2A-Rev D with
 *  operating temperature in between 5C and 95C.
 *  The trimmer heater is manufactured by Heatron, PN: UEL5EXK1A-Rev D with
 *  operating temperature in between 5C and 95C.
 *
 *  @addtogroup Heaters
 *  @{
 */

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

/// Heaters data publish struct
typedef struct
{
    F32 mainPrimaryDutyCyclePct;      ///< Main primary heater duty cycle in percent.
    F32 smallPrimaryDutyCyclePct;     ///< Small primary heater duty cycle in percent.
    F32 trimmerDutyCyclePct;          ///< Trimmer heater duty cycle in percent.
} HEATERS_DATA_T;

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

void initHeaters( void );

void setPrimaryHeaterTargetTemperature( F32 targetTemp );
void setTrimmerHeaterTargetTemperature( F32 targetTemp );

BOOL startPrimaryHeater( void );
BOOL startTrimmerHeater( void );

void stopPrimaryHeater( void );
void stopTrimmerHeater( void );

void execHeatersMonitor( void );

SELF_TEST_STATUS_T execHeatersSelfTest( void );

void execPrimaryHeaters( void );
void execTrimmerHeater( void );

BOOL testSetHeatersPublishIntervalOverride( U32 value );
BOOL testResetHeatersPublishIntervalOverride( void );

/**@}*/

#endif