Index: firmware/App/Controllers/DialOutFlow.c =================================================================== diff -u -r7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717 -r926afe9b1d9cc6931cbca48080e4a66385a20239 --- firmware/App/Controllers/DialOutFlow.c (.../DialOutFlow.c) (revision 7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717) +++ firmware/App/Controllers/DialOutFlow.c (.../DialOutFlow.c) (revision 926afe9b1d9cc6931cbca48080e4a66385a20239) @@ -80,7 +80,7 @@ DIAL_OUT_PUMP_RAMPING_UP_STATE, ///< Ramping up state of the dialysate outlet pump state machine. DIAL_OUT_PUMP_RAMPING_DOWN_STATE, ///< Ramping down state of the dialysate outlet pump state machine. DIAL_OUT_PUMP_CONTROL_TO_TARGET_STATE, ///< Control state of the dialysate outlet pump state machine. - NUM_OF_DIAL_OUT_PUMP_STATES ///< # of dialysate outlet pump control states. + NUM_OF_DIAL_OUT_PUMP_STATES ///< Number of dialysate outlet pump control states. } DIAL_OUT_PUMP_STATE_T; /// Enumeration of dialysate outlet pump self test states. @@ -89,7 +89,7 @@ DIAL_OUT_PUMP_SELF_TEST_STATE_START = 0, ///< Start state of the dialysate outlet pump self test state machine. DIAL_OUT_PUMP_TEST_STATE_IN_PROGRESS, ///< In progress state of the dialysate outlet pump self test state machine. DIAL_OUT_PUMP_TEST_STATE_COMPLETE, ///< Completed state of the dialysate outlet pump self test state machine. - NUM_OF_DIAL_OUT_PUMP_SELF_TEST_STATES ///< # of dialysate outlet pumpt self test states. + NUM_OF_DIAL_OUT_PUMP_SELF_TEST_STATES ///< Number of dialysate outlet pumpt self test states. } DIAL_OUT_PUMP_SELF_TEST_STATE_T; // pin assignments and macros for pump stop and direction outputs @@ -156,7 +156,6 @@ * @details * Inputs : none * Outputs : DialOutFlow module initialized. - * @param none * @return none *************************************************************************/ void initDialOutFlow( void ) @@ -278,7 +277,6 @@ * @details * Inputs : none * Outputs : Dialysate outlet pump stopped, set point reset, state changed to off - * @param none * @return none *************************************************************************/ void signalDialOutPumpHardStop( void ) @@ -320,7 +318,6 @@ * @details * Inputs : latest sensor data * Outputs : dialOutPumpMCSpeedRPM, dialOutPumpMCCurrentmA - * @param none * @return none *************************************************************************/ void execDialOutFlowMonitor( void ) @@ -343,7 +340,6 @@ * @details * Inputs : dialOutPumpState * Outputs : dialOutPumpState - * @param none * @return none *************************************************************************/ void execDialOutFlowController( void ) @@ -379,7 +375,6 @@ * @details * Inputs : targetDialOutFlowRate, dialOutPumpDirection * Outputs : dialOutPumpPWMDutyCyclePctSet, dialOutPumpDirectionSet, isDialOutPumpOn - * @param none * @return next state *************************************************************************/ static DIAL_OUT_PUMP_STATE_T handleDialOutPumpOffState( void ) @@ -413,7 +408,6 @@ * @details * Inputs : dialOutPumpPWMDutyCyclePctSet * Outputs : dialOutPumpPWMDutyCyclePctSet - * @param none * @return next state *************************************************************************/ static DIAL_OUT_PUMP_STATE_T handleDialOutPumpRampingUpState( void ) @@ -458,7 +452,6 @@ * @details * Inputs : dialOutPumpPWMDutyCyclePctSet * Outputs : dialOutPumpPWMDutyCyclePctSet - * @param none * @return next state *************************************************************************/ static DIAL_OUT_PUMP_STATE_T handleDialOutPumpRampingDownState( void ) @@ -501,7 +494,6 @@ * @details * Inputs : dopControlTimerCounter, dialOutPumpControlModeSet, volumes. * Outputs : dopControlTimerCounter, pump controlled. - * @param none * @return next state *************************************************************************/ static DIAL_OUT_PUMP_STATE_T handleDialOutPumpControlToTargetState( void ) @@ -549,7 +541,6 @@ * @details * Inputs : none * Outputs : dialOut pump stop signal activated, PWM duty cycle zeroed - * @param none * @return none *************************************************************************/ static void stopDialOutPump( void ) @@ -566,7 +557,6 @@ * @details * Inputs : none * Outputs : dialysate outlet pump stop signal is cleared. - * @param none * @return none *************************************************************************/ static void releaseDialOutPumpStop( void ) @@ -611,7 +601,6 @@ * @details * Inputs : Dialysate outlet pump data * Outputs : Dialysate outlet pump data is published to CAN bus. - * @param none * @return none *************************************************************************/ static void publishDialOutFlowData( void ) @@ -643,7 +632,6 @@ * @details * Inputs : DialOutDataPublishInterval * Outputs : none - * @param none * @return the current dialysate out flow data publication interval (in ms). *************************************************************************/ static DATA_GET( U32, getPublishDialOutDataInterval, DialOutDataPublishInterval ) @@ -665,7 +653,6 @@ * @details * Inputs : referenceUFVolumeInMl * Outputs : none - * @param none * @return the current target UF volume in mL. *************************************************************************/ DATA_GET( F32, getTotalTargetDialOutUFVolumeInMl, referenceUFVolumeInMl ) @@ -676,7 +663,6 @@ * @details * Inputs : totalMeasuredUFVolumeInMl * Outputs : none - * @param none * @return the current UF volume (in mL). *************************************************************************/ DATA_GET( F32, getTotalMeasuredUFVolumeInMl, totalMeasuredUFVolumeInMl ) @@ -688,7 +674,6 @@ * @details * Inputs : dialOutPumpRotorSpeedRPM * Outputs : none - * @param none * @return the current dialysate outlet pump rotor speed (in RPM). *************************************************************************/ DATA_GET( F32, getMeasuredDialOutPumpRotorSpeed, dialOutPumpRotorSpeedRPM ) @@ -700,7 +685,6 @@ * @details * Inputs : dialOutPumpSpeedRPM * Outputs : none - * @param none * @return the current dialysate outlet pump motor speed (in RPM). *************************************************************************/ DATA_GET( F32, getMeasuredDialOutPumpSpeed, dialOutPumpSpeedRPM ) @@ -712,7 +696,7 @@ * @details * Inputs : dialOutPumpMCSpeedRPM * Outputs : none - * @param none +* @param none * @return the current dialOut pump speed (in RPM). *************************************************************************/ DATA_GET( F32, getMeasuredDialOutPumpMCSpeed, dialOutPumpMCSpeedRPM ) @@ -724,7 +708,6 @@ * @details * Inputs : dialOutPumpMCCurrentmA * Outputs : none - * @param none * @return the current dialOut pump current (in mA). *************************************************************************/ DATA_GET( F32, getMeasuredDialOutPumpMCCurrent, dialOutPumpMCCurrentmA) Index: firmware/App/Controllers/DialOutFlow.h =================================================================== diff -u -r7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717 -r926afe9b1d9cc6931cbca48080e4a66385a20239 --- firmware/App/Controllers/DialOutFlow.h (.../DialOutFlow.h) (revision 7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717) +++ firmware/App/Controllers/DialOutFlow.h (.../DialOutFlow.h) (revision 926afe9b1d9cc6931cbca48080e4a66385a20239) @@ -38,7 +38,7 @@ 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. + NUM_OF_LOAD_CELLS ///< Number of load cell sensors. } LOAD_CELL_T; #pragma pack(push, 1) Index: firmware/App/Controllers/PresOccl.c =================================================================== diff -u -r57ee0134869672b53ab5b7146b8988ede8f828d6 -r926afe9b1d9cc6931cbca48080e4a66385a20239 --- firmware/App/Controllers/PresOccl.c (.../PresOccl.c) (revision 57ee0134869672b53ab5b7146b8988ede8f828d6) +++ firmware/App/Controllers/PresOccl.c (.../PresOccl.c) (revision 926afe9b1d9cc6931cbca48080e4a66385a20239) @@ -37,7 +37,7 @@ { PRESSURE_INIT_STATE = 0, ///< Initialization state. PRESSURE_CONTINUOUS_READ_STATE, ///< Continuous read sensors state. - NUM_OF_PRESSURE_STATES ///< # of pressure/occlusion monitor states. + NUM_OF_PRESSURE_STATES ///< Number of pressure/occlusion monitor states. } PRESSURE_STATE_T; /// Defined states for the pressure and occlusion self test state machine. @@ -46,7 +46,7 @@ PRESSURE_SELF_TEST_STATE_START = 0, ///< Self test start state. PRESSURE_TEST_STATE_IN_PROGRESS, ///< Self test in progress state. PRESSURE_TEST_STATE_COMPLETE, ///< Self test completed state. - NUM_OF_PRESSURE_SELF_TEST_STATES ///< # of pressure/occlusion self test states. + NUM_OF_PRESSURE_SELF_TEST_STATES ///< Number of pressure/occlusion self test states. } PRESSURE_SELF_TEST_STATE_T; // ********** private data ********** @@ -89,7 +89,6 @@ * @details * Inputs : none * Outputs : initPresOccl module initialized. - * @param none * @return none *************************************************************************/ void initPresOccl( void ) @@ -168,7 +167,6 @@ * @details * Inputs : presOcclState * Outputs : presOcclState - * @param none * @return none *************************************************************************/ void execPresOccl( void ) @@ -200,7 +198,6 @@ * @details * Inputs : TBD * Outputs : TBD - * @param none * @return next state *************************************************************************/ static PRESSURE_STATE_T handlePresOcclInitState( void ) @@ -217,7 +214,6 @@ * @details * Inputs : TBD * Outputs : pressure sensor values updated - * @param none * @return next state *************************************************************************/ static PRESSURE_STATE_T handlePresOcclContReadState( void ) @@ -254,7 +250,6 @@ * @details * Inputs : occlusion pressures for the pumps * Outputs : - * @param none * @return none *************************************************************************/ static void checkOcclusions( void ) @@ -287,7 +282,6 @@ * @details * Inputs : presOcclDataPublishInterval * Outputs : none - * @param none * @return the current pressure/occlusion data publication interval (in ms). *************************************************************************/ DATA_GET( U32, getPublishPresOcclDataInterval, presOcclDataPublishInterval ) @@ -298,7 +292,6 @@ * @details * Inputs : arterialPressure * Outputs : none - * @param none * @return the current arterial pressure (in mmHg). *************************************************************************/ DATA_GET( F32, getMeasuredArterialPressure, arterialPressure ) @@ -309,7 +302,6 @@ * @details * Inputs : venousPressure * Outputs : none - * @param none * @return the current venous pressure (in mmHg). *************************************************************************/ DATA_GET( F32, getMeasuredVenousPressure, venousPressure ) @@ -321,7 +313,6 @@ * @details * Inputs : bloodPumpOcclusion * Outputs : none - * @param none * @return the current blood pump occlusion pressure (in mmHg). *************************************************************************/ DATA_GET( F32, getMeasuredBloodPumpOcclusion, bloodPumpOcclusion ) @@ -333,7 +324,6 @@ * @details * Inputs : dialInPumpOcclusion * Outputs : none - * @param none * @return the current dialysis inlet pump occlusion pressure (in mmHg). *************************************************************************/ DATA_GET( F32, getMeasuredDialInPumpOcclusion, dialInPumpOcclusion ) @@ -345,7 +335,6 @@ * @details * Inputs : dialOutPumpOcclusion * Outputs : none - * @param none * @return the current dialysis outlet pump occlusion pressure (in mmHg). *************************************************************************/ DATA_GET( F32, getMeasuredDialOutPumpOcclusion, dialOutPumpOcclusion ) @@ -357,7 +346,6 @@ * @details * Inputs : TBD * Outputs : Pressure/occlusion data are published to CAN bus. - * @param none * @return none *************************************************************************/ static void publishPresOcclData( void ) @@ -390,7 +378,6 @@ * @details * Inputs : none * Outputs : none - * @param none * @return the current state of the PresOccl self test. *************************************************************************/ SELF_TEST_STATUS_T execPresOcclTest( void ) Index: firmware/App/Controllers/PresOccl.h =================================================================== diff -u -r7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717 -r926afe9b1d9cc6931cbca48080e4a66385a20239 --- firmware/App/Controllers/PresOccl.h (.../PresOccl.h) (revision 7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717) +++ firmware/App/Controllers/PresOccl.h (.../PresOccl.h) (revision 926afe9b1d9cc6931cbca48080e4a66385a20239) @@ -35,7 +35,7 @@ { PRESSURE_SENSOR_ARTERIAL = 0, ///< arterial blood line pressure sensor. PRESSURE_SENSOR_VENOUS, ///< vensous blood line pressure sensor. - NUM_OF_PRESSURE_SENSORS ///< # of pressure sensors. + NUM_OF_PRESSURE_SENSORS ///< Number of pressure sensors. } PRESSURE_SENSORS_T; /// Enumeration of occlusion sensors monitored by this module. @@ -44,7 +44,7 @@ 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 ///< # of occlusion sensors. + NUM_OF_OCCLUSION_SENSORS ///< Number of occlusion sensors. } OCCLUSION_SENSORS_T; // ********** public function prototypes ********** Index: firmware/App/Modes/Dialysis.c =================================================================== diff -u -r7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717 -r926afe9b1d9cc6931cbca48080e4a66385a20239 --- firmware/App/Modes/Dialysis.c (.../Dialysis.c) (revision 7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717) +++ firmware/App/Modes/Dialysis.c (.../Dialysis.c) (revision 926afe9b1d9cc6931cbca48080e4a66385a20239) @@ -36,7 +36,7 @@ DIALYSIS_START_STATE = 0, ///< Start state of the dialysis sub-mode state machine. DIALYSIS_UF_STATE, ///< Ultrafiltration state of the dialysis sub-mode state machine. DIALYSIS_SOLUTION_INFUSION_STATE, ///< Solution infusion state of the dialysis sub-mode state machine. - NUM_OF_DIALYSIS_STATES ///< # of dialysis sub-mode states. + NUM_OF_DIALYSIS_STATES ///< Number of dialysis sub-mode states. } DIALYSIS_STATE_T; /// Enumeration of ultrafiltration states. @@ -46,7 +46,7 @@ UF_PAUSED_STATE, ///< Paused state of the ultrafiltration state machine. UF_RUNNING_STATE, ///< Running state of the ultrafiltration state machine. UF_COMPLETED_OR_OFF_STATE, ///< Completed/off state of the ultrafiltration state machine. - NUM_OF_UF_STATES ///< # of ultrafiltration states. + NUM_OF_UF_STATES ///< Number of ultrafiltration states. } UF_STATE_T; // ********** private data ********** @@ -87,7 +87,6 @@ * @details * Inputs : none * Outputs : Dialysis sub-mode module initialized. - * @param none * @return none *************************************************************************/ void initDialysis( void ) @@ -119,7 +118,6 @@ * @details * Inputs : none * Outputs : none - * @param none * @return none *************************************************************************/ void transitionToDialysis( void ) @@ -192,7 +190,6 @@ * @details * Inputs : currentDialysisState * Outputs : currentDialysisState - * @param none * @return none *************************************************************************/ void execDialysis( void ) Index: firmware/App/Modes/TreatmentStop.c =================================================================== diff -u -r7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717 -r926afe9b1d9cc6931cbca48080e4a66385a20239 --- firmware/App/Modes/TreatmentStop.c (.../TreatmentStop.c) (revision 7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717) +++ firmware/App/Modes/TreatmentStop.c (.../TreatmentStop.c) (revision 926afe9b1d9cc6931cbca48080e4a66385a20239) @@ -35,7 +35,6 @@ * @details * Inputs : none * Outputs : Treatment Stop sub-mode module initialized. - * @param none * @return none *************************************************************************/ void initTreatmentStop( void ) @@ -49,7 +48,6 @@ * @details * Inputs : none * Outputs : none - * @param none * @return none *************************************************************************/ void transitionToTreatmentStop( void ) @@ -63,7 +61,6 @@ * @details * Inputs : none * Outputs : none - * @param none * @return none *************************************************************************/ void execTreatmentStop( void ) Index: firmware/App/Services/AlarmMgmt.c =================================================================== diff -u -r7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717 -r926afe9b1d9cc6931cbca48080e4a66385a20239 --- firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision 7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717) +++ firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision 926afe9b1d9cc6931cbca48080e4a66385a20239) @@ -33,10 +33,10 @@ #define ALARM_SILENCE_EXPIRES_IN_SECS (60) ///< Alarm silence expiration time in seconds. -#define ALM_ESC_1_MIN (1 * SEC_PER_MIN * MS_PER_SECOND) ///< # of ms in 1 minute. -#define ALM_ESC_4_MIN (4 * SEC_PER_MIN * MS_PER_SECOND) ///< # of ms in 4 minutes. -#define ALM_ESC_5_MIN (5 * SEC_PER_MIN * MS_PER_SECOND) ///< # of ms in 5 minutes. -#define ALM_ESC_10_MIN (10 * SEC_PER_MIN * MS_PER_SECOND) ///< # of ms in 10 minutes. +#define ALM_ESC_1_MIN (1 * SEC_PER_MIN * MS_PER_SECOND) ///< Number of ms in 1 minute. +#define ALM_ESC_4_MIN (4 * SEC_PER_MIN * MS_PER_SECOND) ///< Number of ms in 4 minutes. +#define ALM_ESC_5_MIN (5 * SEC_PER_MIN * MS_PER_SECOND) ///< Number of ms in 5 minutes. +#define ALM_ESC_10_MIN (10 * SEC_PER_MIN * MS_PER_SECOND) ///< Number of ms in 10 minutes. #pragma pack(push,1) /// Record defining the properties of each individual alarm. Index: firmware/App/Services/AlarmMgmt.h =================================================================== diff -u -ra74a984a7059f75d86ad87d6d9499bd8f94cc976 -r926afe9b1d9cc6931cbca48080e4a66385a20239 --- firmware/App/Services/AlarmMgmt.h (.../AlarmMgmt.h) (revision a74a984a7059f75d86ad87d6d9499bd8f94cc976) +++ firmware/App/Services/AlarmMgmt.h (.../AlarmMgmt.h) (revision 926afe9b1d9cc6931cbca48080e4a66385a20239) @@ -41,7 +41,7 @@ ALARM_DATA_TYPE_S32 = 2, ///< Alarm data is signed 32-bit integer type. ALARM_DATA_TYPE_F32 = 3, ///< Alarm data is 32-bit floating point type. ALARM_DATA_TYPE_BOOL = 4, ///< Alarm data is 32-bit boolean type. - NUM_OF_ALARM_DATA_TYPES ///< Total # of alarm data types. + NUM_OF_ALARM_DATA_TYPES ///< Total number of alarm data types. } ALARM_DATA_TYPES_T; #pragma pack(push,4) Index: firmware/App/Services/PIControllers.c =================================================================== diff -u -ra74a984a7059f75d86ad87d6d9499bd8f94cc976 -r926afe9b1d9cc6931cbca48080e4a66385a20239 --- firmware/App/Services/PIControllers.c (.../PIControllers.c) (revision a74a984a7059f75d86ad87d6d9499bd8f94cc976) +++ firmware/App/Services/PIControllers.c (.../PIControllers.c) (revision 926afe9b1d9cc6931cbca48080e4a66385a20239) @@ -68,6 +68,10 @@ * * @param controllerID - ID filter number * @param initialControlSignal - Value of the output on the first iteration + * @param kP - Coefficient for proportional. + * @param kI - Coefficient for integral. + * @param controlMin - Minimum control output. + * @param controlMax - Maximum control output. * * @return none *************************************************************************/ Index: firmware/App/Services/PIControllers.h =================================================================== diff -u -ra74a984a7059f75d86ad87d6d9499bd8f94cc976 -r926afe9b1d9cc6931cbca48080e4a66385a20239 --- firmware/App/Services/PIControllers.h (.../PIControllers.h) (revision a74a984a7059f75d86ad87d6d9499bd8f94cc976) +++ firmware/App/Services/PIControllers.h (.../PIControllers.h) (revision 926afe9b1d9cc6931cbca48080e4a66385a20239) @@ -35,7 +35,7 @@ PI_CONTROLLER_ID_ULTRAFILTRATION = 0, ///< Load cell controller for dialysate outlet pump. PI_CONTROLLER_ID_BLOOD_FLOW, ///< Flow controller for blood pump. PI_CONTROLLER_ID_DIALYSATE_FLOW, ///< Flow controller for dialysate inlet pump. - NUM_OF_PI_CONTROLLERS_IDS ///< # of PI controllers. + NUM_OF_PI_CONTROLLERS_IDS ///< Number of PI controllers. } PI_CONTROLLER_ID_T; /// Enumeration of PI controller signals @@ -49,7 +49,7 @@ CONTROLLER_SIGNAL_PROPORTIONAL_OUTPUT, ///< P portion of controller output signal. CONTROLLER_SIGNAL_INTEGRAL_OUTPUT, ///< I portion of controller output signal. CONTROLLER_SIGNAL_CONTROL, ///< Controller output signal. - NUM_OF_CONTROLLER_SIGNAL ///< # of PI controller signals. + NUM_OF_CONTROLLER_SIGNAL ///< Number of PI controller signals. } PI_CONTROLLER_SIGNALS_ID; // ********** public function prototypes **********