Index: firmware/App/Services/SystemCommMessages.c =================================================================== diff -u -r44cc25461e4936f7928904640c87a03ef7cf3c16 -rdaf8d5b60c753becab80cbaf164aac0e49d533a2 --- firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision 44cc25461e4936f7928904640c87a03ef7cf3c16) +++ firmware/App/Services/SystemCommMessages.c (.../SystemCommMessages.c) (revision daf8d5b60c753becab80cbaf164aac0e49d533a2) @@ -51,23 +51,24 @@ typedef struct { - U32 alarmState; // 0 = no alarms, 1 = low priority, 2 = medium priority, 3 = high priority - U32 alarmTop; // ID of top active alarm - U32 escalatesIn; // seconds - U32 silenceExpiresIn; // seconds - U16 alarmsFlags; // bit flags: 1 = true, 0 = false for each bit + U32 alarmState; //< 0 = no alarms, 1 = low priority, 2 = medium priority, 3 = high priority + U32 alarmTop; //< ID of top active alarm + U32 escalatesIn; //< seconds + U32 silenceExpiresIn; //< seconds + U16 alarmsFlags; //< bit flags: 1 = true, 0 = false for each bit } ALARM_COMP_STATUS_PAYLOAD_T; - + +/// DG version data typedef struct { - U08 major; - U08 minor; - U08 micro; - U16 build; - U08 fpgaId; - U08 fpgaMajor; - U08 fpgaMinor; - U08 fpgaLab; + U08 major; ///< Major + U08 minor; ///< Minor + U08 micro; ///< Micro + U16 build; ///< Build number + U08 fpgaId; ///< FPGA ID + U08 fpgaMajor; ///< FPGA major + U08 fpgaMinor; ///< FPGA minor + U08 fpgaLab; ///< FPGA lab } DG_VERSIONS_T; typedef struct @@ -84,21 +85,23 @@ F32 loadCellB1inGram; F32 loadCellB2inGram; } LOAD_CELL_DATA_T; - + +/// RO pump data typedef struct { - F32 roPumpTgtPressure; - F32 measROFlowRate; - F32 roPumpPWM; - U32 roPumpState; + F32 roPumpTgtPressure; ///< RO pump target pressure + F32 measROFlowRate; ///< RO pump measured flow rate + F32 roPumpPWM; ///< RO pump PWM duty cycle + U32 roPumpState; ///< RO pump current state } RO_PUMP_DATA_T; - + +/// Drain pump data typedef struct { - U32 setDrainPumpSpeed; - U32 dacValue; - F32 deltaPressure; - U32 drainPState; + U32 setDrainPumpSpeed; ///< Drain pump set speed + U32 dacValue; ///< Drain pump DAC value + F32 deltaPressure; ///< Drain pump delta pressure + U32 drainPState; ///< Drain pump state } DRAIN_PUMP_DATA_T; typedef struct @@ -115,25 +118,28 @@ U32 fillToVolumeMl; U32 drainToVolumeMl; } RESERVOIR_DATA_T; - + +/// Target temperature of the heaters data typedef struct { - F32 targetPrimaryHeaterTemp; - F32 targetTrimmerHeaterTemp; + F32 targetPrimaryHeaterTemp; ///< Target primary heater temperature + F32 targetTrimmerHeaterTemp; ///< Target trimmer heater temperature } TARGET_TEMPS_PAYLOAD_T; - + +/// Heaters data typedef struct { - U32 mainPrimayHeaterDC; - U32 smallPrimaryHeaterDC; - U32 trimmerHeaterDC; + U32 mainPrimayHeaterDC; ///< Main primary heater duty cycle + U32 smallPrimaryHeaterDC; ///< Small primary heater duty cycle + U32 trimmerHeaterDC; ///< Trimmer heater duty cycle } HEATERS_DATA_T; +/// Heat disinfect data typedef struct { - U32 internalState; - F32 elapsedTimeMins; - U32 currentCycle; + U32 internalState; ///< Internal state of heat disinfect state machine + F32 elapsedTimeMins; ///< Heat disinfect elapsed time in minutes + U32 currentCycle; ///< Current cycle of the heat disinfect } DG_HEAT_DISINFECT_DATA_T; #pragma pack(pop)