/**************************************************************************
 *
 *  Copyright (c) 2019-2019 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 AlarmLamp.h
 *
 *  @date 20-Sep-2019
 *  @author S. Nash
 *
 *  @brief Header file for Alarm Lamp module.
 *
 **************************************************************************/

#ifndef __ALARM_LAMP_H__
#define __ALARM_LAMP_H__

#include "Common.h"

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

typedef enum LampPatternEnum
{
    LAMP_PATTERN_OFF = 0,
    LAMP_PATTERN_OK,
    LAMP_PATTERN_FAULT,
    LAMP_PATTERN_HIGH_ALARM,
    LAMP_PATTERN_MED_ALARM,
    LAMP_PATTERN_LOW_ALARM,
    LAMP_PATTERN_MANUAL,
    NUM_OF_LAMP_PATTERNS
} LAMP_PATTERN_T;

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

void initAlarmLamp( void );
void execAlarmLamp( void );
void requestAlarmLampPattern( LAMP_PATTERN_T lampPattern );
SELF_TEST_STATUS_T execAlarmLampTest( void );

DATA_GET_PROTOTYPE( LAMP_PATTERN_T, getCurrentAlarmLampPattern );

BOOL testSetCurrentLampPatternOverride( LAMP_PATTERN_T value );
BOOL testResetCurrentLampPatternOverride( void );

#endif