Index: firmware/App/Controllers/DGInterface.h =================================================================== diff -u -r563f516a81cb41290008f93b33e7cf5e121717db -r1240b612f790f931825aba86ec37f37eccce9336 --- firmware/App/Controllers/DGInterface.h (.../DGInterface.h) (revision 563f516a81cb41290008f93b33e7cf5e121717db) +++ firmware/App/Controllers/DGInterface.h (.../DGInterface.h) (revision 1240b612f790f931825aba86ec37f37eccce9336) @@ -40,75 +40,75 @@ /// Enumeration of DG pressure sensors. typedef enum DG_PressureSensors { - DG_PRESSURE_SENSOR_RO_PUMP_INLET = 0, ///< RO pump pressure sensor. - DG_PRESSURE_SENSOR_RO_PUMP_OUTLET, ///< RO pump pressure sensor. - DG_PRESSURE_SENSOR_DRAIN_PUMP_INLET, ///< Drain pump inlet pressure. - DG_PRESSURE_SENSOR_DRAIN_PUMP_OUTLET, ///< Drain pump outlet pressure. - NUM_OF_DG_PRESSURE_SENSORS ///< Number of pressure sensors. + DG_PRESSURE_SENSOR_RO_PUMP_INLET = 0, ///< RO pump pressure sensor + DG_PRESSURE_SENSOR_RO_PUMP_OUTLET, ///< RO pump pressure sensor + DG_PRESSURE_SENSOR_DRAIN_PUMP_INLET, ///< Drain pump inlet pressure + DG_PRESSURE_SENSOR_DRAIN_PUMP_OUTLET, ///< Drain pump outlet pressure + NUM_OF_DG_PRESSURE_SENSORS ///< Number of pressure sensors } DG_PRESSURE_SENSORS_T; /// Payload record structure for an RO pump data message. typedef struct { - U32 setPtPSI; - F32 measFlowRateMlMin; - F32 setPWMDutyCyclePct; + U32 setPtPSI; ///< RO pump set target pressure + F32 measFlowRateMlMin; ///< RO pump measured flow rate in mL per min + F32 setPWMDutyCyclePct; ///< RO pump set PWM duty cycle percent } DG_RO_PUMP_DATA_PAYLOAD_T; /// Payload record structure for a drain pump data message. typedef struct { - U32 setPtRPM; - F32 setDAC; + U32 setPtRPM; ///< Drain pump set RPM value + F32 setDAC; ///< Drain pump set DAC value } DG_DRAIN_PUMP_DATA_PAYLOAD_T; /// Payload record structure for a DG pressures data message. typedef struct { - F32 roInPSI; - F32 roOutPSI; - F32 drainInPSI; - F32 drainOutPSI; + F32 roInPSI; ///< DG inlet pressure in PSI + F32 roOutPSI; ///< DG outlet pressure in PSI + F32 drainInPSI; ///< DG drain inlet pressure in PSI + F32 drainOutPSI; ///< DG drain outlet pressure in PSI } DG_PRESSURES_DATA_PAYLOAD_T; /// Payload record structure for a reservoirs data message. typedef struct { - U32 resID; - U32 setFillToVolumeMl; - U32 setDrainToVolumeMl; + U32 resID; ///< Active reservoir ID + U32 setFillToVolumeMl; ///< Reservoir set fill to target volume in ml + U32 setDrainToVolumeMl; ///< Reservoir set drain to target volume in ml } DG_RESERVOIRS_DATA_PAYLOAD_T; /// Payload record structure for DG temperature sensors data message. typedef struct { - F32 TPi; - F32 TPo; - F32 TD1; - F32 TD2; - F32 TRo; - F32 TDi; - F32 HtrPrimThermo; - F32 HtrTrimThermo; - F32 HtrPrimColdJunc; - F32 HtrTrimColdJunc; - F32 HtrPrimInternal; - F32 HtrTrimInternal; + F32 TPi; ///< Inlet primary heaters temperature sensor + F32 TPo; ///< Outlet primary heaters temperature sensor + F32 TD1; ///< Conductivity sensor 1 temperature sensor + F32 TD2; ///< Conductivity sensor 2 temperature sensor + F32 TRo; ///< Outlet redundant temperature sensor + F32 TDi; ///< Inlet dialysate temperature sensor + F32 HtrPrimThermo; ///< Primary heaters internal temperature sensor + F32 HtrTrimThermo; ///< Trimmer heater internal temperature sensor + F32 HtrPrimColdJunc; ///< Primary heaters cold junction temperature sensor + F32 HtrTrimColdJunc; ///< Trimmer heater cold junction temperature sensor + F32 HtrPrimInternal; ///< Primary heaters internal temperature + F32 HtrTrimInternal; ///< Trimmer heater internal temperature } DG_TEMPERATURES_T; /// Payload record structure for a drain reservoir command message. typedef struct { - U32 drainToVolumeML; - BOOL tareLoadCells; + U32 drainToVolumeML; ///< Drain to target volume in ml + BOOL tareLoadCells; ///< Flag indicates to tare load cells or not } DRAIN_RESERVOIR_CMD_PAYLOAD_T; /// DG command response data record structure. typedef struct { - U32 commandID; ///< The command DG is responding to - BOOL rejected; ///< Flag indicates if the command has been rejected - U32 rejectCode; ///< Reason code for rejecting the command + U32 commandID; ///< The command DG is responding to + BOOL rejected; ///< Flag indicates if the command has been rejected + U32 rejectCode; ///< Reason code for rejecting the command } DG_CMD_RESPONSE_T; // ********** public function prototypes **********