# Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor
## Overview
Low cost Lithium Polymer batteries have revolutionized electronics - they're thin, they're light, they can be regulated down to 3.3V and they're easy to charge. On your phone, there's a little image of a battery cell that tells you the percentage of charge - so you know when you absolutely need to plug it in and when you can stay untethered.
The **Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor ** does the same thing. Connect it to your [Lipoly or LiIon battery](https://www.adafruit.com/category/916) and it will let you know the voltage of the cell, it does the annoying math of decoding the non-linear voltage to get you a valid percentage as well!
Since this nice chip is I2C, it works with any and all microcontroller or microcomputer boards, from the Arduino UNO up to the Raspberry Pi. And you don't have to worry about logic level, as the gauge runs with 3.3V or 5.0V power and logic equally fine.
To use, [connect a 1S 3.7-4.2V Lithium Ion or Polymer battery](https://www.adafruit.com/category/916) to one of the JST 2 PH ports (either one). Then use a [JST PH jumper cable](https://www.adafruit.com/product/4714) to connect to your boost converter, Feather, whatever! Use the I2C interface and our [Arduino](https://github.com/adafruit/Adafruit_MAX1704X) or [CircuitPython/Python](https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x) library code to read the voltage and percentage whenever you like. There are various alerts, low power modes that can be customized as desired.
To get you going fast, we spun up a custom-made PCB in the[ **STEMMA QT** form factor](https://www.adafruit.com/?q=stemma%20qt%20sensor "STEMMA QT form factor"), making it easy to interface with. The [STEMMA QT connectors](https://learn.adafruit.com/introducing-adafruit-stemma-qt/what-is-stemma-qt) on either side are compatible with the [SparkFun Qwiic](https://www.sparkfun.com/qwiic) I2C connectors. This allows you to make solderless connections between your development board and the MAX17048 or to chain it with a wide range of other sensors and accessories using a [**compatible cable**](https://www.adafruit.com/?q=stemma%20qt%20cable). [QT Cable is not included, but we have a variety in the shop](https://www.adafruit.com/?q=stemma+qt+cable&sort=BestMatch)
# Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor
## Pinouts
The default I2C address is **0x36**.
## Power Pins
- **VIN** - The chip can safely run from 3-5VDC. To power the board, give it the same power as the logic level of your microcontroller - e.g. for a 5V microcontroller like Arduino, use 5V.
- **Bat** - Output from the battery input voltage.
- **GND** - common ground for power and logic.
Info:
## I2C Logic Pins
- **SCL ** - This is the I2C **clock pin** **SCL** , connect to your microcontroller's I2C clock line. There's a **10K pullup** on this pin.
- **SDI ** - This is the I2C **data pin** **SDA** , connect to your microcontroller's I2C data line. There's a **10K pullup** on this pin.
- **[STEMMA QT](https://learn.adafruit.com/introducing-adafruit-stemma-qt) - **These connectors allow you to connect to dev boards with **STEMMA QT** connectors or to other things with [various associated accessories](https://www.adafruit.com/?q=JST%20SH%204)
## JST Ports
Theres are two JST ports, they are equivalent. Connect the battery to either one, then the load/charger to the other. **Watch out for battery polarity if not using an Adafruit battery!**
Info:
## Other Pins
- **INT ** - Interrupt signal out, you can set this up to pull low when the voltage or percentage drops below a threshold. Pulled up to VIN with a 10K resistor.
- **QStart ** - Quick-start input. It allows reset of the MAX17048 through hardware.
## Power LED and Jumper
- **Power LED -** This LED is a green LED located on the front of the board. It is labeled **on**.
- **LED jumper** - This jumper is located on the back of the board. Cut the trace on this jumper to cut power to the "on" LED.
# Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor
## Python & CircuitPython
It's easy to use the **MAX17048** with Python or CircuitPython, and the [Adafruit\_CircuitPython\_MAX1704x](https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x) module. This module allows you to easily write Python code that reads the values from the **MAX17048**'s battery monitoring and alert functions. You can use this sensor with any CircuitPython microcontroller board or with a computer that has GPIO and Python [thanks to Adafruit\_Blinka, our CircuitPython-for-Python compatibility library](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux).
## CircuitPython Microcontroller Wiring
First, wire up a MAX17048 to your board exactly as shown below. Here's an example of wiring a Feather M4 to the sensor with I2C using one of the handy [**STEMMA QT**](https://learn.adafruit.com/introducing-adafruit-stemma-qt) connectors:
**STEMMA**
- **Board 3V** to **sensor VIN (red wire)**
- **Board GND** to **sensor**** GND (black wire)**
- **Board SCL** to **sensor**** SCL (yellow wire)**
- **Board SDA** to **sensor**** SDA (blue wire)**
**Battery**
- Plug a 3.7/4.2V lithium polymer or lithium ion rechargeable battery into **either of the JST battery ports on the board**.
- Plug the other **board JST Battery port** into the **Feather JST port ** using the cable included with the board.
You can also use standard **0.100" pitch** headers to wire it up on a breadboard:
**STEMMA**
- **Board 3V** to **sensor VIN (red wire)**
- **Board GND** to **sensor**** GND (black wire)**
- **Board SCL** to **sensor**** SCL (yellow wire)**
- **Board SDA** to **sensor**** SDA (blue wire)**
**Battery**
- Plug a 3.7/4.2V lithium polymer or lithium ion rechargeable battery into **either of the JST battery ports on the board**.
- Plug the other **board JST Battery port** into the **Feather JST port ** using the cable included with the board.
Warning:
## Python Computer Wiring
Since there's _dozens_ of Linux computers/boards you can use, below shows wiring for Raspberry Pi. For other platforms, [please visit the guide for CircuitPython on Linux to see whether your platform is supported](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux).
Here's the Raspberry Pi wired to the sensor using I2C and a [**STEMMA QT**](https://learn.adafruit.com/introducing-adafruit-stemma-qt) connector:
- **Pi 3V** to **sensor**** VIN (red wire)**
- **Pi GND** to **sensor**** GND (black wire)**
- **Pi SCL** to **sensor**** SCL (yellow wire)**
- **Pi SDA** to **sensor**** SDA (blue wire)**
Plug a 3.7/4.2V lithium polymer or lithium ion rechargeable battery into either of the JST battery ports.
Finally here is an example of how to wire up a Raspberry Pi to the sensor using a solderless breadboard:
- **Pi 3V** to **sensor**** VIN (red wire)**
- **Pi GND** to **sensor**** GND (black wire)**
- **Pi SCL** to **sensor**** SCL (yellow wire)**
- **Pi SDA** to **sensor**** SDA (blue wire)**
Plug a 3.7/4.2V lithium polymer or lithium ion rechargeable battery into either of the JST battery ports.
## Python Installation of MAX1704X Library
You'll need to install the **Adafruit\_Blinka** library that provides the CircuitPython support in Python. This may also require enabling I2C on your platform and verifying you are running Python 3. [Since each platform is a little different, and Linux changes often, please visit the CircuitPython on Linux guide to get your computer ready](https://learn.adafruit.com/circuitpython-on-raspberrypi-linux)!
Once that's done, from your command line run the following command:
- `pip3 install adafruit-circuitpython-max1704x`
If your default Python is version 3, you may need to run `pip` instead. Make sure you aren't trying to use CircuitPython on Python 2.x, it isn't supported!
## CircuitPython Usage
To use with CircuitPython, you need to first install the MAX1704X library, and its dependencies, into the **lib** folder on your **CIRCUITPY** drive. Then you need to update **code.py** with the example script.
Thankfully, we can do this in one go. In the example below, click the **Download Project Bundle** button below to download the necessary libraries and the **code.py** file in a zip file. Extract the contents of the zip file, and copy the **entire** **lib** **folder** and the **code.py** file to your **CIRCUITPY** drive.
Your **CIRCUITPY/lib** folder should contain the following folders and file:
- **adafruit\_bus\_device/**
- **adafruit\_register/**
- **adafruit\_max1704x.mpy**
## Python Usage
Once you have the library `pip3` installed on your computer, copy or download the following example to your computer, and run the following, replacing **code.py** with whatever you named the file:
`python3 code.py`
## Example Code - Simple Test
https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x/blob/main/examples/max1704x_simpletest.py
**If running CircuitPython:** Once everything is saved to the **CIRCUITPY** drive, [connect to the serial console](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) to see the data printed out!
**If running Python: ** The console output will appear wherever you are running Python.
In the **max1704x\_simpletest.py ** example, the MAX17048 is instantiated on I2C. The chip version and chip ID is printed to the REPL.
In the loop, the battery's voltage and charge percentage is printed to the REPL every second.
## Example Code - Advanced Test
https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x/blob/main/examples/max1704x_advanced.py
In the **max1704x\_advanced.py** example, the MAX17048 is instantiated on I2C. The chip version and chip ID is printed to the REPL along with thresholds for the alerts that are available in the library.
In the loop, the battery's voltage, charge percentage and any active alerts are printed to the REPL every second.
Voltage High Alert:
Voltage Low Alert:
Hibernating Alert:
# Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor
## Python Docs
# Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor
## Arduino
Using the MAX17048 with Arduino involves wiring up the sensor to your Arduino-compatible microcontroller, installing the [Adafruit\_MAX1704X](https://github.com/adafruit/Adafruit_MAX1704X) library and running the provided example code.
## Wiring
Wire as shown for a **5V** board like an Uno. If you are using a ** 3V** board, like an Adafruit Feather, wire the board's 3V pin to the MAX17048 VIN.
Here is an Adafruit Metro wired up to the MAX17048 using the STEMMA QT connector:
- **Board 5V** to **sensor **** VIN (red wire)**
- **Board GND** to **sensor** **GND (black wire)**
- **Board SCL** to **sensor** **SCL (yellow wire)**
- **Board SDA** to **sensor** **SDA (blue wire)**
Plug a 3.7/4.2V lithium polymer or lithium ion rechargable battery into either of the JST battery ports.
Here is an Adafruit Metro wired up using a solderless breadboard:
- **Board 5V** to **sensor**** ****VIN (red wire)**
- **Board GND** to **sensor** **GND (black wire)**
- **Board SCL** to **sensor** **SCL (yellow wire)**
- **Board SDA** to **sensor** **SDA (blue wire)**
Plug a 3.7/4.2V lithium polymer or lithium ion rechargable battery into either of the JST battery ports.
## Library Installation
You can install the **Adafruit MAX1704X ** library for Arduino using the Library Manager in the Arduino IDE.
Click the **Manage Libraries ...** menu item, search for **Adafruit MAX1704X** , and select the **Adafruit MAX1704X** library:
If asked about dependencies, click "Install all".
If the "Dependencies" window does not come up, then you already have the dependencies installed.
Warning:
## Example Code - Basic
https://github.com/adafruit/Adafruit_MAX1704X/blob/main/examples/MAX17048_basic/MAX17048_basic.ino
Upload the sketch to your board and open up the Serial Monitor ( **Tools -\> Serial Monitor** ) at 115200 baud. You should see the battery's voltage and charge percentage being printed out. You'll see the values change depending on the battery's status.
## Example Code - Advanced
https://github.com/adafruit/Adafruit_MAX1704X/blob/main/examples/MAX17048_advanced/MAX17048_advanced.ino
Upload the sketch to your board and open up the Serial Monitor ( **Tools -\> Serial Monitor** ) at 115200 baud. You should see the battery's voltage, charge percentage, charge/discharge rate and any alert status messages being printed out. You'll see the values change depending on the battery's status.
# Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor
## Arduino Docs
# Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor
## WipperSnapper
## What is WipperSnapper
WipperSnapper is a firmware designed to turn any WiFi-capable board into an Internet-of-Things device without programming a single line of code. WipperSnapper connects to [Adafruit IO](https://io.adafruit.com/), a web platform designed ([by Adafruit!](https://www.adafruit.com/about)) to _display_, _respond_, and _interact_ with your project's data.
Simply load the WipperSnapper firmware onto your board, add credentials, and plug it into power. Your board will automatically register itself with your Adafruit IO account.
From there, you can add _components_ to your board such as buttons, switches, potentiometers, sensors, and more! Components are _dynamically _added to hardware, so you can immediately start interacting, logging, and streaming the data your projects produce without writing code.
If you've never used WipperSnapper, click below to read through the quick start guide before continuing.
[Quickstart: Adafruit IO WipperSnapper](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper)
## Wiring
First, wire up a MAX17048 to your board exactly as follows (note that some boards might already have the sensor integrated on the PCB).
Here is an example of the MAX17048 wired to an [Adafruit ESP32 Feather V2](https://www.adafruit.com/product/5400) using I2C [with a STEMMA QT cable (no soldering required)](https://www.adafruit.com/product/4210)
- **Board 3V** to **sensor VIN (red wire on STEMMA QT)**
- **Board GND** to **sensor GND (black wire on STEMMA QT)**
- **Board SCL** to **sensor SCL (yellow wire on STEMMA QT)**
- **Board SDA** to **sensor SDA (blue wire on STEMMA QT)**
## Usage
Connect your board to Adafruit IO Wippersnapper and **[navigate to the WipperSnapper board list](https://io.adafruit.com/wippersnapper).**
On this page, **select the WipperSnapper board you're using** to be brought to the board's interface page.
If you do not see your board listed here - you need [to connect your board to Adafruit IO](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper) first.
On the device page, quickly **check that you're running the latest version of the WipperSnapper firmware**.
The device tile on the left indicates the version number of the firmware running on the connected board.
- **If the firmware version is green with a checkmark -** continue with this guide.
- **If the firmware version is red with an exclamation mark "!" -** [update to the latest WipperSnapper firmware](https://learn.adafruit.com/quickstart-adafruit-io-wippersnapper) on your board before continuing.
Next, make sure the sensor is plugged into your board and click the ** I2C Scan ** button.
You should see the MAX17048's default I2C address of `0x36` pop-up in the I2C scan list.
### I don't see the sensor's I2C address listed!
First, double-check the connection and/or wiring between the sensor and the board.
Then, reset the board and let it re-connect to Adafruit IO WipperSnapper.
With the sensor detected in an I2C scan, you're ready to add the sensor to your board.
**Click the New Component button or the + button** to bring up the component picker.
Adafruit IO supports a large amount of components. To quickly find your sensor, type `MAX17048` into the search bar, then select the **MAX17048** component.
On the component configuration page, the MAX17048's sensor address should be listed along with the sensor's settings.
The **Send Every** option is specific to each sensor's measurements. This option will tell the Feather how often it should read from the MAX17048 sensor and send the data to Adafruit IO. Measurements can range from every 30 seconds to every 24 hours.
For this example, set the **Send Every ** interval to every 30 seconds.
Your device interface should now show the sensor components you created. After the interval you configured elapses, WipperSnapper will automatically read values from the sensor(s) and send them to Adafruit IO.
To view the data that has been logged from the sensor, click on the graph next to the sensor name.
Here you can see the feed history and edit things about the feed such as the name, privacy, webhooks associated with the feed and more. If you want to learn more about how feeds work, [check out this page](https://learn.adafruit.com/all-the-internet-of-things-episode-four-adafruit-io/advanced-feeds).
# Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor
## Downloads
## Files
- [MAX17048 Datasheet](https://cdn-learn.adafruit.com/assets/assets/000/114/607/original/MAX17048-MAX17049.pdf?1661966692)
- [EagleCAD PCB files on GitHub](https://github.com/adafruit/Adafruit-MAX17048-PCB)
- [3D models on GitHub](https://github.com/adafruit/Adafruit_CAD_Parts/tree/main/5580%20MAX17048)
- [Fritzing object in the Adafruit Fritzing Library](https://github.com/adafruit/Fritzing-Library/blob/master/parts/Adafruit%20MAX17048%20LiPoly%20LiIon%20Fuel%20Gauge%20and%20Battery%20Monitor.fzpz)
## Schematic and Fab Print
# 3D Model
## Primary Products
### Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor
[Adafruit MAX17048 LiPoly / LiIon Fuel Gauge and Battery Monitor](https://www.adafruit.com/product/5580)
Low cost Lithium Polymer batteries have revolutionized electronics - they're thin, they're light, they can be regulated down to 3.3V and they're easy to charge. On your phone, there's a little image of a battery cell that tells you the percentage of charge - so you know when...
In Stock
[Buy Now](https://www.adafruit.com/product/5580)
[Related Guides to the Product](https://learn.adafruit.com/products/5580/guides)
## Featured Products
### STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long
[STEMMA QT / Qwiic JST SH 4-Pin Cable - 50mm Long](https://www.adafruit.com/product/4399)
This 4-wire cable is 50mm / 1.9" long and fitted with JST SH female 4-pin connectors on both ends. Compared with the chunkier JST PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
Out of Stock
[Buy Now](https://www.adafruit.com/product/4399)
[Related Guides to the Product](https://learn.adafruit.com/products/4399/guides)
### STEMMA QT / Qwiic JST SH 4-pin Cable with Premium Female Sockets
[STEMMA QT / Qwiic JST SH 4-pin Cable with Premium Female Sockets](https://www.adafruit.com/product/4397)
This 4-wire cable is a little over 150mm / 6" long and fitted with JST-SH female 4-pin connectors on one end and premium female headers on the other. Compared with the chunkier JST-PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4397)
[Related Guides to the Product](https://learn.adafruit.com/products/4397/guides)
### STEMMA QT / Qwiic JST SH 4-pin to Premium Male Headers Cable
[STEMMA QT / Qwiic JST SH 4-pin to Premium Male Headers Cable](https://www.adafruit.com/product/4209)
This 4-wire cable is a little over 150mm / 6" long and fitted with JST-SH female 4-pin connectors on one end and premium Dupont male headers on the other. Compared with the chunkier JST-PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4209)
[Related Guides to the Product](https://learn.adafruit.com/products/4209/guides)
### JST SH 4-pin Cable with Alligator Clips - STEMMA QT / Qwiic
[JST SH 4-pin Cable with Alligator Clips - STEMMA QT / Qwiic](https://www.adafruit.com/product/4398)
This cable will make it super easy to use our plug-and-play STEMMA QT boards with boards like Circuit Playground. On one end you get a Qwiic / STEMMA QT connector (technically known as a JST SH 4-pin plug) into 4 individual wires with grippy alligator clips. We're carrying these to...
Out of Stock
[Buy Now](https://www.adafruit.com/product/4398)
[Related Guides to the Product](https://learn.adafruit.com/products/4398/guides)
### STEMMA QT / Qwiic JST SH 4-pin Cable - 100mm Long
[STEMMA QT / Qwiic JST SH 4-pin Cable - 100mm Long](https://www.adafruit.com/product/4210)
This 4-wire cable is a little over 100mm / 4" long and fitted with JST-SH female 4-pin connectors on both ends. Compared with the chunkier JST-PH these are 1mm pitch instead of 2mm, but still have a nice latching feel, while being easy to insert and remove.
Out of Stock
[Buy Now](https://www.adafruit.com/product/4210)
[Related Guides to the Product](https://learn.adafruit.com/products/4210/guides)
## Related Guides
- [Adafruit Metro RP2350](https://learn.adafruit.com/adafruit-metro-rp2350.md)
- [Adafruit PCT2075 Temperature Sensor](https://learn.adafruit.com/adafruit-pct2075-temperature-sensor.md)
- [Adafruit SHT31-D Temperature & Humidity Sensor Breakout](https://learn.adafruit.com/adafruit-sht31-d-temperature-and-humidity-sensor-breakout.md)
- [Melting Picture Frame for PyPortal IoT images](https://learn.adafruit.com/pyportal-art-display.md)
- [Adafruit BMP580, BMP581, and BMP585 - Temperature and Pressure Sensor](https://learn.adafruit.com/adafruit-bmp580-bmp581-and-bmp585-temperature-and-pressure-sensor.md)
- [Adafruit I2C to 8 Channel Solenoid Driver](https://learn.adafruit.com/adafruit-i2c-to-8-channel-solenoid-driver.md)
- [Analog Devices ADT7410 Breakout](https://learn.adafruit.com/adt7410-breakout.md)
- [Adafruit DS1841 I2C Logarithmic Resistor](https://learn.adafruit.com/adafruit-ds1841-i2c-logarithmic-resistor.md)
- [Using Piezo Buzzers with CircuitPython & Arduino](https://learn.adafruit.com/using-piezo-buzzers-with-circuitpython-arduino.md)
- [Adafruit VCNL4200 Long Distance IR Proximity and Light Sensor](https://learn.adafruit.com/adafruit-vcnl4200-long-distance-ir-proximity-and-light-sensor.md)
- [Using MPL3115A2 with CircuitPython](https://learn.adafruit.com/using-mpl3115a2-with-circuitpython.md)
- [CircuitPython Hardware: ILI9341 TFT & FeatherWing](https://learn.adafruit.com/micropython-hardware-ili9341-tft-and-featherwing.md)
- [Wizzy: A Needle Felted Cat](https://learn.adafruit.com/wizzy-a-needle-felted-cat.md)
- [Adafruit AS7331 UV / UVA / UVB / UVC Sensor](https://learn.adafruit.com/adafruit-as7331-uv-uva-uvb-uvc-sensor.md)
- [Adafruit bq25185 USB / DC / Solar Lithium Ion/Polymer Charger](https://learn.adafruit.com/adafruit-bq25185-usb-dc-solar-lithium-ion-polymer-charger.md)