/**************************************************************************
*
* 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    Valves.h
*
* @author  (last)      Vinayakam Mani
* @date    (last)      14-Aug-2024
*
* @author  (original)  Vinayakam Mani
* @date    (original)  14-Aug-2024
*
***************************************************************************/

#ifndef __VALVES_H__
#define __VALVES_H__

#include "DDCommon.h"
#include "ValvesDD.h"
/**
 *  @defgroup Valves Valves
 *  @brief Valves driver module. Controls valves.
 *
 *  @addtogroup Valves
 *  @{
 */

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


#define DEENERGIZED                                     0                                                           ///< 0 for de-energized valve.
#define ENERGIZED                                       1                                                           ///< 1 for energized valve.
#define ALL_VALVES_DEENERGIZED                          0x0000                                                      ///< 0 in U16 bit field for all valves.


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

void initValves( OVERRIDE_U32_T vlveStats[], OVERRIDE_U32_T vlveSensStats[], U32 penVlveStatChngs[], U32 penVlveStatChngeCntDns[],U32 numOfValves );

BOOL setValveState( VALVES_T valve, VALVE_STATE_NAMES_T valveState );
BOOL setValveStateDelayed( VALVES_T valve, VALVE_STATE_NAMES_T valveState, U32 delayMs );
VALVE_STATE_NAMES_T getValveStateName( VALVES_T valveID );
U16 fromU32ArrayToU16( void );


BOOL testSetValveStateOverride( U32 valve, U32 state );
BOOL testResetValveStateOverride( U32 valveID );

BOOL testSetValveSensedStateOverride( U32 valve, U32 status );
BOOL testResetValveSensedStateOverride( U32 valve );

/**@}*/

#endif