Index: firmware/App/HDCommon.h =================================================================== diff -u -r55d1b02cb04e5bac3cc15d277a426e3472c82ce8 -r6460f430884c2e4a3d27a5309bb19bd963a43975 --- firmware/App/HDCommon.h (.../HDCommon.h) (revision 55d1b02cb04e5bac3cc15d277a426e3472c82ce8) +++ firmware/App/HDCommon.h (.../HDCommon.h) (revision 6460f430884c2e4a3d27a5309bb19bd963a43975) @@ -7,8 +7,8 @@ * * @file HDCommon.h * -* @author (last) Sean Nash -* @date (last) 24-Aug-2023 +* @author (last) Dara Navaei +* @date (last) 02-Feb-2024 * * @author (original) Sean * @date (original) 27-Feb-2020 @@ -58,59 +58,59 @@ /// Payload record structure for an HD versions message. typedef struct { - U08 major; - U08 minor; - U08 micro; - U16 build; - U08 fpgaId; - U08 fpgaMajor; - U08 fpgaMinor; - U08 fpgaLab; - U32 compatibilityRev; + U08 major; ///< HD version major revision. + U08 minor; ///< HD version minor revision. + U08 micro; ///< HD version micro revision. + U16 build; ///< HD build version. + U08 fpgaId; ///< HD FPGA ID. + U08 fpgaMajor; ///< HD FPGA major revision. + U08 fpgaMinor; ///< HD FPGA minor revision. + U08 fpgaLab; ///< HD FPGA lab revision. + U32 compatibilityRev; ///< HD compatibility revision. } HD_VERSIONS_T; /// DG version struct. typedef struct { - 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 - U32 compatibilityRev; ///< DG compatibility revision + 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. + U32 compatibilityRev; ///< DG compatibility revision. } DG_VERSIONS_T; /// Record defining the fields in a UI version request message. typedef struct { - U08 major; ///< Major version for UI software - U08 minor; ///< Minor version for UI software - U08 micro; ///< Micro version for UI software - U16 build; ///< Build number for UI software - U32 compatibility; ///< Compatibility revision + U08 major; ///< Major version for UI software. + U08 minor; ///< Minor version for UI software. + U08 micro; ///< Micro version for UI software. + U16 build; ///< Build number for UI software. + U32 compatibility; ///< Compatibility revision. } UI_VERSIONS_T; /// Payload record structure for a peristaltic pump data message. typedef struct { - U32 setPoint; - F32 measFlow; - F32 measRotorSpd; - F32 measPumpSpd; - F32 measMCSpd; - F32 measMCCurr; - F32 pwmDC; + U32 setPoint; ///< Set point. + F32 measFlow; ///< Measured flow in mL/min. + F32 measRotorSpd; ///< Measured rotor speed in RPM. + F32 measPumpSpd; ///< Measured pump speed in RPM. + F32 measMCSpd; ///< Measured motor speed in RPM. + F32 measMCCurr; ///< Measured motor current in Amps. + F32 pwmDC; ///< Duty cycle. } PERISTALTIC_PUMP_STATUS_PAYLOAD_T; /// Payload record structure for a pump set point override message. typedef struct { - BOOL reset; - S32 setPt; - U32 ctrlMode; + BOOL reset; ///< Reset. + S32 setPt; ///< Set point. + U32 ctrlMode; ///< Control mode. } OVERRIDE_PUMP_SET_PT_PAYLOAD_T; #pragma pack(pop)