Index: firmware/App/Controllers/DialOutFlow.h =================================================================== diff -u -ra74a984a7059f75d86ad87d6d9499bd8f94cc976 -r7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717 --- firmware/App/Controllers/DialOutFlow.h (.../DialOutFlow.h) (revision a74a984a7059f75d86ad87d6d9499bd8f94cc976) +++ firmware/App/Controllers/DialOutFlow.h (.../DialOutFlow.h) (revision 7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -19,27 +19,39 @@ #include "Common.h" +/** + * @defgroup DialysateOutlet DialysateOutlet + * @brief Dialysate outlet pump and load cells controller/monitor module. + * Monitors the dialysate outlet pump and load cells. Controls the dialysate + * outlet pump for ultrafiltration. + * + * @addtogroup DialysateOutlet + * @{ + */ + // ********** public definitions ********** +/// Enumeration of load cell sensors. typedef enum Load_Cells { - LOAD_CELL_RESERVOIR_1_PRIMARY = 0, - LOAD_CELL_RESERVOIR_1_BACKUP, - LOAD_CELL_RESERVOIR_2_PRIMARY, - LOAD_CELL_RESERVOIR_2_BACKUP, - NUM_OF_LOAD_CELLS + LOAD_CELL_RESERVOIR_1_PRIMARY = 0, ///< Primary load cell for reservoir 1. + LOAD_CELL_RESERVOIR_1_BACKUP, ///< Backup load cell for reservoir 1. + LOAD_CELL_RESERVOIR_2_PRIMARY, ///< Primary load cell for reservoir 2. + LOAD_CELL_RESERVOIR_2_BACKUP, ///< Backup load cell for reservoir 2. + NUM_OF_LOAD_CELLS ///< # of load cell sensors. } LOAD_CELL_T; #pragma pack(push, 1) +/// Dialysate outlet pump broadcast record typedef struct DialOutBroadcastingRecord { - F32 refUFVolMl; - F32 measUFVolMl; - F32 measRotSpdRPM; - F32 measSpdRPM; - F32 measMCSpdRPM; - F32 measMCCurrmA; - F32 setPWMpct; + F32 refUFVolMl; ///< Reference ultrafiltration volume in mL. + F32 measUFVolMl; ///< Total measured ultrafiltration volume in mL. + F32 measRotSpdRPM; ///< Latest measured rotor speed for dialysate outlet pump in RPM. + F32 measSpdRPM; ///< Latest measured motor speed for dialysate outlet pump in RPM. + F32 measMCSpdRPM; ///< Latest measured motor controller speed for dialysate outlet pump in RPM. + F32 measMCCurrmA; ///< Latest measured motor controller current for dialysate outlet pump in mA. + F32 setPWMpct; ///< Latest PWM duty cycle for dialysate outlet pump in % (0..100). } DIAL_OUT_FLOW_DATA_T; #pragma pack(pop) @@ -83,5 +95,7 @@ BOOL testSetDialOutLoadCellWeightOverride( U32 sensor, F32 value ); BOOL testResetDialOutLoadCellWeightOverride( U32 sensor ); +/**@}*/ + #endif