Index: firmware/App/Modes/OperationModes.h =================================================================== diff -u -reff7b1575f008f81b29ef906f6346fac6012d3ab -r8e7158d8231435496fcf1d5649e51babf859ccc7 --- firmware/App/Modes/OperationModes.h (.../OperationModes.h) (revision eff7b1575f008f81b29ef906f6346fac6012d3ab) +++ firmware/App/Modes/OperationModes.h (.../OperationModes.h) (revision 8e7158d8231435496fcf1d5649e51babf859ccc7) @@ -1,44 +1,43 @@ /************************************************************************** - * - * 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 OperationModes.h - * - * @date 19-Sep-2019 - * @author S. Nash - * - * @brief Header file for Operation Modes. - * - **************************************************************************/ +* +* 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 OperationModes.h +* +* @author (last) Sean Nash +* @date (last) 05-Nov-2020 +* +* @author (original) Dara Navaei +* @date (original) 05-Nov-2019 +* +***************************************************************************/ #ifndef __OP_MODES_H__ #define __OP_MODES_H__ -// ********** public definitions ********** +#include "HDCommon.h" +#include "HDDefs.h" -typedef enum Op_Modes // These are in order of priority (highest to lowest) -{ - MODE_FAUL = 0, // Fault - MODE_SERV, // Service - MODE_INIT, // Initialization & POST - MODE_STAN, // Standby - MODE_PRES, // Prescription - MODE_OPAR, // Operating Parameters - MODE_PRET, // Pre-Treatment - MODE_TREA, // Treatment - MODE_POST, // Post-Treatment - MODE_NLEG, // Not legal - NUM_OF_MODES -} OP_MODE; +/** + * @defgroup HDOperationModes HDOperationModes + * @brief Operation Modes module. + * + * @addtogroup HDOperationModes + * @{ + */ +// ********** public definitions ********** + // ********** public function prototypes ********** -void initOperationModes( void ); // initialize this module -void execOperationModes( void ); // execute the operation modes state machine (scheduled periodic call) -void requestNewOperationMode( OP_MODE newMode ); // request a transition to a new operation mode -OP_MODE getCurrentOperationMode( void ); // get the current operation mode +void initOperationModes( void ); // initialize this module +void execOperationModes( void ); // execute the operation modes state machine (scheduled periodic call) +void requestNewOperationMode( HD_OP_MODE_T newMode ); // request a transition to a new operation mode +HD_OP_MODE_T getCurrentOperationMode( void ); // get the current operation mode +/**@}*/ + #endif