/**************************************************************************
*
* Copyright (c) 2020-2022 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    TreatmentStop.h
*
* @author  (last)      Sean Nash
* @date    (last)      12-Nov-2021
*
* @author  (original)  Sean
* @date    (original)  15-Jan-2020
*
***************************************************************************/

#ifndef __TREATMENT_STOP_H__
#define __TREATMENT_STOP_H__

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

/**
 *  @defgroup TreatmentStop TreatmentStop
 *  @brief Treatment stop sub-mode of treatment mode.
 *  The treatment stop state is where operational control goes when an alarm
 *  stops (pauses) treatment.  From this state the user may resume treatment,
 *  initiate a rinseback, or end the treatment.
 *
 *  @addtogroup TreatmentStop
 *  @{
 */

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

/// Payload record for treatment stop mode broadcast message
typedef struct
{
    U32 timeout;                            ///< Blood sitting timeout (in seconds)
    U32 countdown;                          ///< Blood sitting timeout countdown (in seconds)
} TREATMENT_STOP_PAYLOAD_T;

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

void initTreatmentStop( void );
void transitionToTreatmentStop( void );
void execTreatmentStop( void );

TREATMENT_STOP_STATE_T getCurrentTreatmentStopState( void );

BOOL testSetTreatmentStopPublishIntervalOverride( U32 ms );
BOOL testResetTreatmentStopPublishIntervalOverride( void );

/**@}*/

#endif