/**************************************************************************
*
* 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    Valve2Way.h
*
* @author  (last)      Sean
* @date    (last)      03-Oct-2024
*
* @author  (original)  Sean
* @date    (original)  03-Oct-2024
*
***************************************************************************/

#ifndef __VALVE_2_WAY_H__
#define __VALVE_2_WAY_H__

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

#include "TDCommon.h"

/**
 *  @defgroup Valve2Way Valve2Way
 *  @brief 2 way valve driver unit. Provides low level functions
 *  to control a 2 way valve.
 *
 *  @addtogroup Valve2Way
 *  @{
 */

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

/// 2 way valve names
typedef enum valves2WayNames
{
    H13_VALV = 0,                       ///< Air trap relief valve
    NUM_OF_2_WAY_VALVES                 ///< Number of 2 way valves
} VALVE_2_WAY_T;

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

void init2WayValves( void );
void set2WayValveState( VALVE_2_WAY_T valve, OPN_CLS_STATE_T state );
OPN_CLS_STATE_T get2WayValveState( VALVE_2_WAY_T valve );

BOOL testSet2WayValve( MESSAGE_T *message );

/**@}*/

#endif