Skip to content

Commit d47a6db

Browse files
committed
nicla-system: Add documentation about charging rate.
1 parent f7845c2 commit d47a6db

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

libraries/Nicla_System/src/Nicla_System.h

+6-2
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,13 @@ class nicla {
7474
static bool enterShipMode();
7575

7676
/**
77-
* @brief Enables fast charging of the battery.
77+
* @brief Enables fast charging of the battery. By default charging is already enabled when the board is powered.
78+
* The default charging current without enabling fast charging is 10mA. Charging can be disabled by calling disableCharging().
7879
*
79-
* @param mA The desired milliampere (mA) charging current. Range: 5mA - 35mA and 40mA - 300mA. The default is 20mA.
80+
* @param mA The desired milliampere (mA) charging current. Range: 5mA - 35mA and 40mA - 300mA. The default value is 20mA.
81+
* A safe default charging current value that works for most common LiPo batteries is 0.5C, which means charging at a rate equal to half of the battery's capacity.
82+
* For example, a 200mAh battery could be charged at 100mA (0.1A).
83+
* This charging rate is generally safe for most LiPo batteries and provides a good balance between charging speed and battery longevity.
8084
* @param disableNtc Whether to disable Temperature Sense and interrupt on charge. The default is true.
8185
* @return true If the fast charging is enabled successfully. False, otherwise.
8286
*/

0 commit comments

Comments
 (0)