Index: firmware/App/Modes/ModeStandby.h =================================================================== diff -u -reff7b1575f008f81b29ef906f6346fac6012d3ab -r8e7158d8231435496fcf1d5649e51babf859ccc7 --- firmware/App/Modes/ModeStandby.h (.../ModeStandby.h) (revision eff7b1575f008f81b29ef906f6346fac6012d3ab) +++ firmware/App/Modes/ModeStandby.h (.../ModeStandby.h) (revision 8e7158d8231435496fcf1d5649e51babf859ccc7) @@ -1,26 +1,42 @@ /************************************************************************** - * - * 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 ModeStandby.h - * - * @date 19-Sep-2019 - * @author S. Nash - * - * @brief Header file for Standby Mode. - * - **************************************************************************/ +* +* Copyright (c) 2019-2021 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 ModeStandby.h +* +* @author (last) Sean Nash +* @date (last) 26-Aug-2020 +* +* @author (original) Dara Navaei +* @date (original) 05-Nov-2019 +* +***************************************************************************/ #ifndef __MODE_STANDBY_H__ #define __MODE_STANDBY_H__ -// ********** private function prototypes ********** +#include "HDCommon.h" +#include "HDDefs.h" -void initStandbyMode( void ); // initialize this module -void transitionToStandbyMode( void ); // prepares for transition to standby mode -void execStandbyMode( void ); // execute the standby mode state machine (call from OperationModes) +/** + * @defgroup HDStandbyMode HDStandbyMode + * @brief StandbyMode module. + * + * @addtogroup HDStandbyMode + * @{ + */ +// ********** public function prototypes ********** + +void initStandbyMode( void ); // initialize this module +void transitionToStandbyMode( void ); // prepares for transition to standby mode +U32 execStandbyMode( void ); // execute the standby mode state machine (call from OperationModes) + +BOOL signalUserStartingTreatment( void ); // User has initiated a treatment - go to treatment parameters mode + +/**@}*/ + #endif