/**************************************************************************
*
* 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.c
*
* @author (last) Quang Nguyen
* @date (last) 26-Aug-2020
*
* @author (original) Dara Navaei
* @date (original) 05-Nov-2019
*
***************************************************************************/

#include <string.h>     // for memcpy()

#include "reg_system.h"

#include "Accel.h"
#include "ConcentratePumps.h"
#include "ConductivitySensors.h"
#include "Fans.h"
#include "FPGA.h"
#include "Heaters.h"
#include "ModeFlush.h"
#include "ModeGenIdle.h"
#include "ModeStandby.h"
#include "MsgQueues.h"
#include "NVDataMgmt.h"
#include "OperationModes.h"
#include "Pressures.h"
#include "Reservoirs.h"
#include "RTC.h"
#include "Switches.h"
#include "SystemComm.h"
#include "SafetyShutdown.h"
#include "SystemCommMessages.h"
#include "TemperatureSensors.h"
#include "Thermistors.h"
#include "Utilities.h"
#include "Valves.h"
#include "WatchdogMgmt.h"
#include "UVReactors.h"

/**
 *  @addtogroup SystemCommMessages
 *  @{
 */

// ********** private definitions **********

#ifdef DEBUG_ENABLED
    #define DEBUG_EVENT_MAX_TEXT_LEN    40
#endif

// ********** private data **********

static BOOL testerLoggedIn = FALSE;                 ///< Flag indicates whether tester logged in or not.
static volatile U16 nextSeqNo = 1;                  ///< Next sequence number.

// ********** private function prototypes **********

static BOOL sendTestAckResponseMsg( MSG_ID_T msgID, BOOL ack );
static BOOL sendAckResponseMsg( MSG_ID_T msgID, COMM_BUFFER_T buffer, BOOL ack );

/*********************************************************************//**
 * @brief
 * The serializeMessage function serializes a given message into a given
 * array of bytes.  A sequence # is added to the message here and the ACK
 * bit of the sequence # is set if ACK is required per parameter.  A sync byte
 * is inserted at the beginning of the message and an 8-bit CRC is appended to
 * the end of the message. The message is queued for transmission in the given buffer.
 * @details Inputs: none
 * @details Outputs: given data array populated with serialized message data and queued for transmit.
 * @param msg message to serialize
 * @param buffer outgoing buffer that message should be queued in
 * @param ackReq is an acknowledgement from receiver required?
 * @return size (in bytes) of serialized message populated in given data array.
 *************************************************************************/
U32 serializeMessage( MESSAGE_T msg, COMM_BUFFER_T buffer, BOOL ackReq )
{
    BOOL result = FALSE;
    BOOL error = FALSE;
    U32 msgSize = 0;
    U32 sizeMod, sizePad;
    U32 i;
    U08 crc;
    U08 data[ MAX_ACK_MSG_SIZE ];  // byte array to populate with message data

    // prefix data with message sync byte
    data[ msgSize++ ] = MESSAGE_SYNC_BYTE;

    // set sequence # and ACK bit (unless this is an ACK to a received message)
    if ( msg.hdr.msgID != MSG_ID_ACK )
    {
        // thread protect next sequence # access & increment
        _disable_IRQ();
            msg.hdr.seqNo = nextSeqNo;
            nextSeqNo = INC_WRAP( nextSeqNo, MIN_MSG_SEQ_NO, MAX_MSG_SEQ_NO );
        _enable_IRQ();
        if ( TRUE == ackReq )
        {
            msg.hdr.seqNo *= -1;
        }
    }

    // calculate message CRC
    crc = crc8( (U08*)(&msg), sizeof( MESSAGE_HEADER_T ) + msg.hdr.payloadLen );

    // serialize message header data
    memcpy( &data[ msgSize ], &( msg.hdr ), sizeof( MESSAGE_HEADER_T ) );
    msgSize += sizeof( MESSAGE_HEADER_T );

    // serialize message payload (only used bytes per payloadLen field)
    memcpy( &data[ msgSize ], &( msg.payload ), msg.hdr.payloadLen );
    msgSize += msg.hdr.payloadLen;

    // add 8-bit CRC
    data[ msgSize++ ] = crc;

    // pad with zero bytes to get length a multiple of CAN_MESSAGE_PAYLOAD_SIZE (8)
    sizeMod = msgSize % CAN_MESSAGE_PAYLOAD_SIZE;
    sizePad = ( sizeMod == 0 ? 0 : CAN_MESSAGE_PAYLOAD_SIZE - sizeMod );
    for ( i = 0; i < sizePad; i++ )
    {
        data[ msgSize++ ] = 0;
    }

    // if ACK required, add to pending ACK list
    if ( TRUE == ackReq )
    {
        if ( FALSE == addMsgToPendingACKList( &msg, buffer, data, msgSize ) )
        {
            error = TRUE;
            SET_ALARM_WITH_1_U32_DATA( ALARM_ID_DG_SOFTWARE_FAULT, SW_FAULT_ID_MSG_PENDING_ACK_LIST_FULL )
        }
    }

    if ( FALSE == error )
    {
        // add serialized message data to appropriate out-going comm buffer
        result = addToCommBuffer( buffer, data, msgSize );
    }

    return result;
}

/*********************************************************************//**
 * @brief
 * The sendACKMsg function constructs and queues for transmit an ACK message
 * for a given received message.
 * @details Inputs: none
 * @details Outputs: ACK message queued for transmit on broadcast CAN channel.
 * @param message message to send an ACK for
 * @return TRUE if ACK message queued successfully, FALSE if not
 *************************************************************************/
BOOL sendACKMsg( MESSAGE_T *message )
{
    BOOL result;
    MESSAGE_T msg;

    // create a message record
    blankMessage( &msg );
    // send ACK back with same seq. #, but w/o ACK bit
    msg.hdr.seqNo = message->hdr.seqNo * -1;
    // ACK messages always have this ID
    msg.hdr.msgID = MSG_ID_ACK;
    // ACK messages always have no payload
    msg.hdr.payloadLen = 0;

    // serialize and queue the message for transmit on broadcast channel
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_BROADCAST, ACK_NOT_REQUIRED );

    return result;
}

/*********************************************************************//**
 * @brief
 * The sendTestAckResponseMsg function constructs a simple response message for
 * a handled test message and queues it for transmit on the appropriate UART channel.
 * @details Inputs: none
 * @details Outputs: response message constructed and queued for transmit.
 * @param msgID ID of handled message that we are responding to
 * @param buffer outgoing buffer that message should be queued in
 * @param ack TRUE if test message was handled successfully, FALSE if not
 * @return TRUE if response message successfully queued for transmit, FALSE if not
 *************************************************************************/
static BOOL sendAckResponseMsg( MSG_ID_T msgID, COMM_BUFFER_T buffer, BOOL ack )
{
    BOOL result;
    MESSAGE_T msg;

    // create a message record
    blankMessage( &msg );
    msg.hdr.msgID = msgID;
    msg.hdr.payloadLen = sizeof( U08 );
    msg.payload[ 0 ] = (U08)ack;

    // serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, buffer, ACK_NOT_REQUIRED );

    return result;
}


// ***********************************************************************
// ***************** Message Sending Helper Functions ********************
// ***********************************************************************

/*********************************************************************//**
 * @brief
 * The sendEvent function constructs an DG event message to the UI and
 * queues the msg for transmit on the appropriate CAN channel.
 * @details Inputs: none
 * @details Outputs: DG event msg constructed and queued.
 * @param event Enumeration of event type that occurred
 * @param dat1 First data associated with event
 * @param dat2 Second data associated with event
 * @return TRUE if msg successfully queued for transmit, FALSE if not
 *************************************************************************/
BOOL sendEvent( DG_EVENT_ID_T event, EVENT_DATA_T dat1, EVENT_DATA_T dat2 )
{
    BOOL result;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;
    U32 e = (U32)event;
    // Convert the two data types enums to U32. The enums are interpreted as a U08 by the compiler
    U32 dataType1 = (U32)dat1.dataType;
    U32 dataType2 = (U32)dat2.dataType;

    // Create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_EVENT;
    // The payload length is the event ID, 2 event datas and the events data types for each of the event data
    msg.hdr.payloadLen = sizeof( U32 ) + 2 * sizeof( EVENT_DATAS_T ) + 2 * sizeof( U32 );

    memcpy( payloadPtr, &e, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );
    memcpy( payloadPtr, &dataType1, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );
    memcpy( payloadPtr, &dat1.data, sizeof( EVENT_DATAS_T ) );
    payloadPtr += sizeof( EVENT_DATAS_T );
    memcpy( payloadPtr, &dataType2, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );
    memcpy( payloadPtr, &dat2.data, sizeof( EVENT_DATAS_T ) );

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_2_UI, ACK_NOT_REQUIRED );

    return result;
}

/*********************************************************************//**
 * @brief
 * The broadcastAlarmTriggered function constructs an alarm triggered msg to
 * be broadcast and queues the msg for transmit on the appropriate CAN channel.
 * @details Inputs: none
 * @details Outputs: alarm triggered msg constructed and queued.
 * @param alarm ID of alarm triggered
 * @param almData1 1st data associated with alarm
 * @param almData2 2nd data associated with alarm
 * @return TRUE if msg successfully queued for transmit, FALSE if not
 *************************************************************************/
BOOL broadcastAlarmTriggered( U32 alarm, ALARM_DATA_T almData1, ALARM_DATA_T almData2 )
{
    BOOL result;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;

    // create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_ALARM_TRIGGERED;
    msg.hdr.payloadLen = sizeof( U32 ) + sizeof( ALARM_DATA_T ) + sizeof( ALARM_DATA_T );

    memcpy( payloadPtr, &alarm, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );
    memcpy( payloadPtr, &almData1, sizeof( ALARM_DATA_T ) );
    payloadPtr += sizeof( ALARM_DATA_T );
    memcpy( payloadPtr, &almData2, sizeof( ALARM_DATA_T ) );

    // serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_ALARM, ACK_REQUIRED );

    return result;
}

/*********************************************************************//**
 * @brief
 * The broadcastAlarmCleared function constructs an alarm cleared msg to be
 * broadcast and queues the msg for transmit on the appropriate CAN channel.
 * @details Inputs: none
 * @details Outputs: alarm cleared msg constructed and queued.
 * @param alarm ID of alarm cleared
 * @return TRUE if msg successfully queued for transmit, FALSE if not
 *************************************************************************/
BOOL broadcastAlarmCleared( U32 alarm )
{
    BOOL result;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;

    // create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_ALARM_CLEARED;
    msg.hdr.payloadLen = sizeof( U32 );

    memcpy( payloadPtr, &alarm, sizeof( U32 ) );

    // serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_ALARM, ACK_REQUIRED );

    return result;
}

/*********************************************************************//**
 * @brief
 * The broadcastAlarmConditionCleared function constructs an alarm condition
 * cleared msg to be broadcast and queues the msg for transmit on the
 * appropriate CAN channel.
 * @details Inputs: none
 * @details Outputs: alarm condition cleared msg constructed and queued.
 * @param alarm ID of alarm which alarm condition is cleared
 * @return TRUE if msg successfully queued for transmit, FALSE if not
 *************************************************************************/
BOOL broadcastAlarmConditionCleared( U32 alarm )
{
    BOOL result;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;

    // create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_ALARM_CONDITION_CLEARED;
    msg.hdr.payloadLen = sizeof( U32 );

    memcpy( payloadPtr, &alarm, sizeof( U32 ) );

    // serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_ALARM, ACK_REQUIRED );

    return result;
}


// ***********************************************************************
// **************** Message Handling Helper Functions ********************
// ***********************************************************************


/*********************************************************************//**
 * @brief
 * The handlePowerOffWarning function handles a power off warning message
 * from the HD.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handlePowerOffWarning( MESSAGE_T *message )
{
    if ( message->hdr.payloadLen == 0 )
    {
        signalPowerOffWarning();
    }
}

/*********************************************************************//**
 * @brief
 * The handleAlarmClear function handles a clear alarm message from the HD.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleAlarmClear( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof( U32 ) )
    {
        U32 alarmId;

        result = TRUE;
        memcpy(&alarmId, message->payload, sizeof( U32 ) );
        clearAlarm( (ALARM_ID_T)alarmId );
    }
    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );
}

/*********************************************************************//**
 * @brief
 * The handleSetDialysateTemperatureCmd function handles a dialysate temperature
 * set points message from the HD.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleSetDialysateTemperatureCmd( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof( TARGET_TEMPS_PAYLOAD_T ) )
    {
        TARGET_TEMPS_PAYLOAD_T payload;

        result = TRUE;
        memcpy( &payload, message->payload, sizeof( TARGET_TEMPS_PAYLOAD_T ) );
        setHeaterTargetTemperature( DG_PRIMARY_HEATER, payload.targetPrimaryHeaterTemp );
        //setHeaterTargetTemperature( DG_TRIMMER_HEATER, payload.targetTrimmerHeaterTemp ); // DEBUG_DENALI for treatment testing
    }
    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );
}

/*********************************************************************//**
 * @brief
 * The handleFWVersionCmd function handles a FW version request message.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleFWVersionCmd( MESSAGE_T *message )
{
    MESSAGE_T msg;
    DG_VERSIONS_T payload;
    U08 *payloadPtr = msg.payload;

    // populate payload
    payload.major = (U08)DG_VERSION_MAJOR;
    payload.minor = (U08)DG_VERSION_MINOR;
    payload.micro = (U08)DG_VERSION_MICRO;
    payload.build = (U16)DG_VERSION_BUILD;
    getFPGAVersions( &payload.fpgaId, &payload.fpgaMajor, &payload.fpgaMinor, &payload.fpgaLab );

    // create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_VERSION;
    msg.hdr.payloadLen = sizeof( DG_VERSIONS_T );

    // fill message payload
    memcpy( payloadPtr, &payload, sizeof( DG_VERSIONS_T ) );

    // serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_BROADCAST, ACK_NOT_REQUIRED );
}

/*********************************************************************//**
 * @brief
 * The handleDGSerialNumberRequest function handles a request for DG serial
 * number request.
 * @details Inputs: none
 * @details Outputs: message handled, response constructed and queued for transmit.
 * @return none
 *************************************************************************/
void handleDGSerialNumberRequest( void )
{
    MESSAGE_T msg;
    DG_SYSTEM_RECORD_T system = getDGSystemRecord();
    U08 *payloadPtr = msg.payload;

    // Create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_SERIAL_NUMBER;

    // Add 1 byte for null terminator
    msg.hdr.payloadLen = MAX_TOP_LEVEL_SN_CHARS + 1;

    // Fill message payload
    memcpy( payloadPtr, &system.topLevelSN, MAX_TOP_LEVEL_SN_CHARS );
    payloadPtr += MAX_TOP_LEVEL_SN_CHARS;
    *payloadPtr = 0;

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_2_UI, ACK_REQUIRED );
}

/*********************************************************************//**
 * @brief
 * The handleDGServiceScheduleRequest function handles a request for DG
 * service information.
 * @details Inputs: none
 * @details Outputs: message handled, response constructed and queued for
 * transmit.
 * @return none
 *************************************************************************/
void handleDGServiceScheduleRequest( MESSAGE_T *message )
{
    MESSAGE_T msg;
    DG_SERVICE_RECORD_T payload = getDGServiceRecord();
    U08 *payloadPtr = msg.payload;

    // Create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_SERVICE_SCHEDULE_DATA;
    msg.hdr.payloadLen = sizeof( U32 ) + sizeof( U32 );

    // Fill message payload
    memcpy( payloadPtr, &payload.lastServiceEpochDate, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );
    memcpy( payloadPtr, &payload.serviceIntervalSeconds, sizeof( U32 ) );

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_2_UI, ACK_REQUIRED );
}

/*********************************************************************//**
 * @brief
 * The sendDGCalibrationRecord function sends out the DG calibration
 * record.
 * @details Inputs: none
 * @details Outputs: DG calibration record msg constructed and queued
 * @param msgCurrNum: current payload number
 * @param msgTotalNum: total number of payloads
 * @param length: buffer length to be written
 * @param calRcrdAddress: start address of the calibration record
 * @return TRUE if msg successfully queued for transmit, FALSE if not
 *************************************************************************/
BOOL sendDGCalibrationRecord( U32 payloadCurrNum, U32 payloadTotalNum, U32 length, U08* calRcrdAddress )
{
    BOOL result;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;

    // Create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_SEND_CALIBRATION_RECORD;
    msg.hdr.payloadLen = sizeof( U32 ) + sizeof( U32 ) + sizeof( U32 ) + length;

    memcpy( payloadPtr, &payloadCurrNum, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, &payloadTotalNum, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, &length, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, calRcrdAddress, length );

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_PC, ACK_NOT_REQUIRED );

    return result;
}


/*********************************************************************//**
 * @brief
 * The sendDGSystemRecord function sends out the DG system record.
 * @details Inputs: none
 * @details Outputs: DG system record msg constructed and queued
 * @param msgCurrNum: current payload number
 * @param msgTotalNum: total number of payloads
 * @param length: buffer length to be written
 * @param sysRcrdAddress: start address of the system record
 * @return TRUE if msg successfully queued for transmit, FALSE if not
 *************************************************************************/
BOOL sendDGSystemRecord( U32 payloadCurrNum, U32 payloadTotalNum, U32 length, U08* sysRcrdAddress )
{
    BOOL result;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;

    // Create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_SEND_SYSTEM_RECORD;
    msg.hdr.payloadLen = sizeof( U32 ) + sizeof( U32 ) + sizeof( U32 ) + length;

    memcpy( payloadPtr, &payloadCurrNum, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, &payloadTotalNum, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, &length, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, sysRcrdAddress, length );

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_PC, ACK_NOT_REQUIRED );

    return result;
}

/*********************************************************************//**
 * @brief
 * The sendDGServiceRecord function sends out the DG service record.
 * @details Inputs: none
 * @details Outputs: DG system record msg constructed and queued
 * @param msgCurrNum: current payload number
 * @param msgTotalNum: total number of payloads
 * @param length: buffer length to be written
 * @param srvcRcrdAddress: start address of the service record
 * @return TRUE if msg successfully queued for transmit, FALSE if not
 *************************************************************************/
BOOL sendDGServiceRecord( U32 payloadCurrNum, U32 payloadTotalNum, U32 length, U08* srvcRcrdAddress )
{
    BOOL result;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;

    // Create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_SEND_SERVICE_RECORD;
    msg.hdr.payloadLen = sizeof( U32 ) + sizeof( U32 ) + sizeof( U32 ) + length;

    memcpy( payloadPtr, &payloadCurrNum, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, &payloadTotalNum, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, &length, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, srvcRcrdAddress, length );

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_PC, ACK_NOT_REQUIRED );

    return result;
}

/*********************************************************************//**
 * @brief
 * The sendDGServiceRecord function sends out the DG service record.
 * @details Inputs: none
 * @details Outputs: DG system record msg constructed and queued
 * @param msgCurrNum: current payload number
 * @param msgTotalNum: total number of payloads
 * @param length: buffer length to be written
 * @param scheduledRcrdAddress: start address of the scheduled runs record
 * @return TRUE if msg successfully queued for transmit, FALSE if not
 *************************************************************************/
BOOL sendDGScheduledRunsRecord( U32 payloadCurrNum, U32 payloadTotalNum, U32 length, U08* scheduledRcrdAddress )
{
    BOOL result;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;

    // Create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_SEND_SCHEDULED_RUNS_RECORD;
    msg.hdr.payloadLen = sizeof( U32 ) + sizeof( U32 ) + sizeof( U32 ) + length;

    memcpy( payloadPtr, &payloadCurrNum, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, &payloadTotalNum, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, &length, sizeof( U32 ) );
    payloadPtr += sizeof( U32 );

    memcpy( payloadPtr, scheduledRcrdAddress, length );

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_PC, ACK_NOT_REQUIRED );

    return result;
}

/*********************************************************************//**
 * @brief
 * The sendPOSTTestResult function constructs an DG POST test result message
 * and queues the msg for transmit on the appropriate CAN channel.
 * @details Inputs: none
 * @details Outputs: DG POST test result msg constructed and queued.
 * @param test ID of DG POST test
 * @param passed TRUE if POST test passed, FALSE if not
 * @return TRUE if msg successfully queued for transmit, FALSE if not
 *************************************************************************/
BOOL sendPOSTTestResult( DG_POST_STATE_T test, BOOL passed )
{
    BOOL result;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;
    U32 testID = (U32)test;

    // Create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_POST_SINGLE_TEST_RESULT;
    msg.hdr.payloadLen = sizeof( BOOL ) + sizeof( U32 );

    memcpy( payloadPtr, &passed, sizeof( BOOL ) );
    payloadPtr += sizeof( BOOL );
    memcpy( payloadPtr, &testID, sizeof( U32) );

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_BROADCAST, ACK_NOT_REQUIRED );

    return result;

}

/*********************************************************************//**
 * @brief
 * The sendPOSTFinalResult function constructs an DG POST final result message
 * and queues the msg for transmit on the appropriate CAN channel.
 * @details Inputs: none
 * @details Outputs: DG POST final result msg constructed and queued.
 * @param passed TRUE if DG POST passed, FALSE if not
 * @return TRUE if msg successfully queued for transmit, FALSE if not
 *************************************************************************/
BOOL sendPOSTFinalResult( BOOL passed )
{
    BOOL result;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;

    // Create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_POST_FINAL_TEST_RESULT;
    msg.hdr.payloadLen = sizeof( BOOL );

    memcpy( payloadPtr, &passed, sizeof( BOOL ) );

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_BROADCAST, ACK_NOT_REQUIRED );

    return result;
}

/*********************************************************************//**
 * @brief
 * The sendCommandResponseMsg function constructs a command response to HD
 * and queues the msg for transmit on the appropriate CAN channel.
 * @details Inputs: none
 * @details Outputs: Command response msg constructed and queued.
 * @param cmdResponsePtr pointer to command response data record
 * @return none
 *************************************************************************/
void sendCommandResponseMsg( DG_CMD_RESPONSE_T *cmdResponsePtr )
{
    MESSAGE_T msg;

    // Create a message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_COMMAND_RESPONSE;
    msg.hdr.payloadLen = sizeof( DG_CMD_RESPONSE_T );

    memcpy( msg.payload, cmdResponsePtr, sizeof( DG_CMD_RESPONSE_T ) );

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_2_HD, ACK_REQUIRED );
}

// ***********************************************************************
// **************** Message Handling Helper Functions ********************
// ***********************************************************************

/*********************************************************************//**
 * @brief
 * The handleSwitchReservoirCmd function handles a switch reservoirs command
 * from the HD.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleSwitchReservoirCmd( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof( U32 ) )
    {
        DG_RESERVOIR_ID_T reservoirID;
        U32 resID;

        result = TRUE;
        memcpy( &resID, message->payload, sizeof( U32 ) );
        reservoirID = (DG_RESERVOIR_ID_T)resID;
        setActiveReservoirCmd( reservoirID );
    }

    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );
}

/*********************************************************************//**
 * @brief
 * The handleChangeValveSettingCmd function handles a switch reservoirs command
 * from the HD.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleChangeValveSettingCmd( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof( U32 ) )
    {
        DG_VALVE_SETTING_ID_T valveSettingID;

        result = TRUE;
        memcpy( &valveSettingID, message->payload, sizeof( U32 ) );
        changeValveSettingCmd( valveSettingID );
    }

    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );
}

/*********************************************************************//**
 * @brief
 * The handleFillCmd function handles a fill command from the HD.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleFillCmd( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof( FILL_CMD_T ) )
    {
        FILL_CMD_T fillCmd;

        result = TRUE;
        memcpy( &fillCmd, message->payload, sizeof( FILL_CMD_T ) );

        if ( DG_CMD_START == fillCmd.cmd )
        {
            startFillCmd( fillCmd.fillToVolumeMl );
        }
        else
        {
            stopFillCmd();
        }
    }

    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );
}

/*********************************************************************//**
 * @brief
 * The handleDrainCmd function handles a drain command from the HD.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleDrainCmd( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof( DRAIN_CMD_T ) )
    {
        DRAIN_CMD_T drainCmd;

        result = TRUE;
        memcpy( &drainCmd, message->payload, sizeof( DRAIN_CMD_T ) );

        if ( DG_CMD_START == drainCmd.cmd )
        {
            startDrainCmd( drainCmd );
        }
        else
        {
            stopDrainCmd();
        }
    }

    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );
}

/*********************************************************************//**
 * @brief
 * The handleStartStopTreatmentMsg function handles a treatment start/stop
 * message from the HD.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleStartStopTreatmentMsg( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof( U32 ) )
    {
        BOOL startingTreatment;

        memcpy( &startingTreatment, message->payload, sizeof( U32 ) );

        if ( ( DG_MODE_STAN == getCurrentOperationMode() ) && ( TRUE == startingTreatment ) )
        {
            result = requestDGStart();
        }
        else if ( ( DG_MODE_GENE == getCurrentOperationMode() ) && ( FALSE == startingTreatment ) )
        {
            result = requestDGStop();
        }
    }

    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );
}

/*********************************************************************//**
 * @brief
 * The handleStartStopTrimmerHeaterCmd function handles a trimmer heater start/stop
 * command message from the HD.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleStartStopTrimmerHeaterCmd( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof( TRIMMER_HEATER_CMD_T ) )
    {
        TRIMMER_HEATER_CMD_T heaterCmd;

        result = TRUE;
        memcpy( &heaterCmd, message->payload, sizeof( TRIMMER_HEATER_CMD_T ) );
        handleTrimmerHeaterCmd( &heaterCmd );
    }

    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );
}

/*********************************************************************//**
 * @brief
 * The handleSampleWaterCmd function handles a sample water command from the HD.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleSampleWaterCmd( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof( U32 ) )
    {
        SAMPLE_WATER_CMD_T sampleWaterCmd;

        result = TRUE;
        memcpy( &sampleWaterCmd, message->payload, sizeof( U32 ) );
        waterSampleCommandHandler( sampleWaterCmd );
    }

    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );
}

/*********************************************************************//**
 * @brief
 * The handleSetRTCTimestamp function handles a request to write time and
 * date to RTC
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleSetRTCTimestamp( MESSAGE_T *message )
{
    BOOL result;
    U08 seconds = message->payload[0];
    U08 minutes = message->payload[1];
    U08 hours   = message->payload[2];
    U08 days    = message->payload[3];
    U08 months  = message->payload[4];
    U32 years;
    memcpy(&years, &message->payload[5], sizeof( U32 ));

    result = setRTCTimestamp( seconds, minutes, hours, days, months, years );

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleStartStopPrimaryHeater function handles a request start or
 * stop the primary heater
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return result
 *************************************************************************/
BOOL handleStartStopPrimaryHeater( MESSAGE_T * message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof( U32 ) )
    {
        BOOL startingHeater;

        memcpy( &startingHeater, message->payload, sizeof( U32 ) );

        if ( TRUE == startingHeater )
        {
            result = startHeater( DG_PRIMARY_HEATER );
        }
        else
        {
            stopHeater( DG_PRIMARY_HEATER );
            result = TRUE;
        }
    }

    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );

    return result;
}


/*************************************************************************
 *                       TEST SUPPORT FUNCTIONS
 *************************************************************************/

#ifdef DEBUG_ENABLED
    /*********************************************************************//**
     * @brief
     * The sendDebugData function sends debug data out to the PC port.
     * @details
     * @details Inputs: none
     * @details Outputs: PC serial port
     * @param dbgData Pointer to debug data
     * @param len number of bytes of debug data
     * @return TRUE if debug data was successfully queued for transmit, FALSE if not
     *************************************************************************/
    BOOL sendDebugData( U08 *dbgData, U32 len )
    {
        BOOL result;

        // add serialized message data to appropriate comm buffer
        result = addToCommBuffer( COMM_BUFFER_OUT_UART_PC, dbgData, len );

        return result;
    }

    /*********************************************************************//**
     * @brief
     * The sendDebugDataToUI function sends debug string to the UI for logging.
     * @details
     * @details Inputs: none
     * @details Outputs: Message constructed and queued for transmit
     * @param str Pointer to debug string
     * @return none
     *************************************************************************/
    void sendDebugDataToUI( U08 *str )
    {
        MESSAGE_T msg;
        U32 txtLen = strlen( (char*)str );
        U08 *payloadPtr = msg.payload;

        // create a message record
        blankMessage( &msg );
        msg.hdr.msgID = MSG_ID_DG_DEBUG_EVENT;
        msg.hdr.payloadLen = DEBUG_EVENT_MAX_TEXT_LEN + 1; // add 1 byte for null terminator
        if ( txtLen <= DEBUG_EVENT_MAX_TEXT_LEN )
        {
            memcpy( payloadPtr, str, txtLen + 1 );

            // serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
            serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_2_UI, ACK_NOT_REQUIRED );
        }
    }
#endif

/*********************************************************************//**
 * @brief
 * The isTestingActivated function determines whether a tester has successfully
 * logged in to activate testing functionality.
 * @details Inputs: testerLoggedIn
 * @details Outputs: none
 * @return TRUE if a tester has logged in to activate testing, FALSE if not
 *************************************************************************/
BOOL isTestingActivated( void )
{
    return testerLoggedIn;
}

/*********************************************************************//**
 * @brief
 * The sendTestAckResponseMsg function constructs a simple response message for
 * a handled test message and queues it for transmit on the appropriate UART channel.
 * @details Inputs: none
 * @details Outputs: response message constructed and queued for transmit.
 * @param msgID ID of handled message that we are responding to
 * @param ack TRUE if test message was handled successfully, FALSE if not
 * @return TRUE if response message successfully queued for transmit, FALSE if not
 *************************************************************************/
static BOOL sendTestAckResponseMsg( MSG_ID_T msgID, BOOL ack )
{
    BOOL result;
    MESSAGE_T msg;

    // create a message record
    blankMessage( &msg );
    msg.hdr.msgID = msgID;
    msg.hdr.payloadLen = sizeof( U08 );
    msg.payload[ 0 ] = (U08)ack;

    // serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_PC, ACK_NOT_REQUIRED );

    return result;
}

/*********************************************************************//**
 * @brief
 * The handleTesterLogInRequest function handles a request to login as a tester.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTesterLogInRequest( MESSAGE_T *message )
{
    // verify pass code
    // TODO - placeholder - how do we want to authenticate tester?
    if ( ( 3 == message->hdr.payloadLen ) && ( 0x31 == message->payload[ 0 ] ) && ( 0x32 == message->payload[ 1 ] ) && ( 0x33 == message->payload[ 2 ] ) )
    {
        testerLoggedIn = TRUE;
    }
    else
    {
        testerLoggedIn = FALSE;
    }
    // respond to would be tester
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, testerLoggedIn );
}

/*********************************************************************//**
 * @brief
 * The handleTestWatchdogCheckInStateOverrideRequest function handles a
 * request to override the check-in status of a given task.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestWatchdogCheckInStateOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetWatchdogTaskCheckInOverride( payload.index, (BOOL)(payload.state.u32) );
        }
        else
        {
            result = testResetWatchdogTaskCheckInOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestAlarmStateOverrideRequest function handles a request to
 * override the active status of a given alarm.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestAlarmStateOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetAlarmStateOverride( payload.index, payload.state.u32 );
        }
        else
        {
            result = testResetAlarmStateOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestLoadCellOverrideRequest function handles a request to
 * override the value read from the given load cell.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestLoadCellOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetLoadCellOverride( payload.index, payload.state.f32 );
        }
        else
        {
            result = testResetLoadCellOverride( payload.index );
        }
    }

    //respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestTemperatureSensorsOverrideRequest function handles a
 * request to override a temperatures sensor's value.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestTemperatureSensorsOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetMeasuredTemperatureOverride( payload.index, payload.state.f32 );
        }
        else
        {
            result = testResetMeasuredTemperatureOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleTestTemperatureSensorsDataPublishOverrideRequest function handles
* a request to override the publish interval of temperature sensors data.
* @details
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleTestTemperatureSensorsDataPublishOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetTemperatureSensorsPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetTemperatureSensorsPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestHeatersDataPublishOverrideRequest function handles
 * a request to override the publish interval of heaters data.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestHeatersDataPublishOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetHeatersPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetHeatersPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestLoadCellDataBroadcastIntervalOverrideRequest function handles
 * a request to override the broadcast interval for load cell data.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestLoadCellDataBroadcastIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetLoadCellDataPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetLoadCellDataPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestPressureSensorOverrideRequest function handles a request to
 * override the value read from the given pressure sensor.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestPressureSensorOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetDGPressureSensorOverride( payload.index, payload.state.f32 );
        }
        else
        {
            result = testResetDGPressureSensorOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestPressureDataBroadcastIntervalOverrideRequest function handles
 * a request to override the broadcast interval for load cell data.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestPressureDataBroadcastIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetPressuresDataPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetPressuresDataPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}


/*********************************************************************//**
 * @brief
 * The handleTestROMeasuredFlowOverrideRequest function handles a request to
 * override the RO flow rate.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestROMeasuredFlowOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetMeasuredROFlowRateOverride( payload.state.f32 );
        }
        else
        {
            result = testResetMeasuredROFlowRateOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestROPumpDataBroadcastIntervalOverrideRequest function handles
 * a request to override the broadcast interval for RO pump data.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestROPumpDataBroadcastIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetROPumpDataPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetROPumpDataPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestSetDrainPumpRPM function handles a request to set the drain
 * pump speed set point (in RPM).
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestSetDrainPumpRPM( MESSAGE_T *message )
{
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( U32 ) == message->hdr.payloadLen )
    {
        U32 payLoad;

        memcpy( &payLoad, message->payload, sizeof( U32 ) );

        result = testSetTargetDrainPumpRPM( payLoad );
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestDrainPumpDataBroadcastIntervalOverrideRequest function handles
 * a request to override the broadcast interval for drain pump data.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestDrainPumpDataBroadcastIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof(TEST_OVERRIDE_PAYLOAD_T) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof(TEST_OVERRIDE_PAYLOAD_T) );
        if ( FALSE == payload.reset )
        {
            result = testSetDrainPumpDataPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetDrainPumpDataPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestValveStateOverrideRequest function handles a request to
 * override the state value read from the given valve.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestValveStateOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetValveStateOverride( payload.index, payload.state.u32 );
        }
        else
        {
            result = testResetValveStateOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestValvesStatesPublishIntervalOverrideRequest function handles
 * a request to override the publish interval of valves states from the given valve.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestValvesStatesPublishIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetValvesStatesPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetValvesStatesPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestDGSafetyShutdownOverrideRequest function handles a
 * request to override the safety shutdown signal.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestDGSafetyShutdownOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetSafetyShutdownOverride( payload.state.u32 );
        }
        else
        {
            result = testResetSafetyShutdownOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*************************************************************************
 * @brief
 * The handleSetDrainPumpTargetOutletPressure function handles a
 * request to set the drain pump outlet pressure.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleSetDrainPumpTargetOutletPressure( MESSAGE_T *message )
{
    BOOL result = 0;

    /* verify payload length */
    if ( sizeof( F32 ) == message->hdr.payloadLen )
    {
        F32 payLoad;

        memcpy( &payLoad, message->payload, sizeof( F32 ) );

        result = testSetTargetDrainPumpOutletPressure( payLoad );
    }
    /* respond to request */
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*************************************************************************
 * @brief
 * The handleSetSwitchesStatusOverrideRequest function handles a
 * request to override the status of a switch in DG.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleSetSwitchesStatusOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetSwitchesStatusOverride( payload.index, payload.state.u32 );
        }
        else
        {
            result = testResetSwitchesStatusOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*************************************************************************
 * @brief
 * The handleTestSwitchesPublishIntervalOverrideRequest function handles a
 * request to override the the switches data publish interval.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestSwitchesPublishIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetSwitchesDataPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetSwitchesDataPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestDGAccelOverrideRequest function handles a request to
 * override the measured accelerometer sensor readings.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestDGAccelOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetAccelAxisOverride( payload.index, payload.state.f32 );
        }
        else
        {
            result = testResetAccelAxisOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestDGAccelMaxOverrideRequest function handles a request to
 * override the measured accelerometer sensor maximum readings.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestDGAccelMaxOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetAccelMaxOverride( payload.index, payload.state.f32 );
        }
        else
        {
            result = testResetAccelMaxOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestDGAccelBroadcastIntervalOverrideRequest function handles a
 * request to override the broadcast interval for accelerometer data messages.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestDGAccelBroadcastIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetAccelDataPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetAccelDataPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestMonitoredVoltagesSendIntervalOverrideRequest function handles a
 * request to override the monitored DG voltages data publication interval.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message : a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestMonitoredVoltagesSendIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // Verify payload length
    if ( sizeof(TEST_OVERRIDE_PAYLOAD_T) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof(TEST_OVERRIDE_PAYLOAD_T) );
        if ( FALSE == payload.reset )
        {
            result = testSetVoltagesDataPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetVoltagesDataPublishIntervalOverride();
        }
    }

    // Respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestMonitoredVoltageOverrideRequest function handles a
 * request to override the monitored DG voltage override.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message : a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestMonitoredVoltageOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // Verify payload length
    if ( sizeof(TEST_OVERRIDE_ARRAY_PAYLOAD_T) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof(TEST_OVERRIDE_ARRAY_PAYLOAD_T) );
        if ( FALSE == payload.reset )
        {
            result = testSetLineLevelOverride( payload.index, payload.state.f32 );
        }
        else
        {
            result = testResetLineLevelOverride( payload.index );
        }
    }

    // Respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleTestSetConductivityOverrideRequest function handles a
 * request to override a conductivity sensor's value
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleTestSetConductivityOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetConductivityOverride( payload.index, payload.state.f32 );
        }
        else
        {
            result = testResetConductivityOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleTestSetConductivityDataPublishIntervalOverrideRequest function
* handles a request to override the publish interval of conductivity sensors data
* @details
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleTestSetConductivityDataPublishIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetConductivityDataPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetConductivityDataPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleStartStopUVReactors function handles a request to turn on/off
* the UV reactors.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleStartStopUVReactors( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );

        // Set turn on/off command
        switch ( payload.state.u32 )
        {
            case TURN_OFF:
                result = turnOffUVReactor( (UV_REACTORS_T)payload.index );
                break;

            case TURN_ON:
                result = turnOnUVReactor( (UV_REACTORS_T)payload.index );
                break;
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleTestUVReactorsDataPublishIntervalOverride function handles a
* request to override the publish interval of the UV reactors data
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleTestUVReactorsDataPublishIntervalOverride( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof(TEST_OVERRIDE_PAYLOAD_T) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof(TEST_OVERRIDE_PAYLOAD_T) );
        if ( FALSE == payload.reset )
        {
            result = testSetReactorsDataPublishInterval( payload.state.u32 );
        }
        else
        {
            result = testResetReactorsDataPublishInterval();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleUVReactorsHealthOverride function handles UV reactors health
* status override.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleTestUVReactorsHealthOverride( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof(TEST_OVERRIDE_ARRAY_PAYLOAD_T) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof(TEST_OVERRIDE_ARRAY_PAYLOAD_T) );
        if ( FALSE == payload.reset )
        {
            result = testSetUVReactorHealthOverride( payload.index, payload.state.u32 );
        }
        else
        {
            result = testResetUVReactorHealthOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleSetFluidLeakBroadcastIntervalOverrideRequest function handles a
 * request to override the fluid leak state broadcast interval.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message : a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleSetFluidLeakBroadcastIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // Verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetFluidLeakStatePublishIntervalOverride( (U32)( payload.state.u32 ) );
        }
        else
        {
            result = testResetFluidLeakStatePublishIntervalOverride();
        }
    }

    // Respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleSetFluidLeakStateDetectorOverrideRequest function handles a request to
 * override the fluid leak detector state.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message : a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleSetFluidLeakStateDetectorOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // Verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetFluidLeakStateOverride( ( FLUID_LEAK_STATES_T)( payload.state.u32 ) );
        }
        else
        {
            result = testResetFluidLeakStateOverride();
        }
    }

    // Respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleDGSoftwareResetRequest function handles a request to
 * perform a software reset on DG.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleDGSoftwareResetRequest( MESSAGE_T *message )
{
    BOOL result = FALSE;

    // verify payload length
    if ( 0 == message->hdr.payloadLen )
    {
        // tester must be logged in
        if ( TRUE == isTestingActivated() )
        {
            result = TRUE;                      // reset will prevent this from getting transmitted
            systemREG1->SYSECR = ( 0x2 << 14 ); // reset processor
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleConcentratePumpMeasuredSpeedOverride function handles a request
 * to override a concentrate pump measured speed value.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleConcentratePumpMeasuredSpeedOverride( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetConcentratePumpMeasuredSpeedOverride( payload.index, payload.state.f32 );
        }
        else
        {
            result = testResetConcentratePumpMeasuredSpeedOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleSetConcentratePumpTargetSpeed function handles a request to
 * override a concentrate pump's target speed value.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleSetConcentratePumpTargetSpeed( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        result = testSetConcentratePumpTargetSpeedOverride( payload.index, payload.state.f32 );
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleConcentratePumpStateChangeRequest function handles a request to
 * change the concentrate pumps' state.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleConcentratePumpStateChangeRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( ( sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) == message->hdr.payloadLen ) && ( TRUE == isTestingActivated() ) )
    {
        result = TRUE;

        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_ARRAY_PAYLOAD_T ) );
        if ( ( BOOL )payload.state.u32 )
        {
            requestConcentratePumpOn( ( CONCENTRATE_PUMPS_T )payload.index );
        }
        else
        {
            requestConcentratePumpOff( ( CONCENTRATE_PUMPS_T )payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleConcentratePumpPublishIntervalOverride function handles a request
 * to override a concentrate pump's publish interval value.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleConcentratePumpPublishIntervalOverride( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetConcentratePumpDataPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetConcentratePumpDataPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleTestThermistorsDataPublishIntervalOverride function handles a
* request to override the publish interval of the thermistors data.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleTestThermistorsDataPublishIntervalOverride( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetThermistorPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetThermistorPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleTestROPumpDutyCycleOverride function handles a request to override
* the RO pumps duty cycle.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleTestROPumpDutyCycleOverride( MESSAGE_T *message )
{
     BOOL result = FALSE;

     // verify payload length
     if ( sizeof( F32 ) == message->hdr.payloadLen )
     {
         F32 payLoad;

         memcpy( &payLoad, message->payload, sizeof( F32 ) );

         result = testSetTargetDutyCycle( payLoad );
     }

     // respond to request
     sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleTestThermistorsValueOverride function handles a request to
* override a thermistor's value.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleTestThermistorsValueOverride( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof(TEST_OVERRIDE_ARRAY_PAYLOAD_T) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof(TEST_OVERRIDE_ARRAY_PAYLOAD_T) );
        if ( FALSE == payload.reset )
        {
            result = testSetMeasuredThermistorOverride( payload.index, payload.state.f32 );
        }
        else
        {
            result = testResetMeasuredThermistorOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleTestROPumpTargetFlowOverride function handles a request to
* set the RO pump target flow.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleTestROPumpTargetFlowOverride( MESSAGE_T *message )
{
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( F32 ) == message->hdr.payloadLen )
    {
        F32 payload;

        memcpy( &payload, message->payload, sizeof( F32 ) );
        result = testSetTargetROPumpFlow( payload );
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleTestFansDataPublishIntervalOverride function handles a request
* to override the publish interval of the fans data
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleTestFansDataPublishIntervalOverride( MESSAGE_T * message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetFanPublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetFanPublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleSetDGOpModeBroadcastIntervalOverrideRequest function handles a request
* to override the publish interval of the DG operation mode.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleSetDGOpModeBroadcastIntervalOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetDGOpModePublishIntervalOverride( payload.state.u32 );
        }
        else
        {
            result = testResetDGOpModePublishIntervalOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleROPumpTargetPressureOverride function handles a request
* to override the RO pump target pressure.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleROPumpTargetPressureOverride( MESSAGE_T *message )
{
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( U32 ) == message->hdr.payloadLen )
    {
        U32 payload;

        memcpy( &payload, message->payload, sizeof( U32 ) );

        result = testSetTargetROPumpPressure( payload );

    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*************************************************************************
 * @brief
 * The handleStartStopDGHeatDisinfect function handles a request start or
 * stop DG heat disifect mode.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message: a pointer to the message to handle
 * @return result
 *************************************************************************/
BOOL handleStartStopDGHeatDisinfect( MESSAGE_T *message )
{
    BOOL status = FALSE;

    if ( message->hdr.payloadLen == sizeof(U32) )
    {
        BOOL startingDGHeatDisinfect;

        memcpy( &startingDGHeatDisinfect, message->payload, sizeof(U32) );

        if ( TRUE == startingDGHeatDisinfect )
        {
            status = startDGHeatDisinfect();
        }
        else
        {
            status = stopDGHeatDisinfect();
        }
    }

    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, status );

    return status;
}

/*********************************************************************//**
 * @brief
 * The handleUIClockSyncRequest function handles a UI clock sync message.
 * @details Inputs: none
 * @details Outputs: message handled, response constructed and queued for transmit.
 * @param messagePtr pointer to the message to handle.
 * @return none
 *************************************************************************/
void handleUIClockSyncRequest( MESSAGE_T *message )
{
    BOOL result = FALSE;
    U32 rejReason = REQUEST_REJECT_REASON_NONE;
    MESSAGE_T msg;
    U08 *payloadPtr = msg.payload;

    if ( message->hdr.payloadLen == sizeof( U32 ) )
    {
        U32 epoch;

        memcpy( &epoch,  message->payload, sizeof( U32 ) );
        result = setRTCEpoch( epoch );
        if ( FALSE == result )
        {
            rejReason = REQUEST_REJECT_REASON_INVALID_DATE_OR_TIME;
        }
    }
    else
    {
        rejReason = REQUEST_REJECT_REASON_INVALID_REQUEST_FORMAT;
    }

    // Create a response message record
    blankMessage( &msg );
    msg.hdr.msgID = MSG_ID_DG_UI_SET_RTC_RESPONSE;
    msg.hdr.payloadLen = sizeof( BOOL ) + sizeof( U32 );
    memcpy( payloadPtr, &result, sizeof( BOOL ) );
    payloadPtr += sizeof( BOOL );
    memcpy( payloadPtr, &rejReason, sizeof( U32 ) );

    // Serialize the message (w/ sync, CRC, and appropriate CAN padding) and add serialized message data to appropriate comm buffer
    result = serializeMessage( msg, COMM_BUFFER_OUT_CAN_DG_2_UI, ACK_REQUIRED );

    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_UI, result );
}

/*********************************************************************//**
* @brief
* The handleDGPOSTResultRequest function handles a request to report DG
* POST results.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleDGPOSTResultRequest( MESSAGE_T *message )
{
    BOOL status = FALSE;
    BOOL result = FALSE;
    U08* payloadPtr = message->payload;

    if ( 0 == message->hdr.payloadLen )
    {
        if ( TRUE == isPOSTCompleted() )
        {
            status = TRUE;
            if ( TRUE == isPOSTPassed() )
            {
                result = TRUE;
            }
            sendPOSTFinalResult( result );
        }
    }
    // If can't respond to request, NAK the message
    if ( status != TRUE )
    {
        sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, status );
    }
}

/*********************************************************************//**
* @brief
* The handleSetDGCalibrationRecord function handles a request to set the DG
* calibration data record.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleSetDGCalibrationRecord( MESSAGE_T *message )
{
    BOOL status = FALSE;
    U08* payloadPtr = message->payload;
    U32 currentMessage;
    U32 totalMessages;
    U32 payloadLength;

    memcpy(&currentMessage, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    memcpy(&totalMessages, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    memcpy(&payloadLength, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    status = setCalibrationRecord( currentMessage, totalMessages, payloadLength, payloadPtr );

    // Respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, status );
}

/*********************************************************************//**
* @brief
* The handleStartStopDGFlush function handles a request to start or stop
* DG flush mode.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
BOOL handleStartStopDGFlush( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof(U32) )
    {
        BOOL startingDGFlush;

        memcpy( &startingDGFlush, message->payload, sizeof(U32) );

        if ( TRUE == startingDGFlush )
        {
            result = startDGFlush();
        }
        else
        {
            result = stopDGFlush();
        }
    }

    // Respond to request
    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );

    return result;
}

/*********************************************************************//**
* @brief
* The handleGetDGCalibrationRecord function handles a request to get the DG
* calibration data record.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleGetDGCalibrationRecord( MESSAGE_T *message )
{
    BOOL result = FALSE;

    // verify payload length
    if ( 0 == message->hdr.payloadLen )
    {
        // Tester must be logged in
        if ( TRUE == isTestingActivated() )
        {
            result = getCalibrationRecord();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleSetDGSystemRecord function handles a request to set the DG
* system data record.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleSetDGSystemRecord( MESSAGE_T *message )
{
    BOOL status = FALSE;
    U08* payloadPtr = message->payload;
    U32 currentMessage;
    U32 totalMessages;
    U32 payloadLength;

    memcpy(&currentMessage, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    memcpy(&totalMessages, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    memcpy(&payloadLength, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    status = setSystemRecord( currentMessage, totalMessages, payloadLength, payloadPtr );

    // Respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, status );
}

/*********************************************************************//**
* @brief
* The handleGetDGSystemRecord function handles a request to get the DG
* system data record.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleGetDGSystemRecord( MESSAGE_T *message )
{
    BOOL result = FALSE;

    // verify payload length
    if ( 0 == message->hdr.payloadLen )
    {
        // Tester must be logged in
        if ( TRUE == isTestingActivated() )
        {
            result = getSystemRecord();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleGetDGServiceRecord function handles a request to get the DG
* service data record.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleGetDGServiceRecord( MESSAGE_T *message )
{
    BOOL result = FALSE;

    // verify payload length
    if ( 0 == message->hdr.payloadLen )
    {
        // Tester must be logged in
        if ( TRUE == isTestingActivated() )
        {
            result = getServiceRecord();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleSetDGServiceRecord function handles a request to set the DG
* service data record.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleSetDGServiceRecord( MESSAGE_T *message )
{
    BOOL status = FALSE;
    U08* payloadPtr = message->payload;
    U32 currentMessage;
    U32 totalMessages;
    U32 payloadLength;

    memcpy(&currentMessage, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    memcpy(&totalMessages, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    memcpy(&payloadLength, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    status = setServiceRecord( currentMessage, totalMessages, payloadLength, payloadPtr );

    // Respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, status );
}

/*********************************************************************//**
* @brief
* The handleGetDGServiceRecord function handles a request to get the DG
* scheduled runs data record.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleGetDGScheduledRunsRecord( MESSAGE_T *message )
{
    BOOL result = FALSE;

    // verify payload length
    if ( 0 == message->hdr.payloadLen )
    {
        // Tester must be logged in
        if ( TRUE == isTestingActivated() )
        {
            result = getScheduledRunsRecord();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleSetDGScheduledRunsRecord function handles a request to set the DG
* scheduled runs data record.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleSetDGScheduledRunsRecord( MESSAGE_T *message )
{
    BOOL status = FALSE;
    U08* payloadPtr = message->payload;
    U32 currentMessage;
    U32 totalMessages;
    U32 payloadLength;

    memcpy(&currentMessage, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    memcpy(&totalMessages, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    memcpy(&payloadLength, payloadPtr, sizeof(U32));
    payloadPtr += sizeof(U32);

    status = setScheduledRunsRecord( currentMessage, totalMessages, payloadLength, payloadPtr );

    // Respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, status );
}

/*********************************************************************//**
 * @brief
 * The handleFilterFlushTimePeriodOverride function handles a request
 * to override the filter flush time period value.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleFilterFlushTimePeriodOverride( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetFilterFlushTimePeriodOverride( payload.state.u32 );
        }
        else
        {
            result = testResetFilterFlushTimePeriodOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
 * @brief
 * The handleFansRPMOverride function handles a request to override a fans RPM value.
 * @details Inputs: none
 * @details Outputs: message handled
 * @param message a pointer to the message to handle
 * @return none
 *************************************************************************/
void handleFansRPMOverride( MESSAGE_T *message )
{
    TEST_OVERRIDE_ARRAY_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof(TEST_OVERRIDE_ARRAY_PAYLOAD_T) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof(TEST_OVERRIDE_ARRAY_PAYLOAD_T) );
        if ( FALSE == payload.reset )
        {
            result = testSetFanRPMOverride( payload.index, payload.state.f32 );
        }
        else
        {
            result = testResetFanRPMOverride( payload.index );
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleStopDGRTCClock function handles a request to stop the RTC clock.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleStopDGRTCClock( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( 0 == message->hdr.payloadLen )
    {
        testSetStopRTC();
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleSetDrainPumpMeasuredRPMOverrideRequest function handles a request
* to override the drain pump measured RPM.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
void handleSetDrainPumpMeasuredRPMOverrideRequest( MESSAGE_T *message )
{
    TEST_OVERRIDE_PAYLOAD_T payload;
    BOOL result = FALSE;

    // verify payload length
    if ( sizeof( TEST_OVERRIDE_PAYLOAD_T ) == message->hdr.payloadLen )
    {
        memcpy( &payload, message->payload, sizeof( TEST_OVERRIDE_PAYLOAD_T ) );
        if ( FALSE == payload.reset )
        {
            result = testSetDrainPumpMeasuredRPMOverride( payload.state.u32 );
        }
        else
        {
            result = testResetDrainPumpMeasuredRPMOverride();
        }
    }

    // respond to request
    sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result );
}

/*********************************************************************//**
* @brief
* The handleStartStopDGChemicalDisinfect function handles a request to start
* or stop DG chemical disinfect mode.
* @details Inputs: none
* @details Outputs: message handled
* @param message a pointer to the message to handle
* @return none
*************************************************************************/
BOOL handleStartStopDGChemicalDisinfect( MESSAGE_T *message )
{
    BOOL result = FALSE;

    if ( message->hdr.payloadLen == sizeof(U32) )
    {
        BOOL startingDGChemicalDisinfect;

        memcpy( &startingDGChemicalDisinfect, message->payload, sizeof(U32) );

        if ( TRUE == startingDGChemicalDisinfect )
        {
            result = startDGChemicalDisinfect();
        }
        else
        {
            result = stopChemicalDisinfect();
        }
    }

    // Respond to request
    sendAckResponseMsg( (MSG_ID_T)message->hdr.msgID, COMM_BUFFER_OUT_CAN_DG_2_HD, result );

    return result;
}

/**@}*/