Index: firmware/App/Controllers/DialInFlow.h =================================================================== diff -u -r054fa08b67ed2a31f7848b179fbcd1b4da501b0f -r4ebc1f7e1aeb3a332e91fcdd1bbbe1a01873d93a --- firmware/App/Controllers/DialInFlow.h (.../DialInFlow.h) (revision 054fa08b67ed2a31f7848b179fbcd1b4da501b0f) +++ firmware/App/Controllers/DialInFlow.h (.../DialInFlow.h) (revision 4ebc1f7e1aeb3a332e91fcdd1bbbe1a01873d93a) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -19,10 +19,19 @@ #include "HDCommon.h" +/** + * @defgroup DialysateInletFlow DialysateInletFlow + * @brief Dialysate Inlet Pump & Dialysate Flow controller/monitor module. + * Monitors the dialysate flow rate and controls the dialysate inlet pump. + * + * @addtogroup DialysateInletFlow + * @{ + */ + // ********** public definitions ********** -#define MAX_DIAL_IN_FLOW_RATE 600 // mL/min -#define MIN_DIAL_IN_FLOW_RATE 100 // mL/min +#define MAX_DIAL_IN_FLOW_RATE 600 ///< Maximum dialysate inlet flow rate (in mL/min). +#define MIN_DIAL_IN_FLOW_RATE 100 ///< Minimum dialysate inlet flow rate (in mL/min). // ********** public function prototypes ********** @@ -32,6 +41,8 @@ BOOL setDialInPumpTargetFlowRate( U32 flowRate, MOTOR_DIR_T dir, PUMP_CONTROL_MODE_T mode ); void signalDialInPumpHardStop( void ); +void signalDialInPumpRotorHallSensor( void ); +BOOL homeDialInPump( void ); SELF_TEST_STATUS_T execDialInFlowTest( void ); @@ -57,4 +68,6 @@ BOOL testSetMeasuredDialInPumpMCCurrentOverride( F32 value ); BOOL testResetMeasuredDialInPumpMCCurrentOverride( void ); +/**@}*/ + #endif