/**************************************************************************
*
* Copyright (c) 2019-2021 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    TreatmentRecirc.h
*
* @author  (last)      Sean Nash
* @date    (last)      18-Feb-2021
*
* @author  (original)  Sean Nash
* @date    (original)  20-Jan-2021
*
***************************************************************************/

#ifndef __TREATMENT_RECIRC_H__
#define __TREATMENT_RECIRC_H__

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

/**
 *  @defgroup TreatmentRecirculate TreatmentRecirculate
 *  @brief Treatment recirculate sub-mode of treatment mode.
 *  The treatment re-circulate state manages saline and dialysate re-circulation
 *  during patient breaks while patient is not connected to the system.
 *
 *  @addtogroup TreatmentRecirculate
 *  @{
 */

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

/// Payload record structure for treatment recirculate mode data broadcast message
typedef struct
{
    U32 timeout;                            ///< Recirculation timeout time (in seconds)
    U32 countdown;                          ///< Recirculation timeout countdown (in seconds)
} TREATMENT_RECIRC_PAYLOAD_T;

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

void initTreatmentRecirc( void );
void transitionToTreatmentRecirc( void );
void execTreatmentRecirc( void );

void signalTreatmentRecircUserAction( REQUESTED_TREATMENT_RECIRC_USER_ACTIONS_T action );   // from user
TREATMENT_RECIRC_STATE_T getCurrentTreatmentRecircState( void );

/**@}*/

#endif