Index: firmware/App/Controllers/PresOccl.h =================================================================== diff -u -r07a5add2dff254f7be3699e4efac2b99d3554847 -r55a6adaf81175d25c1d9cc4c96d7dfda84eede16 --- firmware/App/Controllers/PresOccl.h (.../PresOccl.h) (revision 07a5add2dff254f7be3699e4efac2b99d3554847) +++ firmware/App/Controllers/PresOccl.h (.../PresOccl.h) (revision 55a6adaf81175d25c1d9cc4c96d7dfda84eede16) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2020 Diality Inc. - All Rights Reserved. * @@ -19,20 +19,31 @@ #include "Common.h" +/** + * @defgroup PressureOcclusion PressureOcclusion + * @brief Pressure & Occlusion controller/monitor module. Monitors the + * blood line pressure sensors and pump occlusion sensors. + * + * @addtogroup PressureOcclusion + * @{ + */ + // ********** public definitions ********** +// Pressure sensors monitored by this module typedef enum PressureSensors { - PRESSURE_SENSOR_ARTERIAL = 0, - PRESSURE_SENSOR_VENOUS, + PRESSURE_SENSOR_ARTERIAL = 0, /// arterial blood line pressure sensor + PRESSURE_SENSOR_VENOUS, /// vensous blood line pressure sensor NUM_OF_PRESSURE_SENSORS } PRESSURE_SENSORS_T; +// Occlusion sensors monitored by this module typedef enum OcclusionSensors { - OCCLUSION_SENSOR_BLOOD_PUMP = 0, - OCCLUSION_SENSOR_DIAL_IN_PUMP, - OCCLUSION_SENSOR_DIAL_OUT_PUMP, + OCCLUSION_SENSOR_BLOOD_PUMP = 0, /// blood pump occlusion sensor + OCCLUSION_SENSOR_DIAL_IN_PUMP, /// dialysate inlet pump occlusion sensor + OCCLUSION_SENSOR_DIAL_OUT_PUMP, /// dialysate outlet pump occlusion sensor NUM_OF_OCCLUSION_SENSORS } OCCLUSION_SENSORS_T; @@ -65,4 +76,6 @@ BOOL testSetDialOutPumpOcclusionOverride( F32 value ); BOOL testResetDialOutPumpOcclusionOverride( void ); +/**@}*/ + #endif