Index: firmware/App/Controllers/DialOutFlow.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/DialOutFlow.c (.../DialOutFlow.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Controllers/DialOutFlow.c (.../DialOutFlow.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -222,7 +222,7 @@ /*********************************************************************//** * @brief - * The setDialOutPumpTargetRate function sets a new target flow rate, pump \n + * The setDialOutPumpTargetRate function sets a new target flow rate, pump * direction, and control mode. * @details * Inputs : isDialOutPumpOn, dialOutPumpDirectionSet @@ -291,7 +291,7 @@ /*********************************************************************//** * @brief - * The setDialOutUFVolumes function sets the ultrafiltration reference and \n + * The setDialOutUFVolumes function sets the ultrafiltration reference and * measured total volumes (in mL). * @details * Inputs : none @@ -308,7 +308,7 @@ /*********************************************************************//** * @brief - * The signalDialOutPumpHardStop function stops the dialysate outlet pump \n + * The signalDialOutPumpHardStop function stops the dialysate outlet pump * immediately. * @details * Inputs : none @@ -327,8 +327,8 @@ /*********************************************************************//** * @brief - * The signalDialOutPumpRotorHallSensor function handles the dialysate outlet \n - * pump rotor hall sensor detection. Calculates rotor speed (in RPM). \n + * The signalDialOutPumpRotorHallSensor function handles the dialysate outlet + * pump rotor hall sensor detection. Calculates rotor speed (in RPM). * Stops pump if there is a pending request to home the pump. * @details * Inputs : dopRotorRevStartTime, dopStopAtHomePosition @@ -376,7 +376,7 @@ /*********************************************************************//** * @brief - * The setDialOutUFVolumes function sets the ultrafiltration reference and \n + * The setDialOutUFVolumes function sets the ultrafiltration reference and * measured total volumes (in mL). * @details * Inputs : none @@ -401,8 +401,8 @@ /*********************************************************************//** * @brief execDialOutFlowMonitor - * The execDialOutFlowMonitor function executes the dialysate outlet pump \n - * and load cell sensor monitor. Checks are performed. Data is published \n + * The execDialOutFlowMonitor function executes the dialysate outlet pump + * and load cell sensor monitor. Checks are performed. Data is published * at appropriate interval. * @details * Inputs : latest sensor data @@ -438,7 +438,7 @@ /*********************************************************************//** * @brief execDialOutFlowController - * The execDialOutFlowController function executes the dialysate outlet pump \n + * The execDialOutFlowController function executes the dialysate outlet pump * ultrafiltration controller state machine. * @details * Inputs : dialOutPumpState @@ -473,7 +473,7 @@ /*********************************************************************//** * @brief handleDialOutPumpOffState - * The handleDialOutPumpOffState function handles the dialOut pump off state \n + * The handleDialOutPumpOffState function handles the dialOut pump off state * of the dialOut pump controller state machine. * @details * Inputs : targetDialOutFlowRate, dialOutPumpDirection @@ -506,7 +506,7 @@ /*********************************************************************//** * @brief handleDialOutPumpRampingUpState - * The handleDialOutPumpRampingUpState function handles the ramp up state \n + * The handleDialOutPumpRampingUpState function handles the ramp up state * of the dialOut pump controller state machine. * @details * Inputs : dialOutPumpPWMDutyCyclePctSet @@ -550,7 +550,7 @@ /*********************************************************************//** * @brief handleDialOutPumpRampingDownState - * The handleDialOutPumpRampingDownState function handles the ramp down state \n + * The handleDialOutPumpRampingDownState function handles the ramp down state * of the dialOut pump controller state machine. * @details * Inputs : dialOutPumpPWMDutyCyclePctSet @@ -592,7 +592,7 @@ /*********************************************************************//** * @brief handleDialOutPumpControlToTargetState - * The handleDialOutPumpControlToTargetState function handles the "control to \n + * The handleDialOutPumpControlToTargetState function handles the "control to * target" state of the dialOut pump controller state machine. * @details * Inputs : dopControlTimerCounter, dialOutPumpControlModeSet, volumes. @@ -633,7 +633,7 @@ /*********************************************************************//** * @brief - * The setDialOutPumpControlSignalPWM function set the PWM duty cycle of \n + * The setDialOutPumpControlSignalPWM function set the PWM duty cycle of * the dialysate outlet pump to a given %. * @details * Inputs : none @@ -648,7 +648,7 @@ /*********************************************************************//** * @brief stopDialOutPump - * The stopDialOutPump function sets the dialout flow stop signal and PWM \n + * The stopDialOutPump function sets the dialout flow stop signal and PWM * duty cycle to 0.0. * @details * Inputs : none @@ -678,7 +678,7 @@ /*********************************************************************//** * @brief - * The setDialOutPumpDirection function sets the set dialOut pump direction to \n + * The setDialOutPumpDirection function sets the set dialOut pump direction to * the given direction. * @details * Inputs : none @@ -708,7 +708,7 @@ /*********************************************************************//** * @brief - * The publishDialOutFlowData function publishes dialysate outlet data at \n + * The publishDialOutFlowData function publishes dialysate outlet data at * the set interval. * @details * Inputs : Dialysate outlet pump data @@ -735,8 +735,8 @@ /*********************************************************************//** * @brief - * The updateDialOutPumpSpeedAndDirectionFromHallSensors function calculates \n - * the dialysate outlet pump motor speed and direction from hall sensor counter on \n + * The updateDialOutPumpSpeedAndDirectionFromHallSensors function calculates + * the dialysate outlet pump motor speed and direction from hall sensor counter on * a 1 second interval. * @details * Inputs : dopLastMotorHallSensorCount, dopMotorSpeedCalcTimerCtr, current count from FPGA @@ -774,8 +774,8 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpRotor function checks the rotor for the dialysate outlet \n - * pump. If homing, this function will stop when hall sensor detected. If pump \n + * The checkDialOutPumpRotor function checks the rotor for the dialysate outlet + * pump. If homing, this function will stop when hall sensor detected. If pump * is off or running very slowly, rotor speed will be set to zero. * @details * Inputs : dopStopAtHomePosition, dopHomeStartTime, dopRotorRevStartTime @@ -801,7 +801,7 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpDirection function checks the set direction vs. \n + * The checkDialOutPumpDirection function checks the set direction vs. * the direction implied by the sign of the measured MC speed. * @details * Inputs : adcDialOutPumpMCSpeedRPM, dialOutPumpDirectionSet, dialOutPumpState @@ -827,11 +827,11 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpSpeeds function checks several aspects of the dialysate \n - * outlet pump speed. \n - * 1. while pump is commanded off, measured motor speed should be < limit. \n - * 2. while pump is controlling, measured motor speed should be within allowed range of measured motor controller speed. \n - * 3. measured motor speed should be within allowed range of measured rotor speed. \n + * The checkDialOutPumpSpeeds function checks several aspects of the dialysate + * outlet pump speed. + * 1. while pump is commanded off, measured motor speed should be < limit. + * 2. while pump is controlling, measured motor speed should be within allowed range of measured motor controller speed. + * 3. measured motor speed should be within allowed range of measured rotor speed. * All 3 checks have a persistence time that must be met before an alarm is triggered. * @details * Inputs : targetDialOutFlowRate, dialOutPumpSpeedRPM, dialOutPumpRotorSpeedRPM @@ -912,7 +912,7 @@ /*********************************************************************//** * @brief - * The checkDialOutPumpMCCurrent function checks the measured MC current vs. \n + * The checkDialOutPumpMCCurrent function checks the measured MC current vs. * the set state of the dialOut pump (stopped or running). * @details * Inputs : dialOutPumpState, dopCurrErrorDurationCtr, adcDialOutPumpMCCurrentmA @@ -970,7 +970,7 @@ /*********************************************************************//** * @brief - * The getPublishDialOutFlowDataInterval function gets the dialysate out flow \n + * The getPublishDialOutFlowDataInterval function gets the dialysate out flow * data publication interval. * @details * Inputs : dialOutDataPublishInterval @@ -1063,7 +1063,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpRotorSpeed function gets the measured dialysate \n + * The getMeasuredDialOutPumpRotorSpeed function gets the measured dialysate * outlet pump rotor speed. * @details * Inputs : dialOutPumpRotorSpeedRPM @@ -1084,7 +1084,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpSpeed function gets the measured dialysate outlet \n + * The getMeasuredDialOutPumpSpeed function gets the measured dialysate outlet * pump motor speed. * @details * Inputs : dialOutPumpSpeedRPM @@ -1105,7 +1105,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpMCSpeed function gets the measured dialOut pump \n + * The getMeasuredDialOutPumpMCSpeed function gets the measured dialOut pump * speed. * @details * Inputs : dialOutPumpMCSpeedRPM @@ -1126,7 +1126,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialOutPumpMCCurrent function gets the measured dialOut pump \n + * The getMeasuredDialOutPumpMCCurrent function gets the measured dialOut pump * current. * @details * Inputs : dialOutPumpMCCurrentmA @@ -1153,7 +1153,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutPumpAndLoadCellDataPublishIntervalOverride function overrides the \n + * The testSetDialOutPumpAndLoadCellDataPublishIntervalOverride function overrides the * dialout data publish interval. * @details * Inputs : none @@ -1179,7 +1179,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutPumpAndLoadCellDataPublishIntervalOverride function resets the override \n + * The testResetDialOutPumpAndLoadCellDataPublishIntervalOverride function resets the override * of the dialout data publish interval. * @details * Inputs : none @@ -1202,7 +1202,7 @@ /*********************************************************************//** * @brief - * The testSetTargetDialOutFlowRateOverride function overrides the target \n + * The testSetTargetDialOutFlowRateOverride function overrides the target * dialysate outlet flow rate. * @details * Inputs : none @@ -1238,7 +1238,7 @@ /*********************************************************************//** * @brief - * The testResetTargetDialOutFlowRateOverride function resets the override of the \n + * The testResetTargetDialOutFlowRateOverride function resets the override of the * target dialysate outlet flow rate. * @details * Inputs : none @@ -1259,7 +1259,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutUFRefVolumeOverride function overrides the target \n + * The testSetDialOutUFRefVolumeOverride function overrides the target * dialout vol rate. * @details * Inputs : referenceUFVolumeInMl @@ -1283,7 +1283,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutUFRefVolumeOverride function resets the override of the \n + * The testResetDialOutUFRefVolumeOverride function resets the override of the * target dialout vol rate. * @details * Inputs : referenceUFVolumeInMl @@ -1306,7 +1306,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutUFTotVolumeOverride function overrides the measured \n + * The testSetDialOutUFTotVolumeOverride function overrides the measured * dialout vol rate. * @details * Inputs : totalMeasuredUFVolumeInMl @@ -1330,7 +1330,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutUFTotVolumeOverride function resets the override of the \n + * The testResetDialOutUFTotVolumeOverride function resets the override of the * measured dialout vol rate. * @details * Inputs : totalMeasuredUFVolumeInMl @@ -1353,7 +1353,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpRotorSpeedOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpRotorSpeedOverride function overrides the measured * dialOut pump rotor speed. * @details * Inputs : DialOutPumpRotorSpeedRPM @@ -1377,7 +1377,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpRotorSpeedOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpRotorSpeedOverride function resets the override of the * measured dialOut pump rotor speed. * @details * Inputs : DialOutPumpRotorSpeedRPM @@ -1400,7 +1400,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpSpeedOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpSpeedOverride function overrides the measured * dialOut pump motor speed. * @details * Inputs : dialOutPumpSpeedRPM @@ -1424,7 +1424,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpSpeedOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpSpeedOverride function resets the override of the * measured dialOut pump motor speed. * @details * Inputs : dialOutPumpSpeedRPM @@ -1447,7 +1447,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpMCSpeedOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpMCSpeedOverride function overrides the measured * dialOut pump motor speed. * @details * Inputs : dialOutPumpMCSpeedRPM @@ -1471,7 +1471,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpMCSpeedOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpMCSpeedOverride function resets the override of the * measured dialOut pump motor speed. * @details * Inputs : dialOutPumpMCSpeedRPM @@ -1494,7 +1494,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialOutPumpMCCurrentOverride function overrides the measured \n + * The testSetMeasuredDialOutPumpMCCurrentOverride function overrides the measured * dialOut pump motor current. * @details * Inputs : dialOutPumpMCCurrentmA @@ -1518,7 +1518,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialOutPumpMCCurrentOverride function resets the override of the \n + * The testResetMeasuredDialOutPumpMCCurrentOverride function resets the override of the * measured dialOut pump motor current. * @details * Inputs : dialOutPumpMCCurrentmA @@ -1541,7 +1541,7 @@ /*********************************************************************//** * @brief - * The testSetDialOutLoadCellWeightOverride function overrides the value of the \n + * The testSetDialOutLoadCellWeightOverride function overrides the value of the * load cell sensor with a given weight (in grams). * @details * Inputs : loadCellWeightInGrams[] @@ -1569,7 +1569,7 @@ /*********************************************************************//** * @brief - * The testResetDialOutLoadCellWeightOverride function resets the override of the \n + * The testResetDialOutLoadCellWeightOverride function resets the override of the * load cell sensor. * @details * Inputs : loadCellWeightInGrams[]