modDiscreteOut.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025, TUSAS Malaysia
 * All rights reserved.
 * This file contains proprietary information. This
 * file shall not be duplicated, used, modified,
 * or disclosed in whole or in part without
 * the express written consent of TUSAS.
 */

 
#ifndef INCLUDED_MOD_DISCRETE_OUT_H
#define INCLUDED_MOD_DISCRETE_OUT_H
 
#include "commonDataTypes.h"
#include "modStatus.h"
#include "modConfig.h"

typedef enum
{
   DOUT_OG_GND = (1U), 
   DOUT_OG_OPEN = (2U), 
   DOUT_SO_SPLY = (3U), 
   DOUT_SO_OPEN = (4U), 
   DOUT_SG_SPLY = (5U), 
   DOUT_SG_GND = (6U)   
} DOutLogic;

typedef enum
{
   DOUT_OVL_DISABLE = 0U, 
   DOUT_OVL_ENABLE = 1U   
} DOutOvervoltageLockout;

typedef enum
{
   DOUT_ULD_DISABLE = 0U, 
   DOUT_ULD_ENABLE = 1U   
} DOutUnderloadShutdown;

typedef enum
{
   DOUT_GND_OPEN = 1U,    
   DOUT_SUPPLY_OPEN = 2U, 
   DOUT_SUPPLY_GND = 3U,  
} DOutChannelType;

ModStatus modDiscreteOut_devicesConfig(const DOutChannelBank DOutChannelBank,
                                       const DOutOvervoltageLockout overVoltage,
                                       const DOutUnderloadShutdown underLoad);

ModStatus modDiscreteOut_write(const DOutChannelNum channelNum, const DOutLogic dOutLogic);
 
#endif // INCLUDED_MOD_DISCRETE_OUT_H