Merge pull request #680 from sebromero/sebromero/pmic-fix

[AE-74] Revamp Battery API for Nicla Sense ME

Author: sebromero

libraries/Nicla_System/examples/NiclaSenseME_BatteryChargingSimple/NiclaSenseME_BatteryChargingSimple.ino

@@ -0,0 +1,90 @@
+/*
+ * This example shows how to use the Nicla Sense ME library to charge a battery.
+ * 
+ * The LED color will change depending on the battery's operating status:
+ * - Blue: Ready
+ * - Yellow: Charging
+ * - Green: Charging complete
+ * - Red: Error
+ * 
+ * Instructions:
+ * 1. Connect a single cell (3.7V nominal) LiPo/Li-Ion battery to the board via battery connector (J4) or the pin header (J3).
+ * 2. Configure the charge current in the setup() function.
+ * 3. Upload this sketch to your Nicla Sense ME board.
+ * 
+ * Initial author: Sebastian Romero @sebromero
+ */
+
+#include "Nicla_System.h"
+
+constexpr auto printInterval { 10000ul };
+float voltage = -1.0f;
+
+void setup(){
+  Serial.begin(115200);
+  for (const auto timeout = millis() + 2500; millis() < timeout && !Serial; delay(250));
+  nicla::begin(); // Initialise library
+  nicla::leds.begin(); // Start I2C connection to LED driver
+  nicla::setBatteryNTCEnabled(true); // Set to false if your battery doesn't have a NTC.
+  
+  /*
+  Set the maximum charging time to 9 hours. This helps to prevent overcharging.
+  Set this to a lower value (e.g. 3h) if your battery will be done with charging sooner.
+  To get an estimation of the charging time, you can use the following formula:
+  Charging time (in hours) = (Battery capacity in mAh) / (0.8 * Charging current in mA)
+  This formula takes into account that the charging process is approximately 80% efficient (hence the 0.8 factor). 
+  This is just a rough estimate, and actual charging time may vary depending on factors like the charger, battery quality, and charging conditions.
+  */
+  nicla::configureChargingSafetyTimer(ChargingSafetyTimerOption::NineHours);
+  
+  /* 
+  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.
+  For example, a 200mAh battery could be charged at 100mA (0.1A). 
+  */
+  nicla::enableCharging(100);
+
+  nicla::leds.setColor(blue);
+}
+
+void loop(){
+
+  static auto updateTimestamp = millis();
+
+  if (millis() - updateTimestamp >= printInterval) {
+    updateTimestamp = millis();
+
+    float currentVoltage = nicla::getCurrentBatteryVoltage();
+    if(currentVoltage != voltage){
+      voltage = currentVoltage;    
+      Serial.print("\nVoltage: ");
+      Serial.println(voltage);      
+    } else {
+      Serial.print(".");
+    }
+
+    auto operatingStatus = nicla::getOperatingStatus();
+
+    switch(operatingStatus) {
+      case OperatingStatus::Charging:
+      nicla::leds.setColor(255,100,0); // Yellow
+        break;
+      case OperatingStatus::ChargingComplete:
+        nicla::leds.setColor(green);
+        
+        // This will stop further charging until enableCharging() is called again.
+        nicla::disableCharging();
+        break;
+      case OperatingStatus::Error:
+        nicla::leds.setColor(red);
+        break;
+      case OperatingStatus::Ready:
+        nicla::leds.setColor(blue);
+        break;
+      default:
+        nicla::leds.setColor(off);
+        break;
+    }
+
+  }
+}