Added the full_scale and MAX17044 example.

Author: PaulZC

README.md

@@ -8,6 +8,10 @@ MAX17044 is configured for a dual-cell 2S pack.
 
 This Arduino library provides support for both devices.
 
+## Thanks
+
+Parts of this library were based on / inspired by [Daniel Porrey's max1704x library](https://github.com/porrey/max1704x). Thank you Daniel.
+
 ## Repository Contents
 
 - **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.

examples/Example1_Simple/Example1_Simple.ino

@@ -34,7 +34,7 @@ void setup()
 	Serial.begin(115200); // Start serial, to output debug data
   while (!Serial)
     ; //Wait for user to open terminal
-  Serial.println(F("MAX17043 / MAX17044 Example"));
+  Serial.println(F("MAX17043 Example"));
 
   Wire.begin();
 
@@ -43,7 +43,7 @@ void setup()
   // Set up the MAX17043 LiPo fuel gauge:
   if (lipo.begin() == false) // Connect to the MAX17043 using the default wire port
   {
-    Serial.println(F("MAX17043 / MAX17044 not detected. Please check wiring. Freezing."));
+    Serial.println(F("MAX17043 not detected. Please check wiring. Freezing."));
     while (1)
       ;
   }

examples/Example2_AlternatePorts/Example2_AlternatePorts.ino

@@ -38,7 +38,7 @@ void setup()
 	mySerial.begin(115200); // Start serial, to output debug data
   while (!mySerial)
     ; //Wait for user to open terminal
-  mySerial.println(F("MAX17043 / MAX17044 Example"));
+  mySerial.println(F("MAX17043 Example"));
 
   myWire.begin();
 
@@ -47,7 +47,7 @@ void setup()
   // Set up the MAX17043 LiPo fuel gauge:
   if (lipo.begin(myWire) == false) // Connect to the MAX17043 using non-standard wire port
   {
-    mySerial.println(F("MAX17043 / MAX17044 not detected. Please check wiring. Freezing."));
+    mySerial.println(F("MAX17043 not detected. Please check wiring. Freezing."));
     while (1)
       ;
   }

examples/Example3_MAX17044/Example3_MAX17044.ino

@@ -0,0 +1,83 @@
+/******************************************************************************
+Example3_MAX17044
+By: Paul Clark
+Date: October 23rd 2020
+
+Based extensively on:
+MAX17043_Simple_Serial.cpp
+SparkFun MAX17043 Example Code
+Jim Lindblom @ SparkFun Electronics
+Original Creation Date: June 22, 2015
+
+This file demonstrates how to talk to the MAX17044 using the SparkFun MAX17043 Arduino library.
+
+This example will print the gauge's voltage and state-of-charge (SOC) readings
+to Serial (115200 baud)
+
+This code is released under the MIT license.
+
+Distributed as-is; no warranty is given.
+******************************************************************************/
+
+#include <Wire.h> // Needed for I2C
+
+#include <SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library.h> // Click here to get the library: http://librarymanager/All#SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library
+
+SFE_MAX1704X lipo(10); // The MAX17044 has a full-scale voltage of 10V. Specify it here. (int)
+
+double voltage = 0; // Variable to keep track of LiPo voltage
+double soc = 0; // Variable to keep track of LiPo state-of-charge (SOC)
+bool alert; // Variable to keep track of whether alert has been triggered
+
+void setup()
+{
+	Serial.begin(115200); // Start serial, to output debug data
+  while (!Serial)
+    ; //Wait for user to open terminal
+  Serial.println(F("MAX17044 Example"));
+
+  Wire.begin();
+
+  lipo.enableDebugging(); // Uncomment this line to enable helpful debug messages on Serial
+
+  // Set up the MAX17044 LiPo fuel gauge:
+  if (lipo.begin() == false) // Connect to the MAX17044 using the default wire port
+  {
+    Serial.println(F("MAX17044 not detected. Please check wiring. Freezing."));
+    while (1)
+      ;
+  }
+
+	// Quick start restarts the MAX17044 in hopes of getting a more accurate
+	// guess for the SOC.
+	lipo.quickStart();
+
+	// We can set an interrupt to alert when the battery SoC gets too low.
+	// We can alert at anywhere between 1% - 32%:
+	lipo.setThreshold(20); // Set alert threshold to 20%.
+}
+
+void loop()
+{
+	// lipo.getVoltage() returns a voltage value (e.g. 7.86)
+	voltage = lipo.getVoltage();
+	// lipo.getSOC() returns the estimated state of charge (e.g. 79%)
+	soc = lipo.getSOC();
+	// lipo.getAlert() returns a 0 or 1 (0=alert not triggered)
+	alert = lipo.getAlert();
+
+	// Print the variables:
+	Serial.print("Voltage: ");
+	Serial.print(voltage);  // Print the battery voltage
+	Serial.println(" V");
+
+	Serial.print("Alert: ");
+	Serial.println(alert);
+
+	Serial.print("Percentage: ");
+	Serial.print(soc); // Print the battery state of charge
+	Serial.println(" %");
+	Serial.println();
+
+	delay(500);
+}

src/SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library.cpp

@@ -20,9 +20,10 @@ Distributed as-is; no warranty is given.
 ******************************************************************************/
 #include "SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library.h"
 
-SFE_MAX1704X::SFE_MAX1704X()
+SFE_MAX1704X::SFE_MAX1704X(int full_scale)
 {
   // Constructor
+  _full_scale = full_scale;
 }
 
 boolean SFE_MAX1704X::begin(TwoWire &wirePort)
@@ -75,10 +76,14 @@ float SFE_MAX1704X::getVoltage()
 {
   uint16_t vCell;
   vCell = read16(MAX17043_VCELL);
-  // vCell is a 12-bit register where each bit represents 1.25mV
+  // vCell is a 12-bit register where each bit represents:
+  // 1.25mV on the MAX17043
+  // 2.5mV on the MAX17044
   vCell = (vCell) >> 4;
 
-  return ((float) vCell / 800.0);
+  float divider = 4000 / _full_scale;
+
+  return (((float)vCell) / divider);
 }
 
 float SFE_MAX1704X::getSOC()

src/SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library.h

@@ -77,7 +77,7 @@ Distributed as-is; no warranty is given.
 class SFE_MAX1704X
 {
 public:
-  SFE_MAX1704X();
+  SFE_MAX1704X(int full_scale = 5); // Default to a full-scale of 5V for the MAX17043. Select 10 for the MAX17044.
 
   // begin() - Initializes the MAX17043.
   boolean begin(TwoWire &wirePort = Wire); //Returns true if module is detected
@@ -171,6 +171,8 @@ class SFE_MAX1704X
   Stream *_debugPort;			 //The stream to send debug messages to if enabled. Usually Serial.
   boolean _printDebug = false; //Flag to print debugging variables
 
+  int _full_scale = 5; // Default to a full-scale of 5V for the MAX17043. Select 10 for the MAX17044.
+
   // write16([data], [address]) - Write 16 bits to the requested address. After
   // writing the address to be written, two sequential 8-bit writes will occur.
   // the msb is written first, then lsb.