u-blox / battery-charger-bq24295

Dependents:   example-battery-charger-bq24295 example-C030-out-of-box-demo example-C030-out-of-box-demo Amit

Files at this revision

API Documentation at this revision

Comitter:
rob.meades@u-blox.com
Date:
Wed Aug 02 13:33:58 2017 +0100
Parent:
7:cc08662947cd
Commit message:
Add comment concerning the response to getChargerState() on a C030 board and removed spurious "/".

Changed in this revision

battery_charger_bq24295.h Show annotated file Show diff for this revision Revisions of this file
bq24295.cpp Show annotated file Show diff for this revision Revisions of this file
--- a/battery_charger_bq24295.h	Wed Jun 14 17:35:12 2017 +0100
+++ b/battery_charger_bq24295.h	Wed Aug 02 13:33:58 2017 +0100
@@ -83,6 +83,9 @@
     bool init (I2C * pI2c, uint8_t address = BATTERY_CHARGER_BQ24295_ADDRESS);
 
     /** Get the charger state.
+    * Note: on a u-blox C030 board with no battery connected this will report
+    *       CHARGER_STATE_COMPLETE or CHARGER_STATE_FAST_CHARGE rather than
+    *       CHARGER_STATE_NOT_CHARGING.
     * @return the charge state.
     */
     ChargerState getChargerState(void);
--- a/bq24295.cpp	Wed Jun 14 17:35:12 2017 +0100
+++ b/bq24295.cpp	Wed Aug 02 13:33:58 2017 +0100
@@ -262,7 +262,7 @@
     return isPresent;
 }
 
-/// Enable charging.
+// Enable charging.
 bool BatteryChargerBq24295::enableCharging (void)
 {
     bool success = false;