SensorLib/axp2101__irq_8ino_source.html

#include <PmicXPowers.hpp>


#ifndef PMIC_SDA

#define PMIC_SDA  3

#endif


#ifndef PMIC_SCL

#define PMIC_SCL  2

#endif


#ifndef PMIC_IRQ

#define PMIC_IRQ  21

#endif


PmicAXP2101 pmic;


void printU64(uint64_t value)

{

    char buffer[20];

    snprintf(buffer, sizeof(buffer), "0x%016llX", value);

    Serial.print(buffer);

}


void setup()

{

    Serial.begin(115200);

    delay(500);


    Serial.println("\n=== AXP2101 IRQ Example ===\n");


    if (!pmic.begin(Wire, AXP2101_SLAVE_ADDRESS, PMIC_SDA, PMIC_SCL)) {

        Serial.println("Failed to init AXP2101!");

        while (1) delay(1000);

    }

    Serial.println("AXP2101 initialized");


    // Enable ADC and charger modules

    pmic.enableModule(PmicAXP2101::Module::GENERAL_ADC, true);

    pmic.enableModule(PmicAXP2101::Module::CELL_CHARGE, true);

    pmic.enableModule(PmicAXP2101::Module::BAT_DETECT, true);


    // Enable selected interrupt sources

    pmic.irq().enable(

            AXP2101Irq::IRQ_VBUS_INSERT |

            AXP2101Irq::IRQ_VBUS_REMOVE |

            AXP2101Irq::IRQ_BAT_INSERT |

            AXP2101Irq::IRQ_BAT_REMOVE |

            AXP2101Irq::IRQ_BAT_CHG_START |

            AXP2101Irq::IRQ_BAT_CHG_DONE |

            AXP2101Irq::IRQ_PEKEY_SHORT_PRESS |

            AXP2101Irq::IRQ_PEKEY_LONG_PRESS |

            AXP2101Irq::IRQ_WDT_EXPIRE |

            AXP2101Irq::IRQ_DIE_OVER_TEMP

        );

    Serial.println("IRQ sources enabled");


    // Clear any stale interrupts

    pmic.irq().clearStatus();


    Serial.println("\n=== Setup Complete ===\n");

}


void loop()

{

    uint64_t irqStatus = pmic.irq().readStatus(true);

    if (irqStatus) {


        Serial.print("\n--- Interrupt : 0x");

        printU64(irqStatus);

        Serial.print(" --- ");


        if (pmic.irq().isVbusInsert(irqStatus))

            Serial.println("VBUS inserted");

        if (pmic.irq().isVbusRemove(irqStatus))

            Serial.println("VBUS removed");

        if (pmic.irq().isBatInsert(irqStatus))

            Serial.println("Battery inserted");

        if (pmic.irq().isBatRemove(irqStatus))

            Serial.println("Battery removed");

        if (pmic.irq().isBatChgStart(irqStatus))

            Serial.println("Charge started");

        if (pmic.irq().isBatChgDone(irqStatus))

            Serial.println("Charge done");

        if (pmic.irq().isPekeyShortPress(irqStatus)) {

            Serial.println("PEKEY short press");

            pmic.led().setMode(PmicLedBase::Mode::MANUAL);


            AXP2101Led::ManualState state = pmic.led().getManualState();

            switch (state) {

            case PmicLedBase::ManualState::LEVEL_HIGH:

                Serial.println("LED is ON");

                break;

            case PmicLedBase::ManualState::LEVEL_LOW:

                Serial.println("LED is OFF");

                break;

            case PmicLedBase::ManualState::HiZ:

                Serial.println("LED is HiZ");

                break;

            case PmicLedBase::ManualState::BLINK_1HZ:

                Serial.println("LED is blinking at 1Hz");

                break;

            case PmicLedBase::ManualState::BLINK_4HZ:

                Serial.println("LED is blinking at 4Hz");

                break;

            default:

                break;

            }

            if (state == PmicLedBase::ManualState::LEVEL_HIGH) {

                Serial.println("ON LED");

                pmic.led().setManualState(PmicLedBase::ManualState::LEVEL_LOW);

            } else {

                Serial.println("OFF LED");

                pmic.led().setManualState(PmicLedBase::ManualState::LEVEL_HIGH);

            }

        }

        if (pmic.irq().isPekeyLongPress(irqStatus))

            Serial.println("PEKEY long press");

        if (pmic.irq().isWdtExpire(irqStatus))

            Serial.println("Watchdog expired");

        if (pmic.irq().isDieOverTemp(irqStatus))

            Serial.println("Die over-temperature");

        if (pmic.irq().isLdoOverCurr(irqStatus))

            Serial.println("LDO over-current");

        if (pmic.irq().isBatfetOverCurr(irqStatus))

            Serial.println("BATFET over-current");

        if (pmic.irq().isBatOverVolt(irqStatus))

            Serial.println("Battery over-voltage");

        if (pmic.irq().isChgTimeout(irqStatus))

            Serial.println("Charge timeout");

        if (pmic.irq().isGaugeNewSoc(irqStatus))

            Serial.println("New SOC reading");

        if (pmic.irq().isBatOverTempWork(irqStatus))

            Serial.println("Battery over-temp (work)");

        if (pmic.irq().isBatUnderTempWork(irqStatus))

            Serial.println("Battery under-temp (work)");

        if (pmic.irq().isBatOverTempChg(irqStatus))

            Serial.println("Battery charge over-temp");

        if (pmic.irq().isBatUnderTempChg(irqStatus))

            Serial.println("Battery charge under-temp");

        if (pmic.irq().isPkeyNegativeEdge(irqStatus))

            Serial.println("PEKEY negative edge");

        if (pmic.irq().isPkeyPositiveEdge(irqStatus))

            Serial.println("PEKEY positive edge");

    }

    delay(100);

}


PmicXPowers.hpp
@license MIT License

PMIC_SDA
#define PMIC_SDA
Definition axp2101_irq.ino:33

PMIC_SCL
#define PMIC_SCL
Definition axp2101_irq.ino:37

setup
void setup()
Definition axp2101_irq.ino:53

printU64
void printU64(uint64_t value)
Definition axp2101_irq.ino:46

pmic
PmicAXP2101 pmic
Definition axp2101_irq.ino:44

loop
void loop()
Definition axp2101_irq.ino:92

AXP2101Irq::isBatfetOverCurr
static bool isBatfetOverCurr(uint64_t mask)
Check if BATFET over-current interrupt is set.
Definition AXP2101Irq.hpp:165

AXP2101Irq::IRQ_PEKEY_LONG_PRESS
static constexpr uint64_t IRQ_PEKEY_LONG_PRESS
Power key held for a long press duration.
Definition AXP2101Irq.hpp:81

AXP2101Irq::isBatOverTempChg
static bool isBatOverTempChg(uint64_t mask)
Check if battery over-temperature (charging range) interrupt is set.
Definition AXP2101Irq.hpp:131

AXP2101Irq::IRQ_VBUS_REMOVE
static constexpr uint64_t IRQ_VBUS_REMOVE
VBUS power source removed.
Definition AXP2101Irq.hpp:89

AXP2101Irq::isPekeyShortPress
static bool isPekeyShortPress(uint64_t mask)
Check if power key short press interrupt is set.
Definition AXP2101Irq.hpp:152

AXP2101Irq::IRQ_BAT_CHG_START
static constexpr uint64_t IRQ_BAT_CHG_START
Battery charging has started.
Definition AXP2101Irq.hpp:101

AXP2101Irq::isPekeyLongPress
static bool isPekeyLongPress(uint64_t mask)
Check if power key long press interrupt is set.
Definition AXP2101Irq.hpp:154

AXP2101Irq::IRQ_PEKEY_SHORT_PRESS
static constexpr uint64_t IRQ_PEKEY_SHORT_PRESS
Power key pressed briefly (short press).
Definition AXP2101Irq.hpp:83

AXP2101Irq::isGaugeNewSoc
static bool isGaugeNewSoc(uint64_t mask)
Check if gauge new state-of-charge interrupt is set.
Definition AXP2101Irq.hpp:135

AXP2101Irq::isBatOverVolt
static bool isBatOverVolt(uint64_t mask)
Check if battery over-voltage interrupt is set.
Definition AXP2101Irq.hpp:175

AXP2101Irq::isWdtExpire
static bool isWdtExpire(uint64_t mask)
Check if watchdog timer expired interrupt is set.
Definition AXP2101Irq.hpp:161

AXP2101Irq::isChgTimeout
static bool isChgTimeout(uint64_t mask)
Check if charge timeout interrupt is set.
Definition AXP2101Irq.hpp:173

AXP2101Irq::isLdoOverCurr
static bool isLdoOverCurr(uint64_t mask)
Check if LDO over-current interrupt is set.
Definition AXP2101Irq.hpp:163

AXP2101Irq::isBatInsert
static bool isBatInsert(uint64_t mask)
Check if battery insertion interrupt is set.
Definition AXP2101Irq.hpp:148

AXP2101Irq::isBatOverTempWork
static bool isBatOverTempWork(uint64_t mask)
Check if battery over-temperature (working range) interrupt is set.
Definition AXP2101Irq.hpp:127

AXP2101Irq::IRQ_VBUS_INSERT
static constexpr uint64_t IRQ_VBUS_INSERT
VBUS power source inserted.
Definition AXP2101Irq.hpp:91

AXP2101Irq::isBatRemove
static bool isBatRemove(uint64_t mask)
Check if battery removal interrupt is set.
Definition AXP2101Irq.hpp:150

AXP2101Irq::isPkeyPositiveEdge
static bool isPkeyPositiveEdge(uint64_t mask)
Check if power key positive (rising) edge interrupt is set.
Definition AXP2101Irq.hpp:158

AXP2101Irq::isVbusInsert
static bool isVbusInsert(uint64_t mask)
Check if VBUS insertion interrupt is set.
Definition AXP2101Irq.hpp:144

AXP2101Irq::isBatUnderTempWork
static bool isBatUnderTempWork(uint64_t mask)
Check if battery under-temperature (working range) interrupt is set.
Definition AXP2101Irq.hpp:129

AXP2101Irq::IRQ_BAT_INSERT
static constexpr uint64_t IRQ_BAT_INSERT
Battery inserted into the system.
Definition AXP2101Irq.hpp:87

AXP2101Irq::enable
bool enable(uint64_t mask) override
Enable one or more interrupt sources.
Definition AXP2101Irq.cpp:42

AXP2101Irq::isVbusRemove
static bool isVbusRemove(uint64_t mask)
Check if VBUS removal interrupt is set.
Definition AXP2101Irq.hpp:146

AXP2101Irq::readStatus
uint64_t readStatus(bool clear=true) override
Read the current interrupt status.
Definition AXP2101Irq.cpp:78

AXP2101Irq::IRQ_WDT_EXPIRE
static constexpr uint64_t IRQ_WDT_EXPIRE
Watchdog timer expired.
Definition AXP2101Irq.hpp:109

AXP2101Irq::IRQ_BAT_REMOVE
static constexpr uint64_t IRQ_BAT_REMOVE
Battery removed from the system.
Definition AXP2101Irq.hpp:85

AXP2101Irq::isBatChgDone
static bool isBatChgDone(uint64_t mask)
Check if battery charge done interrupt is set.
Definition AXP2101Irq.hpp:167

AXP2101Irq::IRQ_BAT_CHG_DONE
static constexpr uint64_t IRQ_BAT_CHG_DONE
Battery charging has completed.
Definition AXP2101Irq.hpp:103

AXP2101Irq::isPkeyNegativeEdge
static bool isPkeyNegativeEdge(uint64_t mask)
Check if power key negative (falling) edge interrupt is set.
Definition AXP2101Irq.hpp:156

AXP2101Irq::isDieOverTemp
static bool isDieOverTemp(uint64_t mask)
Check if die over-temperature interrupt is set.
Definition AXP2101Irq.hpp:171

AXP2101Irq::clearStatus
bool clearStatus() override
Clear all pending interrupt status registers.
Definition AXP2101Irq.cpp:101

AXP2101Irq::IRQ_DIE_OVER_TEMP
static constexpr uint64_t IRQ_DIE_OVER_TEMP
Die temperature exceeded the thermal shutdown threshold.
Definition AXP2101Irq.hpp:99

AXP2101Irq::isBatUnderTempChg
static bool isBatUnderTempChg(uint64_t mask)
Check if battery under-temperature (charging range) interrupt is set.
Definition AXP2101Irq.hpp:133

AXP2101Irq::isBatChgStart
static bool isBatChgStart(uint64_t mask)
Check if battery charge start interrupt is set.
Definition AXP2101Irq.hpp:169

AXP2101Led::setManualState
bool setManualState(ManualState state) override
For manual mode, set the LED output state.
Definition AXP2101Led.cpp:79

AXP2101Led::setMode
bool setMode(Mode mode) override
Set the LED operating mode.
Definition AXP2101Led.cpp:49

AXP2101Led::getManualState
ManualState getManualState() override
Get the current manual LED state.
Definition AXP2101Led.cpp:96

PmicAXP2101
Top-level unified interface for the AXP2101 PMIC.
Definition PmicAXP2101.hpp:72

PmicAXP2101::begin
bool begin(SensorCommCustom::CustomCallback callback, SensorCommCustomHal::CustomHalCallback hal_cb, uint8_t addr)
Initialise the AXP2101 with custom communication callbacks.
Definition PmicAXP2101.hpp:133

PmicAXP2101::enableModule
bool enableModule(Module module, bool enable)
Enable or disable an internal functional module.
Definition PmicAXP2101.hpp:335

PmicAXP2101::led
AXP2101Led & led()
Get the chip-specific LED module.
Definition PmicAXP2101.hpp:274

PmicAXP2101::irq
AXP2101Irq & irq()
Get the chip-specific IRQ controller.
Definition PmicAXP2101.hpp:256

PmicLedBase::ManualState
ManualState
Manual LED state (portable subset).
Definition PmicLedBase.hpp:87

PmicLedBase::ManualState::BLINK_4HZ
@ BLINK_4HZ

PmicLedBase::ManualState::LEVEL_LOW
@ LEVEL_LOW

PmicLedBase::ManualState::LEVEL_HIGH
@ LEVEL_HIGH

PmicLedBase::ManualState::BLINK_1HZ
@ BLINK_1HZ

PmicLedBase::ManualState::HiZ
@ HiZ

PmicLedBase::Mode::MANUAL
@ MANUAL
Manual control through registers.