Index: firmware/App/Modes/ModePreTreat.h =================================================================== diff -u -reb877ae36c28eb83553ee11ccccf42e2c4a5b4d2 -r6eef422e39bed332f9958b165f8e64a23185a170 --- firmware/App/Modes/ModePreTreat.h (.../ModePreTreat.h) (revision eb877ae36c28eb83553ee11ccccf42e2c4a5b4d2) +++ firmware/App/Modes/ModePreTreat.h (.../ModePreTreat.h) (revision 6eef422e39bed332f9958b165f8e64a23185a170) @@ -1,26 +1,71 @@ /************************************************************************** - * - * Copyright (c) 2019-2019 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 ModePreTreat.h - * - * @date 19-Sep-2019 - * @author S. Nash - * - * @brief Header file for Pre-Treatment Mode. - * - **************************************************************************/ +* +* Copyright (c) 2019-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 ModePreTreat.h +* +* @author (last) Dara Navaei +* @date (last) 12-Nov-2021 +* +* @author (original) Dara Navaei +* @date (original) 05-Nov-2019 +* +***************************************************************************/ #ifndef __MODE_PRE_TREAT_H__ #define __MODE_PRE_TREAT_H__ -// ********** private function prototypes ********** +#include "HDCommon.h" +#include "HDDefs.h" +#include "DGDefs.h" -void initPreTreatmentMode( void ); // initialize this module -void transitionToPreTreatmentMode( void ); // prepares for transition to pre-treatment mode -void execPreTreatmentMode( void ); // execute the pre-treatment mode state machine (call from OperationModes) +/** + * @defgroup HDPreTreatmentMode HDPreTreatmentMode + * @brief Pre-TreatmentMode module. + * + * @addtogroup HDPreTreatmentMode + * @{ + */ +// ********** public definitions ********** + +/// Payload record structure for a pre-treatment state message. +typedef struct +{ + U32 preTreatmentSubMode; ///< Current pre-treatment sub-mode + U32 sampleWaterState; ///< Current sample water state + U32 consumableSelfTestsState; ///< Current consumable sefl-tests state + U32 noCartSelfTestsState; ///< Current no cartridge self-tests state + U32 installState; ///< Current disposable installation state + U32 drySelfTestsState; ///< Current dry self-tests state + U32 primeState; ///< Current prime state + U32 recircState; ///< Current re-circulate state + U32 patientConnectionState; ///< Current patient connection state +} PRE_TREATMENT_STATE_DATA_T; + +// ********** public function prototypes ********** + +void initPreTreatmentMode( void ); // Initialize this module +U32 transitionToPreTreatmentMode( void ); // Prepares for transition to pre-treatment mode +U32 execPreTreatmentMode( void ); // Execute the pre-treatment mode state machine (call from OperationModes) + +void signalUserConfirmInstallation( void ); // Signal that user confirms disposable has been installed +void signalUserContinueToTreatment( void ); // Signal that user requests to continue to treatment +void setUserSetUFVolumeStatus( BOOL status ); // Set status that indicates UF volume setting has been set +void signalUserConfirmPatientConnection( void ); // Signal that user confirms patient connection has been completed +void signalUserStartTreatment( void ); // Signal that user requests to start treatment + +void signalAlarmActionToPreTreatmentMode( ALARM_ACTION_T action ); // Execute alarm action as appropriate for pre-treatment mode + +BOOL getReservoirFillStatus( DG_RESERVOIR_ID_T reservoirID ); // Get the fill complete status for given reservoir +HD_PRE_TREATMENT_MODE_STATE_T getPreTreatmentSubState( void ); // Get the current pre-treatment sub mode. + +BOOL testSetPreTreatmentModePublishIntervalOverride( U32 ms ); +BOOL testResetPreTreatmentModePublishIntervalOverride( void ); + +/**@}*/ + #endif