Index: firmware/App/Controllers/DGInterface.c =================================================================== diff -u -rc7e52b747bfff771037094ac6419141d901e179a -r1a685471524555a374854c0c9ec8e208e71fe2df --- firmware/App/Controllers/DGInterface.c (.../DGInterface.c) (revision c7e52b747bfff771037094ac6419141d901e179a) +++ firmware/App/Controllers/DGInterface.c (.../DGInterface.c) (revision 1a685471524555a374854c0c9ec8e208e71fe2df) @@ -8,7 +8,7 @@ * @file DGInterface.c * * @author (last) Sean Nash -* @date (last) 08-Sep-2020 +* @date (last) 24-Sep-2020 * * @author (original) Sean * @date (original) 08-Apr-2020 @@ -91,9 +91,8 @@ /*********************************************************************//** * @brief * The initDGInterface function initializes the DGInterface module. - * @details - * Inputs : none - * Outputs : DGInterface module initialized. + * @details Inputs: none + * @details Outputs: DGInterface module initialized. * @return none *************************************************************************/ void initDGInterface( void ) @@ -112,9 +111,8 @@ * @brief * The initTreatmentReservoirMgmt function initializes the treatment reservoir * management state machine. - * @details - * Inputs : none - * Outputs : treatment reservoir management state machine initialized. + * @details Inputs: none + * @details Outputs: treatment reservoir management state machine initialized. * @return none *************************************************************************/ void initTreatmentReservoirMgmt( void ) @@ -129,9 +127,8 @@ * @brief * The execTreatmentReservoirMgmt function executes the state machine for the * reservoir management during treatment mode. - * @details - * Inputs : none - * Outputs : DG reservoirs (drains & fills) managed. + * @details Inputs: none + * @details Outputs: DG reservoirs (drains & fills) managed. * @return none *************************************************************************/ void execTreatmentReservoirMgmt( void ) @@ -259,9 +256,8 @@ /*********************************************************************//** * @brief * The getDGOpMode function gets the current DG operating mode. - * @details - * Inputs : dgCurrentOpMode - * Outputs : none + * @details Inputs: dgCurrentOpMode + * @details Outputs: none * @return Current DG operating mode. *************************************************************************/ DG_OP_MODE_T getDGOpMode( void ) @@ -272,9 +268,8 @@ /*********************************************************************//** * @brief * The getDGSubMode function gets the current DG operating sub-mode. - * @details - * Inputs : dgSubMode - * Outputs : none + * @details Inputs: dgSubMode + * @details Outputs: none * @return Current DG operating sub-mode. *************************************************************************/ U32 getDGSubMode( void ) @@ -285,9 +280,8 @@ /*********************************************************************//** * @brief * The getDGActiveReservoir function gets the current active reservoir. - * @details - * Inputs : dgActiveReservoirSet - * Outputs : none + * @details Inputs: dgActiveReservoirSet + * @details Outputs: none * @return Currently commanded active reservoir. *************************************************************************/ DG_RESERVOIR_ID_T getDGActiveReservoir( void ) @@ -299,9 +293,8 @@ * @brief * The getDGPressure function gets the latest pressure reported by the DG * for a given pressure sensor. - * @details - * Inputs : dgPressures[] - * Outputs : none + * @details Inputs: dgPressures[] + * @details Outputs: none * @param sensorID pressure sensor we are getting reading for * @return Latest pressure reading reported by DG for the given sensor. *************************************************************************/ @@ -325,9 +318,8 @@ * @brief * The getDGROPumpPressureSetPt function gets the latest RO pump * pressure set point reported by the DG. - * @details - * Inputs : dgROPumpPressureSetPtPSI - * Outputs : none + * @details Inputs: dgROPumpPressureSetPtPSI + * @details Outputs: none * @return Latest RO pump pressure set point reported by DG. *************************************************************************/ U32 getDGROPumpPressureSetPt( void ) @@ -341,9 +333,8 @@ * @brief * The getDGROPumpFlowRateMlMin function gets the latest RO pump flow * rate reported by the DG. - * @details - * Inputs : dgROPumpFlowRateMlMin - * Outputs : none + * @details Inputs: dgROPumpFlowRateMlMin + * @details Outputs: none * @return Latest RO pump flow rate reported by DG. *************************************************************************/ F32 getDGROPumpFlowRateMlMin( void ) @@ -357,9 +348,8 @@ * @brief * The getDGDrainPumpRPMSetPt function gets the latest drain pump RPM * set point reported by the DG. - * @details - * Inputs : dgDrainPumpSpeedSetPtRPM - * Outputs : none + * @details Inputs: dgDrainPumpSpeedSetPtRPM + * @details Outputs: none * @return Latest drain pump RPM set point reported by DG. *************************************************************************/ U32 getDGDrainPumpRPMSetPt( void ) @@ -373,9 +363,8 @@ * @brief * The setDGOpMode function sets the latest DG operating mode reported by * the DG. - * @details - * Inputs : none - * Outputs : dgCurrentOpMode + * @details Inputs: none + * @details Outputs: dgCurrentOpMode * @param opMode operating mode reported by DG * @param subMode sub-mode (current state) of operating mode reported by DG * @return none @@ -397,9 +386,8 @@ * @brief * The setDialysateTemperatureReadings function sets the latest dialysate * temperatures reported by the DG. - * @details - * Inputs : none - * Outputs : dgDialysateTemp, dgRedundantDialysateTemp + * @details Inputs: none + * @details Outputs: dgDialysateTemp, dgRedundantDialysateTemp * @param temp1 dialysate temperature reported by DG * @param temp2 redundant dialysate temperature reported by DG * @return none @@ -414,9 +402,8 @@ * @brief * The setDGDialysateTemperatures function sets the latest temperature data * reported by the DG. - * @details - * Inputs : none - * Outputs : dgPrimaryTemp, dgTrimmerTemp + * @details Inputs: none + * @details Outputs: dgPrimaryTemp, dgTrimmerTemp * @param primaryHtrTemp Primary heater temperature reported by DG * @param trimmerHtrTemp Trimmer heater temperature reported by DG * @return none @@ -431,9 +418,8 @@ * @brief * The setDGReservoirsData function sets the latest reservoir data * reported by the DG. - * @details - * Inputs : none - * Outputs : dgActiveReservoir, dgReservoirFillVolumeTarget, dgReservoirDrainVolumeTarget + * @details Inputs: none + * @details Outputs: dgActiveReservoir, dgReservoirFillVolumeTarget, dgReservoirDrainVolumeTarget * @param resID ID of active reservoir * @param fillVol Reservoir fill to volume reported by DG * @param drainVol Reservoir drain to volume reported by DG @@ -456,9 +442,8 @@ /*********************************************************************//** * @brief * The setDGPressures function sets the latest pressures reported by the DG. - * @details - * Inputs : none - * Outputs : dgPressures[] + * @details Inputs: none + * @details Outputs: dgPressures[] * @param roIn latest RO pump inlet pressure reported by DG * @param roOut latest RO pump outlet pressure reported by DG * @param drainIn latest drain pump inlet pressure reported by DG @@ -476,9 +461,8 @@ /*********************************************************************//** * @brief * The setDGROPumpData function sets the latest RO pump data reported by the DG. - * @details - * Inputs : none - * Outputs : dgROPumpPressureSetPtPSI, dgROPumpFlowRateMlMin + * @details Inputs: none + * @details Outputs: dgROPumpPressureSetPtPSI, dgROPumpFlowRateMlMin * @param presSetPt latest RO pump pressure set point reported by DG * @param flowRate latest RO pump flow rate (LPM) reported by DG * @return none @@ -492,9 +476,8 @@ /*********************************************************************//** * @brief * The setDGDrainPumpData function sets the latest drain pump data reported by the DG. - * @details - * Inputs : none - * Outputs : dgDrainPumpSpeedSetPtRPM + * @details Inputs: none + * @details Outputs: dgDrainPumpSpeedSetPtRPM * @param rpmSetPt latest drain pump RPM set point reported by DG * @return none *************************************************************************/ @@ -507,9 +490,8 @@ * @brief * The cmdSetDGDialysateTargetTemps function sends a target dialysate * temperature command message to the DG. - * @details - * Inputs : none - * Outputs : dgPrimaryTempSet, dgTrimmerTempSet + * @details Inputs: none + * @details Outputs: dgPrimaryTempSet, dgTrimmerTempSet * @param primaryHtrTemp commanded target dialysate temperature for the primary heater * @param trimmerHtrTemp commanded target dialysate temperature for the trimmer heater * @return none @@ -525,9 +507,8 @@ * @brief * The cmdStartDG function sends a start command to the DG. DG will transition * from standby to recirculate mode and start producing warm, pure water. - * @details - * Inputs : none - * Outputs : start DG command sent + * @details Inputs: none + * @details Outputs: start DG command sent * @return none *************************************************************************/ void cmdStartDG( void ) @@ -540,9 +521,8 @@ * @brief * The cmdStopDG function sends a stop command to the DG. DG will transition * from recirculate mode to standby mode. Pumps and heater go off. - * @details - * Inputs : none - * Outputs : stop DG command sent + * @details Inputs: none + * @details Outputs: stop DG command sent * @return none *************************************************************************/ void cmdStopDG( void ) @@ -555,9 +535,8 @@ * @brief * The cmdStartDGTrimmerHeater function sends a start trimmer heater command * to the DG. - * @details - * Inputs : none - * Outputs : start DG trimmer heater command sent + * @details Inputs: none + * @details Outputs: start DG trimmer heater command sent * @return none *************************************************************************/ void cmdStartDGTrimmerHeater( void ) @@ -570,9 +549,8 @@ * @brief * The cmdStopDGTrimmerHeater function sends a stop trimmer heater command * to the DG. - * @details - * Inputs : none - * Outputs : stop DG trimmer heater command sent + * @details Inputs: none + * @details Outputs: stop DG trimmer heater command sent * @return none *************************************************************************/ void cmdStopDGTrimmerHeater( void ) @@ -585,9 +563,8 @@ * @brief * The cmdSetDGActiveReservoir function sends a set active reservoir command * message to the DG. - * @details - * Inputs : none - * Outputs : set active reservoir command sent to DG. + * @details Inputs: none + * @details Outputs: set active reservoir command sent to DG. * @param resID ID of reservoir to set as active (reservoir for HD to draw from) * @return none *************************************************************************/ @@ -607,9 +584,8 @@ /*********************************************************************//** * @brief * The cmdStartDGFill function sends a fill command message to the DG. - * @details - * Inputs : none - * Outputs : fill command sent to DG. + * @details Inputs: none + * @details Outputs: fill command sent to DG. * @param fillToVolMl volume (in mL) to fill inactive reservoir to * @return none *************************************************************************/ @@ -622,9 +598,8 @@ /*********************************************************************//** * @brief * The cmdStartDGDrain function sends a drain command message to the DG. - * @details - * Inputs : none - * Outputs : drain command sent to DG. + * @details Inputs: none + * @details Outputs: drain command sent to DG. * @param drainToVolMl volume (in mL) to drain inactive reservoir to * @return none *************************************************************************/ @@ -637,9 +612,8 @@ /*********************************************************************//** * @brief * The cmdDGSampleWater function sends a sample water command message to the DG. - * @details - * Inputs : none - * Outputs : sample water command sent to DG. + * @details Inputs: none + * @details Outputs: sample water command sent to DG. * @return none *************************************************************************/ void cmdDGSampleWater( void )