Index: firmware/App/Controllers/BloodFlow.h =================================================================== diff -u -r054fa08b67ed2a31f7848b179fbcd1b4da501b0f -r9d4666bf3064df18a6d935125d7a69e4e8234e84 --- firmware/App/Controllers/BloodFlow.h (.../BloodFlow.h) (revision 054fa08b67ed2a31f7848b179fbcd1b4da501b0f) +++ firmware/App/Controllers/BloodFlow.h (.../BloodFlow.h) (revision 9d4666bf3064df18a6d935125d7a69e4e8234e84) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -19,10 +19,19 @@ #include "HDCommon.h" +/** + * @defgroup BloodFlow BloodFlow + * @brief Blood Pump & Blood Flow controller/monitor module. Monitors the + * blood flow rate and controls the blood pump. + * + * @addtogroup BloodFlow + * @{ + */ + // ********** public definitions ********** -#define MAX_BLOOD_FLOW_RATE 500 // mL/min -#define MIN_BLOOD_FLOW_RATE 100 // mL/min +#define MAX_BLOOD_FLOW_RATE 500 ///< Maximum blood flow rate (in mL/min). +#define MIN_BLOOD_FLOW_RATE 100 ///< Minimum blood flow rate (in mL/min). // ********** public function prototypes ********** @@ -32,6 +41,8 @@ BOOL setBloodPumpTargetFlowRate( U32 flowRate, MOTOR_DIR_T dir, PUMP_CONTROL_MODE_T mode ); void signalBloodPumpHardStop( void ); +void signalBloodPumpRotorHallSensor( void ); +BOOL homeBloodPump( void ); SELF_TEST_STATUS_T execBloodFlowTest( void ); @@ -57,4 +68,6 @@ BOOL testSetMeasuredBloodPumpMCCurrentOverride( F32 value ); BOOL testResetMeasuredBloodPumpMCCurrentOverride( void ); +/**@}*/ + #endif