/**************************************************************************
 *
 *  Copyright (c) 2019-2020 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 "DGCommon.h"
#include "MsgQueues.h"

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

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

// ACK MSG
BOOL sendACKMsg( MESSAGE_T *message );

// MSG_ID_ALARM_TRIGGERED
BOOL broadcastAlarmTriggered( U16 alarm, ALARM_DATA_T almData1, ALARM_DATA_T almData2 );
// MSG_ID_ALARM_CLEARED
BOOL broadcastAlarmCleared( U16 alarm );

// MSG_ID_RTC_EPOCH
BOOL broadcastRTCEpoch( U32 epoch );  // TODO - probably don't want DG to broadcast these

// MSG_ID_DG_OP_MODE
BOOL broadcastDGOperationMode( U32 mode );

// MSG_ID_LOAD_CELL_READINGS
BOOL broadcastLoadCellData( F32 loadCellA1, F32 loadCellA2, F32 loadCellB1, F32 loadCellB2 );

// MSG_ID_RO_PUMP_DATA
BOOL broadcastROPumpData( U32 tgtPressure, F32 measFlow, F32 setPWM );

// MSG_ID_DRAIN_PUMP_DATA
BOOL broadcastDrainPumpData( U32 tgtSpeed, F32 setPWM );

// MSG_ID_DG_PRESSURES_DATA
BOOL broadcastPressureSensorsData( F32 measROIn, F32 measROOut, F32 measDrainIn, F32 measDrainOut );

// MSG_ID_DG_RESERVOIR_DATA
BOOL broadcastReservoirData( U32 resID, U32 fillToVol, U32 drainToVol );

// MSG_ID_POWER_OFF_WARNING
void handlePowerOffWarning( MESSAGE_T *message );

// MSG_ID_SET_DG_DIALYSATE_TEMP_TARGETS
void handleSetDialysateTemperatureCmd( MESSAGE_T *message );

// MSG_ID_REQUEST_FW_VERSIONS
void handleFWVersionCmd( MESSAGE_T *message );

// MSG_ID_DG_SWITCH_RESERVOIR
void handleSwitchReservoirCmd( MESSAGE_T *message );

// MSG_ID_DG_FILL
void handleFillCmd( MESSAGE_T *message );

// MSG_ID_DG_DRAIN
void handleDrainCmd( MESSAGE_T *message );

// MSG_ID_STARTING_STOPPING_TREATMENT
void handleStartStopTreatmentMsg( MESSAGE_T *message );

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

#ifdef DEBUG_ENABLED
// DEBUG OUTPUT
BOOL sendDebugData( U08 *dbgData, U32 len );
#endif

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

// MSG_ID_DG_MESSAGE
void handleTestDGMessageRequest( MESSAGE_T *message );

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

// MSG_ID_ALARM_STATE_OVERRIDE
void handleTestAlarmStateOverrideRequest( MESSAGE_T *message );

// MSG_ID_LOAD_CELL_OVERRIDE
void handleTestLoadCellOverrideRequest( MESSAGE_T *message );

// MSG_ID_SET_RTC_TIMESTAMP
void handleSetRTCTimestamp( MESSAGE_T *message );

#endif