/CircuitPython_AXP192

Circuitpython driver for AXP192 power management IC

Primary LanguagePythonMIT LicenseMIT

Introduction

Documentation Status Discord Build Status Code Style: Black

Circuitpython driver for AXP192 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 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 axp192

Or the following command to update an existing version:

circup update

Usage Example

A simple example that check if a battery is connected to AXP192 and shows battery voltage:

import board
from axp192 import AXP192

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

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

More examples are available in the examples folder

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.