Index: firmware/App/Modes/FlushConcentrate.h =================================================================== diff -u -r410afd26b3ae5e372310c696c82f58c59235e10d -r8d272582cbd2cb5fc0c6af0fead2867ce02658b0 --- firmware/App/Modes/FlushConcentrate.h (.../FlushConcentrate.h) (revision 410afd26b3ae5e372310c696c82f58c59235e10d) +++ firmware/App/Modes/FlushConcentrate.h (.../FlushConcentrate.h) (revision 8d272582cbd2cb5fc0c6af0fead2867ce02658b0) @@ -1,15 +1,56 @@ -/* - * FlushConcentrate.h +/************************************************************************** +* +* Copyright (c) 2024-2025 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 FlushConcentrate.h +* +* @author (last) Michael Garthwaite +* @date (last) 03-Mar-2025 +* +* @author (original) Michael Garthwaite +* @date (original) 03-Mar-2025 +* +***************************************************************************/ + +#ifndef __FLUSH_CONCENTRATE_H__ +#define __FLUSH_CONCENTRATE_H_ + +#include "FPCommon.h" +#include "FPDefs.h" + +/** + * @defgroup FPConcentrateFlush FPConcentrateFlush + * @brief Concentrate Flush unit. Manages Concentrate flush functions via a state machine. * - * Created on: Jul 2, 2025 - * Author: fw + * @addtogroup FPConcentrateFlush + * @{ */ -#ifndef APP_MODES_FLUSHCONCENTRATE_H_ -#define APP_MODES_FLUSHCONCENTRATE_H_ +// ********** public definitions ********** +/// Concentrate Flush data structure +typedef struct +{ + U32 concentrateFlushExecState; ///< Concentrate Flush execution state +} CONC_FLUSH_DATA_T; +// ********** public function prototypes ********** +void initConcentrateFlush( void ); // Initialize this Concentrate Flush unit +U32 transitionToConcentrateFlush( void ); // Transition to Concentrate Flush +void execConcentrateFlush( void ); // Execute the Concentrate Flush state machine +BOOL isConcentrateFlushComplete( void ); // returns if flush is complete +void signalStartConcentrateFlush( void ); // signal to start flush +void resetConcentrateFlushSignals( void ); // reset signals for flush +FP_CONC_FLUSH_STATE_T getCurrentConcentrateFlushState( void ); // Get the current state of the Concentrate Flush -#endif /* APP_MODES_FLUSHCONCENTRATE_H_ */ +BOOL testConcentrateFlushDataPublishIntervalOverride( MESSAGE_T *message ); +BOOL testConcentrateFlushTimerOverride( MESSAGE_T *message ); +/**@}*/ + + +#endif