Add min max current functions

Author: sebromero

examples/Battery/Battery.ino

@@ -58,52 +58,59 @@ void setup() {
    }
 
    battery.resetMaximumMinimumVoltage();
+   battery.resetMaximumMinimumCurrent();
 }
 
 void printTimeToEmpty(){
    auto timeToEmptySeconds = battery.timeToEmpty();
    if(timeToEmptySeconds == -1){
-      Serial.println("* Time to empty: N/A");
+      Serial.println("* ⏱️ Time to empty: N/A");
       return;
    }
    auto timeToEmptyHours = timeToEmptySeconds / 3600;
    timeToEmptySeconds = timeToEmptySeconds % 3600;
    auto timeToEmptyMinutes = timeToEmptySeconds / 60;
    timeToEmptySeconds = timeToEmptySeconds % 60;
-   Serial.println("* Time to empty: " + String(timeToEmptyHours) + "h " + String(timeToEmptyMinutes) + "m " + String(timeToEmptySeconds) + "s");
+   Serial.println("* ⏱️ Time to empty: " + String(timeToEmptyHours) + "h " + String(timeToEmptyMinutes) + "m " + String(timeToEmptySeconds) + "s");
 }
 
 void printTimeToFull(){
    auto timeToFullSeconds = battery.timeToFull();
    if(timeToFullSeconds == -1){
-      Serial.println("* Time to full: N/A");
+      Serial.println("* ⏱️ Time to full: N/A");
       return;
    }
    auto timeToFullHours = timeToFullSeconds / 3600;
    timeToFullSeconds = timeToFullSeconds % 3600;
    auto timeToFullMinutes = timeToFullSeconds / 60;
    timeToFullSeconds = timeToFullSeconds % 60;
-   Serial.println("* Time to full: " + String(timeToFullHours) + "h " + String(timeToFullMinutes) + "m " + String(timeToFullSeconds) + "s");
+   Serial.println("* ⏱️ Time to full: " + String(timeToFullHours) + "h " + String(timeToFullMinutes) + "m " + String(timeToFullSeconds) + "s");
 }
 
 void loop() {
    bool batteryConnected = battery.isConnected();
-   Serial.println("* Battery is connected: " + ( batteryConnected ? String("Yes") : String("No")));
+   Serial.println("* 🔌 Battery is connected: " + ( batteryConnected ? String("Yes") : String("No")));
 
    if(batteryConnected){
-      Serial.println("* Battery is empty: " + ( battery.isEmpty() ? String("Yes") : String("No")));
-      Serial.println("* Is fully charged: " + ( battery.isFullyCharged() ? String("Yes") : String("No")));
-      Serial.println("* Voltage: " + String(battery.voltage()) + " V");
-      Serial.println("* Average Voltage: " + String(battery.averageVoltage()) + " V");
-      Serial.println("* Minimum Voltage: " + String(battery.minimumVoltage()) + " V");
-      Serial.println("* Maximum Voltage: " + String(battery.maximumVoltage()) + " V");
-      Serial.println("* Current: " + String(battery.current()) + " mA");
-      Serial.println("* Average Current: " + String(battery.averageCurrent()) + " mA");
-      Serial.println("* Percentage: " + String(battery.percentage()) + "%");
-      Serial.println("* Remaining Capacity: " + String(battery.remainingCapacity()) + " mAh");
-      Serial.println("* Full Capacity: " + String(battery.fullCapacity()) + " mAh");
-      Serial.println("* Internal Temperature: " + String(battery.internalTemperature()) + "°C");
-      Serial.println("* Average internal Temperature: " + String(battery.averageInternalTemperature()) + "°C");
+      Serial.println("* 🪫 Battery is empty: " + ( battery.isEmpty() ? String("Yes") : String("No")));
+      Serial.println("* 💯 Charging complete: " + ( battery.chargingComplete() ? String("Yes") : String("No")));
+      
+      Serial.println("* ⚡️ Voltage: " + String(battery.voltage()) + " V");
+      Serial.println("* ⚡️ Average Voltage: " + String(battery.averageVoltage()) + " V");
+      Serial.println("* ⚡️ Minimum Voltage since reset: " + String(battery.minimumVoltage()) + " V");
+      Serial.println("* ⚡️ Maximum Voltage since reset: " + String(battery.maximumVoltage()) + " V");
+      Serial.println("* ⚡️ Current: " + String(battery.current()) + " mA");
+      Serial.println("* ⚡️ Average Current: " + String(battery.averageCurrent()) + " mA");
+      Serial.println("* ⚡️ Minimum Current since reset (160mA resolution): " + String(battery.minimumCurrent()) + " mA");
+      Serial.println("* ⚡️ Maximum Current since reset (160mA resolution): " + String(battery.maximumCurrent()) + " mA");
+      Serial.println("* ⚡️ Power: " + String(battery.power()) + " mW");
+      Serial.println("* ⚡️ Average Power: " + String(battery.averagePower()) + " mW");
+
+      Serial.println("* 🔋 Percentage: " + String(battery.percentage()) + "%");
+      Serial.println("* 🔋 Remaining Capacity: " + String(battery.remainingCapacity()) + " mAh");
+      Serial.println("* 🔋 Full Capacity: " + String(battery.fullCapacity()) + " mAh");
+      Serial.println("* 🌡️ Internal Temperature: " + String(battery.internalTemperature()) + "°C");
+      Serial.println("* 🌡️ Average internal Temperature: " + String(battery.averageInternalTemperature()) + "°C");
       printTimeToEmpty();
       printTimeToFull();
       Serial.println();

src/Battery.cpp

@@ -255,6 +255,39 @@ int16_t Battery::averageCurrent(){
   return (int16_t)readRegister16Bits(this->wire, FUEL_GAUGE_ADDRESS, AVG_CURRENT_REG) * CURRENT_MULTIPLIER_MA;
 }
 
+int16_t Battery::minimumCurrent(){
+  if(!isConnected()){
+    return -1;
+  }
+
+  uint16_t registerValue = readRegister16Bits(this->wire, FUEL_GAUGE_ADDRESS, MAXMIN_CURRENT_REG);
+  if(registerValue == MAXMIN_CURRENT_INITIAL_VALUE){
+    return 0; // The minimum current is not valid
+  }
+
+  int8_t lowerByte = static_cast<int8_t>( registerValue & 0xFF);
+  return static_cast<int16_t>(lowerByte * MAXMIN_CURRENT_MULTIPLIER_MA);
+}
+
+int16_t Battery::maximumCurrent(){
+  if(!isConnected()){
+    return -1;
+  }
+
+  uint16_t registerValue = readRegister16Bits(this->wire, FUEL_GAUGE_ADDRESS, MAXMIN_CURRENT_REG);
+  if(registerValue == MAXMIN_CURRENT_INITIAL_VALUE){
+    return 0; // The minimum current is not valid
+  }
+
+  // The maximum current is stored in the upper byte
+  int8_t upperByte = static_cast<int8_t>( registerValue >> 8);  
+  return static_cast<int16_t>(upperByte * MAXMIN_CURRENT_MULTIPLIER_MA);
+}
+
+bool Battery::resetMaximumMinimumCurrent(){
+  return writeRegister16Bits(this->wire, FUEL_GAUGE_ADDRESS, MAXMIN_CURRENT_REG, MAXMIN_CURRENT_INITIAL_VALUE) == 0;
+}
+
 int16_t Battery::power(){
   if(!isConnected()){
     return -1;

src/Battery.h

@@ -109,6 +109,27 @@ class Battery {
         */
         int16_t averageCurrent();
 
+        /**
+         * @brief Reads the minimum current values measured since the last device reset.
+         * Note: The resolution of the minimum current value is 160mA so the value
+         * is rounded to the nearest 160mA.
+         * @return The minimum current values in milli amperes (mA).
+         */
+        int16_t minimumCurrent();
+
+        /**
+         * @brief Reads the maximum current values measured since the last device reset.
+         * Note: The resolution of the minimum current value is 160mA so the value
+         * is rounded to the nearest 160mA.
+         * @return The maximum current values in milli amperes (mA).
+         */
+        int16_t maximumCurrent();
+
+        /**
+         * @brief Resets the minimum and maximum current values.
+         * @return True if the minimum and maximum current values were successfully reset, false otherwise.
+        */
+        bool resetMaximumMinimumCurrent();
 
         /**
          * @brief Reads the current power of the battery in milliwatts (mW).

src/BatteryConstants.h

@@ -4,10 +4,12 @@
 
 // Initial Values (for resetting registers)
 #define MAXMIN_VOLT_INITIAL_VALUE 0x00FF
+#define MAXMIN_CURRENT_INITIAL_VALUE 0x807F
 
 // Conversion factors (See section "ModelGauge m5 Register Standard Resolutions" in the datasheet)
 #define VOLTAGE_MULTIPLIER_MV (1.25 / 16) // Resolution: 78.125 μV per LSB
 #define CURRENT_MULTIPLIER_MA 0.15625 // Resolution: 0.15625 mA per LSB for MAX17262R
+#define MAXMIN_CURRENT_MULTIPLIER_MA 160 // Resolution: 160mA per LSB
 #define CAPACITY_MULTIPLIER_MAH 0.5 // Resolution: 0.5mAh per LSB for MAX17262R
 #define PERCENTAGE_MULTIPLIER (1.0 / 256) // Resolution: 1/256% per LSB
 #define TIME_MULTIPLIER_S 5.625 // Resolution: 5.625 seconds per LSB
@@ -49,6 +51,7 @@
 #define AT_RATE_REG 0x04
 #define CURRENT_REG 0x0A // The MAX17262 uses internal current sensing to monitor the current through the SYS pin. The measurement value is stored in two's-complement format.
 #define AVG_CURRENT_REG 0x0B // The AvgCurrent register reports an average of Current register readings.
+#define MAXMIN_CURRENT_REG 0x1C // The MaxMinCurr register maintains the maximum and minimum Current register values since the last IC reset or until cleared by host software.
 #define TTE_REG 0x11 // The TTE register holds the estimated time to empty for the application under present temperature and load conditions. TTE register is only valid when current register is negative.
 #define TTF_REG 0x20 // The TTF register holds the estimated time to full for the application under present conditions. The TTF register is only valid when the current register is positive.
 #define TIMER_REG 0x3E