/**************************************************************************
*
* Copyright (c) 2025-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    TubeSetInstall.h
*
* @author  (last)      Praneeth Bunne
* @date    (last)      28-Apr-2026
*
* @author  (original)  Praneeth Bunne
* @date    (original)  28-Apr-2026
*
***************************************************************************/

#ifndef __TUBE_SET_INSTALL_H__
#define __TUBE_SET_INSTALL_H__

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

/**
 *  @defgroup TubeSetInstall TubeSetInstall
 *  @brief The TubeSetInstall provide services to
 *  Pre-Treatment and Treatment modes.
 *
 *  @addtogroup TubeSetInstall
 *  @{
 */

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

/// Enumeration of  Tube Set install sub-states.
enum Tube_Set_Install_States
{
    TUBE_SET_INSTALL_STATE_AWAIT_TUBE_SET_CONFIRMATION = 0,         // Awaiting user confirmation that tubeset is placed.
    TUBE_SET_INSTALL_STATE_AUTO_LOAD,                               // Auto-Load the tubeset state
    TUBE_SET_INSTALL_STATE_AUTO_LOAD_BACK_OFF,                      // Auto-Load Back-off state
    NUM_OF_TUBE_SET_INSTALL_SUB_STATES,                             // Num of install sub-states
};
/// Type for tube set install states enumeration
typedef enum Tube_Set_Install_States TUBE_SET_INSTALL_STATE_T;

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

void initTubeSetInstall( void );                                    // Initialize this service
void execTubeSetInstall( void );                                    // Execute the service state machine (call from ModePreTreat and ModeTreatment)

BOOL isTubeSetInstallComplete( void );                              // Returns True once auto-load finished successfully
BOOL handleAutoLoadRequest( MESSAGE_T *message );                   // Handle UI auto-load confirmation request

/**@}*/

#endif