/**************************************************************************
*
* Copyright (c) 2024-2024 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    StateTxPaused.h
*
* @author  (last)      Sean
* @date    (last)      18-Apr-2025
*
* @author  (original)  Sean
* @date    (original)  18-Apr-2025
*
***************************************************************************/

#ifndef __STATE_TX_PAUSED_H__
#define __STATE_TX_PAUSED_H__

#include "TDCommon.h"
#include "TDDefs.h"

/**
 *  @defgroup StateTxPaused StateTxPaused
 *  @brief Treatment Paused state unit.
 *
 *  @addtogroup StateTxPaused
 *  @{
 */

// ********** 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_PAUSED_PAYLOAD_T;

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

void initTreatmentPaused( void );                               // Initialize this unit
void transitionToTreatmentPaused( void );                       // Prepares for transition to treatment paused state
void execTreatmentPaused( void );                               // Execute the treatment paused state machine

TREATMENT_PAUSED_STATE_T getCurrentTreatmentPausedState( void );// Get current treatment paused state

/**@}*/

#endif