/**************************************************************************
*
* 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 Prime.h
*
* @author (last) Quang Nguyen
* @date (last) 08-Dec-2020
*
* @author (original) Quang Nguyen
* @date (original) 08-Dec-2020
*
***************************************************************************/

#ifndef __PRIME_H__
#define __PRIME_H__

#include "HDCommon.h"
#include "HDDefs.h"

/**
 *  @defgroup Prime Prime
 *  @brief Prime sub-mode of pre-treatment mode. This sub-mode handles blood and dialysate circuits priming functionality.
 *
 *  @addtogroup Prime
 *  @{
 */

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

#pragma pack(push,1)

/// Payload record structure for a priming status data broadcast message.
typedef struct
{
    U32 currentPrimeState;      ///< Current state of priming.
    U32 remainingTime;          ///< Remaining time for priming in seconds.
    U32 totalTime;              ///< Total priming time in seconds.
} PRIMING_DATA_PAYLOAD_T;

#pragma pack(pop)

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

void initPrime( void );
void transitionToPrime( void );

void execPrime( void );
BOOL isWetSelfTestsPassed( void );
void signalAlarmActionToPrimeMode( ALARM_ACTION_T action );

/**@}*/

#endif