/*
 * Valves.h
 *
 *  Created on: Aug 7, 2020
 *      Author: fw
 */

#ifndef _VALVES_H_
#define _VALVES_H_

#include "Common.h"

/**
 *  @defgroup Valves Valves
 *  @brief Valves module
 *  Driver that runs the valves in HD.
 *
 *  @addtogroup Valves
 *  @{
 */

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

typedef enum valveStatesNames
{
    VALVE_POSITION_NOT_IN_POSITION = 0,
    VALVE_POSITION_A_INSERT_EJECT,
    VALVE_POSITION_B_OPEN,
    VALVE_POSITION_C_CLOSE,
    NUM_OF_VALVE_POSITIONS,
} VALVE_POSITION_T;

typedef enum valveNames
{
    VDI = 0,
    VDO,
    VBA,
    VBV,
    NUM_OF_VALVES
} VALVE_T;

typedef enum valveBloodTrap
{
    ENERGIZE = 0,
    DEENERGIZE,
    NUM_OF_STATES
} VALVE_BLOOD_TRAP_STATE_T;

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

void initValves( void );

SELF_TEST_STATUS_T execValvesSelfTest( void );

void execValves( void );

BOOL homeValve( VALVE_T valve ); //TODO does it need to return bool?

BOOL setValvePosition( VALVE_T valve, VALVE_POSITION_T position ); //TODO does it need to return bool?

S16 getValvePosition( VALVE_T valve );

BOOL setValveBloodTrap( VALVE_BLOOD_TRAP_STATE_T state );

/**@}*/

#endif