/**************************************************************************
*
* Copyright (c) 2026-2026 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    StatePreTxRecirculate.h
*
* @author  (last)      Vijay Pamula
* @date    (last)      02-June-2026
*
* @author  (original)  Vijay Pamula
* @date    (original)  02-June-2026
*
***************************************************************************/

#ifndef __STATE_PRE_TX_RECIRCULATE_H__
#define __STATE_PRE_TX_RECIRCULATE_H__

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

/**
 *  @defgroup StatePreTxRecirculate StatePreTxRecirculate
 *  @brief Pre-treatment recirculation state unit. This state runs the blood
 *  pump at a fixed recirculation flow rate with the arterial and venous pinch
 *  valves open, commands dialyzer bypass, and requests fixed dialysate flow
 *  while waiting to proceed from pre-treatment.
 *
 *  @addtogroup StatePreTxRecirculate
 *  @{
 */

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

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

void initPreTxRecirculate( void );                          // Initialize this unit
void transitionToPreTxRecirculate( void );                  // Prepares for transition to pre-treatment recirculation state
void execPreTxRecirculate( void );                          // Execute the pre-treatment recirculation state machine

U32 getPreTxRecirculateState( void );                       // Gets current pre-treatment recirculation state
void signalResumePreTxRecirculate( void );                  // Signal resume request for pre-treatment recirculation

/**@}*/

#endif