Index: firmware/App/Services/MessagePayloads.h =================================================================== diff -u -r92ec01cb48d91fe7315baa987e1aa051dd12df75 -r5e0cd9b5be11ff4b2acaadbdcafc4ffe05172aa1 --- firmware/App/Services/MessagePayloads.h (.../MessagePayloads.h) (revision 92ec01cb48d91fe7315baa987e1aa051dd12df75) +++ firmware/App/Services/MessagePayloads.h (.../MessagePayloads.h) (revision 5e0cd9b5be11ff4b2acaadbdcafc4ffe05172aa1) @@ -17,109 +17,124 @@ #ifndef __MESSAGE_PAYLOADS_H__ #define __MESSAGE_PAYLOADS_H__ + +/** + * @defgroup MessagePayloads MessagePayloads + * @brief Message payloads service module defines the content for system communication message. + * + * @addtogroup MessagePayloads + * @{ + */ // ********** public definitions ********** #pragma pack(push,1) +/// Alarm status struct. 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; ///< Alarm state: 0 = no alarms, 1 = low priority, 2 = medium priority, 3 = high priority + U32 alarmTop; ///< ID of top active alarm + U32 escalatesIn; ///< Seconds before escalating alarm + U32 silenceExpiresIn; ///< Seconds before alarm silence expires + U16 alarmsFlags; ///< Alarm bit flags: 1 = true, 0 = false for each bit } ALARM_COMP_STATUS_PAYLOAD_T; +/// DG version struct. typedef struct { - U08 major; - U08 minor; - U08 micro; - U16 build; - U08 fpgaId; - U08 fpgaMajor; - U08 fpgaMinor; - U08 fpgaLab; + U08 major; ///< DG version major revision + U08 minor; ///< DG version major revision + U08 micro; ///< DG version micro revision + U16 build; ///< DG build version + U08 fpgaId; ///< DG FPGA ID + U08 fpgaMajor; ///< DG FPGA major revision + U08 fpgaMinor; ///< DG FPGA minor revision + U08 fpgaLab; ///< DG FPGA lab revision } DG_VERSIONS_T; +/// Treatment time data struct. typedef struct { - U32 treatmentTimePrescribedinSec; - U32 treatmentTimeElapsedinSec; - U32 treatmentTimeRemaininginSec; + U32 treatmentTimePrescribedinSec; ///< Treatment time in seconds + U32 treatmentTimeElapsedinSec; ///< Treatment time elapsed in seconds + U32 treatmentTimeRemaininginSec; ///< Treatment time remaining in seconds } TREATMENT_TIME_DATA_T; +/// Loadcell measurements struct. typedef struct { - F32 loadCellA1inGram; - F32 loadCellA2inGram; - F32 loadCellB1inGram; - F32 loadCellB2inGram; + F32 loadCellA1inGram; ///< Loadcell A1 measurement in gram + F32 loadCellA2inGram; ///< Loadcell A2 measurement in gram + F32 loadCellB1inGram; ///< Loadcell B1 measurement in gram + F32 loadCellB2inGram; ///< Loadcell B2 measurement in gram } LOAD_CELL_DATA_T; +/// RO pump data struct. typedef struct { - U32 setROPumpPressure; - F32 measROFlowRate; - F32 roPumpPWM; + U32 setROPumpPressure; ///< RO pump pressure set target + F32 measROFlowRate; ///< RO flow rate measurement + F32 roPumpPWM; ///< RO pump pwm } RO_PUMP_DATA_T; +/// Drain pump data struct. typedef struct { - U32 setDrainPumpSpeed; - U32 dacValue; + U32 setDrainPumpSpeed; ///< Drain pump speed set target + U32 dacValue; ///< Drain pump DAC value } DRAIN_PUMP_DATA_T; +/// Pressure data struct. typedef struct { - F32 roPumpInletPressure; - F32 roPumpOutletPressure; - F32 drainPumpInletPressure; - F32 drainPumpOutletPressure; + F32 roPumpInletPressure; ///< RO pump inlet pressure + F32 roPumpOutletPressure; ///< RO pump outlet pressure + F32 drainPumpInletPressure; ///< Drain pump inlet pressure + F32 drainPumpOutletPressure; ///< Drain pump outlet pressure } PRESSURES_DATA_T; +/// Conductivity data struct. typedef struct { - F32 roRejectionRatio; - F32 cpi; - F32 cpo; + F32 roRejectionRatio; ///< RO rejection ratio + F32 cpi; ///< CPi conductivity sensor value + F32 cpo; ///< CPo conductivity sensor value } CONDUCTIVITY_DATA_T; +/// Reservoir data struct. typedef struct { - U32 activeReservoir; - U32 fillToVolumeMl; - U32 drainToVolumeMl; + U32 activeReservoir; ///< Active reservoir ID + U32 fillToVolumeMl; ///< Volume target to fill to + U32 drainToVolumeMl; ///< Volume target to drain to } RESERVOIR_DATA_T; +/// Target temperature payload struct. typedef struct { - F32 targetPrimaryHeaterTemp; - F32 targetTrimmerHeaterTemp; + F32 targetPrimaryHeaterTemp; ///< Primary heater set temperature target + F32 targetTrimmerHeaterTemp; ///< Trimmer heater set temperature target } TARGET_TEMPS_PAYLOAD_T; +/// Heaters data struct. typedef struct { - U32 mainPrimayHeaterDC; - U32 smallPrimaryHeaterDC; - U32 trimmerHeaterDC; + U32 mainPrimayHeaterDC; ///< Main primary heater DC + U32 smallPrimaryHeaterDC; ///< Small primary heater DC + U32 trimmerHeaterDC; ///< Trimmer heater DC } HEATERS_DATA_T; +/// Accelerometer calibration data struct. typedef struct { - F32 gain; - F32 offset; -} LINEAR_F32_CAL_PAYLOAD_T; - -typedef struct -{ - F32 xOffset; - F32 yOffset; - F32 zOffset; + F32 xOffset; ///< Accelerometer calibration x-offset + F32 yOffset; ///< Accelerometer calibration y-offset + F32 zOffset; ///< Accelerometer calibration z-offset } ACCEL_CAL_PAYLOAD_T; #pragma pack(pop) + +/**@}*/ #endif -