Index: firmware/App/Drivers/Battery.h =================================================================== diff -u -re319bb5b8fd8a5320c0bb30986764f9b8f3c0814 -r07567ddfe7c20f07160446b50881588ed814c149 --- firmware/App/Drivers/Battery.h (.../Battery.h) (revision e319bb5b8fd8a5320c0bb30986764f9b8f3c0814) +++ firmware/App/Drivers/Battery.h (.../Battery.h) (revision 07567ddfe7c20f07160446b50881588ed814c149) @@ -32,43 +32,43 @@ /// Payload record structure for battery status data broadcast message typedef struct { - U32 RemainingCapacity; - U32 BatteryStatus; - U32 BatteryChargerStatus; + U32 RemainingCapacity; ///< Remaining capacity. + U32 BatteryStatus; ///< Battery status. + U32 BatteryChargerStatus; ///< Battery charge status. } BATTERY_STATUS_PAYLOAD_T; /// Payload record structure for battery module data broadcast message typedef struct { - U32 RemainingCapacityAlarm; - U32 RemainingTimeAlarm; - U32 BatteryMode; - U32 AtRate; - U32 AtRateTimeToFull; - U32 AtRateTimeToEmpty; - U32 AtRateOK; - U32 Temperature; - U32 Voltage; - U32 Current; - U32 AverageCurrent; - U32 MaxError; - U32 RelativeStateOfCharge; - U32 AbsoluteStateOfCharge; - U32 FullChargeCapacity; - U32 RunTimeToEmpty; - U32 AverageTimeToEmpty; - U32 AverageTimeToFull; - U32 ChargingCurrent; - U32 ChargingVoltage; - U32 CycleCount; - U32 DesignCapacity; - U32 DesignVoltage; - U32 SpecificationInfo; - U32 ManufactureDate; - U32 SerialNumber; - U32 ManufacturerName; - U32 DeviceName; - U32 DeviceChemistry; + U32 RemainingCapacityAlarm; ///< Remaining capacity alarm. + U32 RemainingTimeAlarm; ///< Remaining time alarm. + U32 BatteryMode; ///< Battery mode. + U32 AtRate; ///< At rate. + U32 AtRateTimeToFull; ///< At rate time to full. + U32 AtRateTimeToEmpty; ///< At rate time to empty. + U32 AtRateOK; ///< At rate ok. + U32 Temperature; ///< Temperature. + U32 Voltage; ///< Voltage. + U32 Current; ///< Current. + U32 AverageCurrent; ///< Average current. + U32 MaxError; ///< Max error. + U32 RelativeStateOfCharge; ///< Relative state of charge. + U32 AbsoluteStateOfCharge; ///< Absolute state of charge. + U32 FullChargeCapacity; ///< Full charge capacity. + U32 RunTimeToEmpty; ///< Run time to empty. + U32 AverageTimeToEmpty; ///< Average time to empty. + U32 AverageTimeToFull; ///< Average time to full. + U32 ChargingCurrent; ///< Charging current. + U32 ChargingVoltage; ///< Charging voltage. + U32 CycleCount; ///< Cycle count. + U32 DesignCapacity; ///< Design capacity. + U32 DesignVoltage; ///< Design voltage. + U32 SpecificationInfo; ///< Specification information. + U32 ManufactureDate; ///< Manufacture date. + U32 SerialNumber; ///< Serial number. + U32 ManufacturerName; ///< Manufacturer name. + U32 DeviceName; ///< Device name. + U32 DeviceChemistry; ///< Device chemistry. } BATTERY_MANAGER_PAYLOAD_T; // ********** public function prototypes **********