/CircuitPython_AXP2101

Circuitpython driver for AXP2101 power management IC

Primary LanguagePythonMIT LicenseMIT

Introduction

Documentation Status Discord Build Status Code Style: Black

Circuitpython driver for AXP2101 power management IC

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install axp2101

Or the following command to update an existing version:

circup update

Usage Example

# Read battery voltage
import time
import board
from axp2101 import AXP2101

i2c = board.I2C()
pmic = AXP2101(i2c)

while True:
    if pmic.is_battery_connected:
        battery_voltage = pmic.battery_voltage
        print(f"Battery voltage {battery_voltage}V")
    else:
        print("No battery connected")

    time.sleep(1)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.