Index: firmware/App/Controllers/DialInFlow.c =================================================================== diff -u -r9302e1bd2413cbf99e80ac51aac38502d94801d9 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/DialInFlow.c (.../DialInFlow.c) (revision 9302e1bd2413cbf99e80ac51aac38502d94801d9) +++ firmware/App/Controllers/DialInFlow.c (.../DialInFlow.c) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -299,8 +299,8 @@ /*********************************************************************//** * @brief - * The signalDialInPumpRotorHallSensor function handles the dialysate inlet pump rotor \n - * hall sensor detection. Calculates rotor speed (in RPM). Stops pump if \n + * The signalDialInPumpRotorHallSensor function handles the dialysate inlet pump rotor + * hall sensor detection. Calculates rotor speed (in RPM). Stops pump if * there is a pending request to home the pump. * @details * Inputs : dipRotorRevStartTime, dipStopAtHomePosition @@ -422,7 +422,7 @@ /*********************************************************************//** * @brief - * The handleDialInPumpOffState function handles the dialIn pump off state \n + * The handleDialInPumpOffState function handles the dialIn pump off state * of the dialIn pump controller state machine. * @details * Inputs : targetDialInFlowRate, dialInPumpDirection @@ -451,7 +451,7 @@ /*********************************************************************//** * @brief - * The handleDialInPumpRampingUpState function handles the ramp up state \n + * The handleDialInPumpRampingUpState function handles the ramp up state * of the dialIn pump controller state machine. * @details * Inputs : dialInPumpPWMDutyCyclePctSet @@ -496,7 +496,7 @@ /*********************************************************************//** * @brief - * The handleDialInPumpRampingDownState function handles the ramp down state \n + * The handleDialInPumpRampingDownState function handles the ramp down state * of the dialIn pump controller state machine. * @details * Inputs : dialInPumpPWMDutyCyclePctSet @@ -539,7 +539,7 @@ /*********************************************************************//** * @brief - * The handleDialInPumpControlToTargetState function handles the "control to \n + * The handleDialInPumpControlToTargetState function handles the "control to * target" state of the dialIn pump controller state machine. * @details * Inputs : none @@ -571,7 +571,7 @@ /*********************************************************************//** * @brief - * The setDialInPumpControlSignalPWM function sets the PWM duty cycle for \n + * The setDialInPumpControlSignalPWM function sets the PWM duty cycle for * the dialysate inlet pump to a given %. * @details * Inputs : none @@ -615,7 +615,7 @@ /*********************************************************************//** * @brief - * The setDialInPumpDirection function sets the set dialIn pump direction to \n + * The setDialInPumpDirection function sets the set dialIn pump direction to * the given direction. * @details * Inputs : dialInPumpState @@ -645,7 +645,7 @@ /*********************************************************************//** * @brief - * The getPublishDialInFlowDataInterval function gets the dialIn flow data \n + * The getPublishDialInFlowDataInterval function gets the dialIn flow data * publication interval. * @details * Inputs : dialInFlowDataPublishInterval @@ -666,7 +666,7 @@ /*********************************************************************//** * @brief - * The getTargetDialInFlowRate function gets the current target dialIn flow \n + * The getTargetDialInFlowRate function gets the current target dialIn flow * rate. * @details * Inputs : targetDialInFlowRate @@ -687,7 +687,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInFlowRate function gets the measured dialIn flow \n + * The getMeasuredDialInFlowRate function gets the measured dialIn flow * rate. * @details * Inputs : measuredDialInFlowRate @@ -708,7 +708,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInPumpRotorSpeed function gets the measured dialIn flow \n + * The getMeasuredDialInPumpRotorSpeed function gets the measured dialIn flow * rate. * @details * Inputs : dialInPumpRotorSpeedRPM @@ -729,7 +729,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInPumpSpeed function gets the measured dialIn flow \n + * The getMeasuredDialInPumpSpeed function gets the measured dialIn flow * rate. * @details * Inputs : dialInPumpSpeedRPM @@ -750,7 +750,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInPumpMCSpeed function gets the measured dialIn pump \n + * The getMeasuredDialInPumpMCSpeed function gets the measured dialIn pump * speed. * @details * Inputs : adcDialInPumpMCSpeedRPM @@ -771,7 +771,7 @@ /*********************************************************************//** * @brief - * The getMeasuredDialInPumpMCCurrent function gets the measured dialIn pump \n + * The getMeasuredDialInPumpMCCurrent function gets the measured dialIn pump * current. * @details * Inputs : adcDialInPumpMCCurrentmA @@ -792,10 +792,10 @@ /*********************************************************************//** * @brief - * The publishDialInFlowData function publishes dialIn flow data at the set \n + * The publishDialInFlowData function publishes dialIn flow data at the set * interval. * @details - * Inputs : target flow rate, measured flow rate, measured MC speed, \n + * Inputs : target flow rate, measured flow rate, measured MC speed, * measured MC current * Outputs : DialIn flow data is published to CAN bus. * @return none @@ -819,7 +819,7 @@ /*********************************************************************//** * @brief - * The resetDialInFlowMovingAverage function resets the properties of the \n + * The resetDialInFlowMovingAverage function resets the properties of the * dialIn flow moving average sample buffer. * @details * Inputs : none @@ -861,8 +861,8 @@ /*********************************************************************//** * @brief - * The updateDialInPumpSpeedAndDirectionFromHallSensors function calculates \n - * the dialysate inlet pump motor speed and direction from hall sensor counter on \n + * The updateDialInPumpSpeedAndDirectionFromHallSensors function calculates + * the dialysate inlet pump motor speed and direction from hall sensor counter on * a 1 second interval. * @details * Inputs : dipLastMotorHallSensorCount, dipMotorSpeedCalcTimerCtr, current count from FPGA @@ -900,8 +900,8 @@ /*********************************************************************//** * @brief - * The checkDialInPumpRotor function checks the rotor for the dialysate inlet \n - * pump. If homing, this function will stop when hall sensor detected. If pump \n + * The checkDialInPumpRotor function checks the rotor for the dialysate inlet + * 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 : dipStopAtHomePosition, dipHomeStartTime, dipRotorRevStartTime @@ -927,7 +927,7 @@ /*********************************************************************//** * @brief - * The checkDialInPumpDirection function checks the set direction vs. \n + * The checkDialInPumpDirection function checks the set direction vs. * the direction implied by the sign of the measured MC speed. * @details * Inputs : adcDialInPumpMCSpeedRPM, dialInPumpDirectionSet, dialInPumpState @@ -953,11 +953,11 @@ /*********************************************************************//** * @brief - * The checkDialInPumpSpeeds function checks several aspects of the dialysate \n - * inlet 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 commanded speed. \n - * 3. measured motor speed should be within allowed range of measured rotor speed. \n + * The checkDialInPumpSpeeds function checks several aspects of the dialysate + * inlet 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 commanded 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 : targetDialInFlowRate, dialInPumpSpeedRPM, dialInPumpRotorSpeedRPM @@ -1039,9 +1039,9 @@ /*********************************************************************//** * @brief - * The checkDialInPumpFlowAgainstSpeed function checks the measured dialysate flow \n - * against the implied flow of the measured pump speed when in treatment mode \n - * and controlling to target flow. If a sufficient difference persists, a \n + * The checkDialInPumpFlowAgainstSpeed function checks the measured dialysate flow + * against the implied flow of the measured pump speed when in treatment mode + * and controlling to target flow. If a sufficient difference persists, a * flow vs. motor speed check error is triggered. * @details * Inputs : measuredDialInFlowRate, dialInPumpSpeedRPM, errorDialInFlowVsMotorSpeedPersistTimerCtr @@ -1080,7 +1080,7 @@ /*********************************************************************//** * @brief - * The checkDialInPumpMCCurrent function checks the measured MC current vs. \n + * The checkDialInPumpMCCurrent function checks the measured MC current vs. * the set state of the dialIn pump (stopped or running). * @details * Inputs : dialInPumpState, dipCurrErrorDurationCtr, adcDialInPumpMCCurrentmA @@ -1133,7 +1133,7 @@ /*********************************************************************//** * @brief - * The execDialInFlowTest function executes the state machine for the \n + * The execDialInFlowTest function executes the state machine for the * DialInFlow self test. * @details * Inputs : none @@ -1180,7 +1180,7 @@ /*********************************************************************//** * @brief - * The setDialInFlowCalibration function sets the dialysate flow calibration \n + * The setDialInFlowCalibration function sets the dialysate flow calibration * factors and has them stored in non-volatile memory. * @details * Inputs : none @@ -1215,7 +1215,7 @@ /*********************************************************************//** * @brief - * The getDialInFlowCalibration function retrieves the current dialysate flow \n + * The getDialInFlowCalibration function retrieves the current dialysate flow * calibration factors. * @details * Inputs : dialInFlowCalGain, dialInFlowCalOffset @@ -1232,7 +1232,7 @@ /*********************************************************************//** * @brief - * The testSetDialInFlowDataPublishIntervalOverride function overrides the \n + * The testSetDialInFlowDataPublishIntervalOverride function overrides the * dialIn flow data publish interval. * @details * Inputs : none @@ -1258,7 +1258,7 @@ /*********************************************************************//** * @brief - * The testResetDialInFlowDataPublishIntervalOverride function resets the override \n + * The testResetDialInFlowDataPublishIntervalOverride function resets the override * of the dialIn flow data publish interval. * @details * Inputs : none @@ -1281,7 +1281,7 @@ /*********************************************************************//** * @brief - * The testSetTargetDialInFlowRateOverride function overrides the target \n + * The testSetTargetDialInFlowRateOverride function overrides the target * dialysate inlet flow rate.n * @details * Inputs : none @@ -1320,7 +1320,7 @@ /*********************************************************************//** * @brief - * The testResetTargetDialInFlowRateOverride function resets the override of the \n + * The testResetTargetDialInFlowRateOverride function resets the override of the * target dialysate inlet flow rate. * @details * Inputs : none @@ -1345,7 +1345,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInFlowRateOverride function overrides the measured \n + * The testResetMeasuredDialInFlowRateOverride function overrides the measured * dialIn flow rate. * @details * Inputs : none @@ -1369,7 +1369,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInFlowRateOverride function resets the override of the \n + * The testResetMeasuredDialInFlowRateOverride function resets the override of the * measured dialIn flow rate. * @details * Inputs : none @@ -1392,7 +1392,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialInPumpRotorSpeedOverride function overrides the measured \n + * The testSetMeasuredDialInPumpRotorSpeedOverride function overrides the measured * dialIn pump rotor speed. * @details * Inputs : none @@ -1416,7 +1416,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInPumpRotorSpeedOverride function resets the override of the \n + * The testResetMeasuredDialInPumpRotorSpeedOverride function resets the override of the * measured dialIn pump rotor speed. * @details * Inputs : none @@ -1439,7 +1439,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialInPumpSpeedOverride function overrides the measured \n + * The testSetMeasuredDialInPumpSpeedOverride function overrides the measured * dialIn pump motor speed. * @details * Inputs : none @@ -1463,7 +1463,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInPumpSpeedOverride function resets the override of the \n + * The testResetMeasuredDialInPumpSpeedOverride function resets the override of the * measured dialIn pump motor speed. * @details * Inputs : none @@ -1486,7 +1486,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialInPumpMCSpeedOverride function overrides the measured \n + * The testSetMeasuredDialInPumpMCSpeedOverride function overrides the measured * dialIn pump motor speed. * @details * Inputs : none @@ -1510,7 +1510,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInPumpMCSpeedOverride function resets the override of the \n + * The testResetMeasuredDialInPumpMCSpeedOverride function resets the override of the * measured dialIn pump motor speed. * @details * Inputs : none @@ -1533,7 +1533,7 @@ /*********************************************************************//** * @brief - * The testSetMeasuredDialInPumpMCCurrentOverride function overrides the measured \n + * The testSetMeasuredDialInPumpMCCurrentOverride function overrides the measured * dialIn pump motor current. * @details * Inputs : none @@ -1557,7 +1557,7 @@ /*********************************************************************//** * @brief - * The testResetMeasuredDialInPumpMCCurrentOverride function resets the override of the \n + * The testResetMeasuredDialInPumpMCCurrentOverride function resets the override of the * measured dialIn pump motor current. * @details * Inputs : none