/**************************************************************************
 *
 *  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 SystemCommMessages.h
 *
 *  @date 10-Oct-2019
 *  @author S. Nash
 *
 *  @brief header file for System Communication message definitions and functions.
 *
 **************************************************************************/

#ifndef __SYSTEM_COMM_MESSAGES_H__
#define __SYSTEM_COMM_MESSAGES_H__

#include "Common.h"
#include "MsgQueues.h"

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

typedef enum Msg_IDs
{
    MSG_ID_UNUSED = 0,
    MSG_ID_OFF_BUTTON_PRESS,
    MSG_ID_FIRST_TESTER_MESSAGE = 8000,
    MSG_ID_TESTER_LOGIN_REQUEST = MSG_ID_FIRST_TESTER_MESSAGE,
    MSG_ID_HD_MESSAGE,
    MSG_ID_OFF_BUTTON_STATE_OVERRIDE,
    MSG_ID_STOP_BUTTON_STATE_OVERRIDE,
    MSG_ID_ALARM_LAMP_PATTERN_OVERRIDE,
    MSG_ID_WATCHDOG_TASK_CHECKIN_OVERRIDE,
    NUM_OF_MSG_IDS
} MSG_ID_T;

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

// MSG_ID_OFF_BUTTON_PRESS
BOOL sendOffButtonMsgToUI( void );
void handleOffButtonConfirmMsgFromUI( MESSAGE_T *message );

// *********** public test support message functions **********

// MSG_TESTER_LOG_IN
void handleTesterLogInRequest( MESSAGE_T *message );
BOOL isTestingActivated( void );

// MSG_ID_HD_MESSAGE
void handleTestHDMessageRequest( MESSAGE_T *message );

// MSG_ID_OFF_BUTTON_STATE_OVERRIDE
void handleTestOffButtonStateOverrideRequest( MESSAGE_T *message );

// MSG_ID_STOP_BUTTON_STATE_OVERRIDE
void handleTestStopButtonStateOverrideRequest( MESSAGE_T *message );

// MSG_ID_ALARM_LAMP_PATTERN_OVERRIDE
void handleTestAlarmLampPatternOverrideRequest( MESSAGE_T *message );

// MSG_ID_WATCHDOG_TASK_CHECKIN_OVERRIDE:
void handleTestWatchdogCheckInStateOverrideRequest( MESSAGE_T *message );

#endif