https://github.com/milad-nikpendar/ip5108
Arduino library for the IP5108 PMIC — control charging, boost, flashlight, and read battery status via I²C on ESP32.
https://github.com/milad-nikpendar/ip5108
arduino arduino-library battery-management battery-monitoring boost-converter charger embedded-systems esp32 flashlight-control ip5108 low-power pmic power-bank power-management
Last synced: 13 days ago
JSON representation
Arduino library for the IP5108 PMIC — control charging, boost, flashlight, and read battery status via I²C on ESP32.
- Host: GitHub
- URL: https://github.com/milad-nikpendar/ip5108
- Owner: milad-nikpendar
- License: mit
- Created: 2025-09-22T11:39:01.000Z (27 days ago)
- Default Branch: main
- Last Pushed: 2025-09-22T12:03:50.000Z (27 days ago)
- Last Synced: 2025-09-22T13:19:00.642Z (27 days ago)
- Topics: arduino, arduino-library, battery-management, battery-monitoring, boost-converter, charger, embedded-systems, esp32, flashlight-control, ip5108, low-power, pmic, power-bank, power-management
- Language: C++
- Homepage: https://imax-co.com/
- Size: 21.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IP5108
[](https://docs.arduino.cc/libraries/IP5108/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/milad-nikpendar/IP5108/releases)
[](https://github.com/milad-nikpendar)
A high‑level Arduino library for the **IP5108** Power Management IC — the all‑in‑one Li‑ion charge/boost controller found in many power banks and portable devices.
This library lets you control **charging**, **boost output**, **flashlight mode**, and **battery monitoring** over I²C, with clean APIs designe.
---
## ✨ Features
- Enable/disable:
- Charger
- Boost output
- Flashlight / LED light
- Auto‑power functions
- Configure:
- Shutdown time
- Light shutdown current
- Battery type & charge voltage
- Boost current limit
- Read:
- Battery voltage, open‑circuit voltage, current
- Charging state & status flags
- Button press events (short, long, double)
- Battery percentage
- Fully non‑blocking I²C interface (400 kHz)
- Minimal dependencies, Arduino‑IDE & PlatformIO ready
---
## 📦 Installation
### Arduino IDE
1. Download this repository as a ZIP.
2. In Arduino IDE: **Sketch → Include Library → Add .ZIP Library…**
3. Select the downloaded ZIP file.
### PlatformIO
Add to your `platformio.ini`:
```ini
lib_deps =
https://github.com/milad-nikpendar/IP5108
```
---
## 🔌 Wiring
| IP5108 Pin | ESP32 Pin | Notes |
|------------|-------------------|-------|
| SDA | GPIO21 (example) | Any I²C‑capable pin |
| SCL | GPIO22 (example) | Any I²C‑capable pin |
| VCC | 3.3 V / 5 V | Per datasheet |
| GND | GND | Common ground |
**Default I²C address:** `0x75`
**I²C speed:** up to 400 kHz
---
## 🚀 Quick Start
```cpp
#include
#include
IP5108 pmic;
void setup() {
Serial.begin(115200);
Wire.begin(21, 22, 400000); // SDA, SCL, freq
if (!pmic.begin(0x75, &Wire)) {
Serial.println("IP5108 not found!");
while (1) delay(1000);
}
pmic.Charger(true); // Enable charging
pmic.Boost(true); // Enable boost output
pmic.FlashLight(true); // Turn on flashlight
}
void loop() {
Serial.printf("Battery: %u mV, %d mA, %d%%\n",
pmic.BatteryVoltage(),
pmic.BatteryCurrent(),
pmic.battery_percentage());
delay(1000);
}
```
---
## 📖 API Overview
| Method | Description |
|--------|-------------|
| `begin(addr, wire)` | Initialize with I²C address and Wire instance |
| `Charger(bool)` | Enable/disable battery charging |
| `Boost(bool)` | Enable/disable boost output |
| `FlashLight(bool)` | Enable/disable flashlight |
| `BatteryVoltage()` | Get battery voltage in mV |
| `BatteryCurrent()` | Get battery current in mA |
| `battery_percentage()` | Estimate battery percentage |
| `ChargingStatus()` | Get charging status flags |
| `setDoublePressAction(actionType_t, seconds)` | Configure button actions |
*(See `IP5108.h` for full API list.)*
---
## 🛠 Examples
- **Basic_Init** – Initialize and enable charger
- **Battery_Monitor** – Print battery voltage, current, and percentage
---
## 🧰 Development Notes
- Designed for **ESP32** under Arduino framework.
- Uses `TwoWire` for I²C — pass custom SDA/SCL pins if needed.
- All register definitions are based on the IP5108 datasheet.
- Includes helper functions for safe updates and bit‑mask writes.
---
## 🧾 License
This project is licensed under the **MIT License** – see [LICENSE](LICENSE) for details.
## ✍️ Author
**Milad Nikpendar**
GitHub: [milad-nikpendar/IP5108](https://github.com/milad-nikpendar/IP5108)
Email: milad82nikpendar@gmail.com