You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -95,19 +95,19 @@ Charging a LiPo battery is done in three stages. This library allows you to moni
95
95
***Constant Voltage** - Third phase of the charging process where the battery is kept at the fully charged voltage and current is slowly decreased to the *end of charge current*.
96
96
97
97
#### Get charger status
98
-
You can find out what stage the charger is in by calling the `getChargeStatus()` method.
98
+
You can find out what stage the charger is in by calling the `getState()` method.
99
99
100
100
It will return a value of *ChargeStatus* which can be one of the above:
101
-
*`PRECHARGE` - First stage of the charging process
102
-
*`FAST_CHARGE_CC` - Second stage of the charging process
103
-
*`FAST_CHARGE_CV` - Last stage of the charging process
104
-
*`END_OF_CHARGE` - If the battery is still connected, the charger will ensure it's kept at 4.2V by topping up the voltage to avoid self discharge.
105
-
*`DONE` - Battery is fully charged
106
-
*`TIMER_FAULT` - The timer that is monitoring the charge status has encountered an error.
107
-
*`THERMISTOR_SUSPEND` - Charging was suspended due to overheating
108
-
*`OFF` - Charger is disabled
109
-
*`BATTERY_OVERVOLTAGE` - Charging was suspended due to an overvoltage fault
110
-
*`LINEAR_ONLY` - in this state, the charger is bypassed completely and the USB voltage is powering the board
101
+
*`preCharge` - First stage of the charging process
102
+
*`fastChargeConstantCurrent` - Second stage of the charging process
103
+
*`fastChargeConstantVoltage` - Last stage of the charging process
104
+
*`endOfCharge` - If the battery is still connected, the charger will ensure it's kept at 4.2V by topping up the voltage to avoid self discharge.
105
+
*`done` - Battery is fully charged
106
+
*`timerFaultError` - The timer that is monitoring the charge status has encountered an error.
107
+
*`thermistorSuspendError` - Charging was suspended due to overheating
108
+
*`chargerDisabled` - Charger is disabled
109
+
*`batteryOvervoltageError` - Charging was suspended due to an overvoltage fault
110
+
*`chargerBypassed` - in this state, the charger is bypassed completely and the USB voltage is powering the board
111
111
112
112
#### Set charging parameters
113
113
This library allows you to change the following charging parameters of the charging process. Please be careful with these and make sure they are supported by the battery you are using as the wrong values might damage your board or the battery.
0 commit comments