BQ25896Led Class Reference

BQ25896 LED/STAT Pin Control. More...

#include <BQ25896Led.hpp>

Inheritance diagram for BQ25896Led:

Public Member Functions
	BQ25896Led (BQ25896Core &core)
	Construct LED interface.
	~BQ25896Led ()=default
bool	setOutputType (OutputType type) override
	Set LED output type.
bool	setMode (Mode mode) override
	Set LED operating mode.
Mode	getMode () override
	Get LED operating mode.
bool	setManualState (ManualState state) override
	Set manual LED state.
ManualState	getManualState () override
	Get manual LED state.
Public Member Functions inherited from PmicLedBase
virtual	~PmicLedBase ()=default

Additional Inherited Members
Public Types inherited from PmicLedBase
enum class	OutputType : uint8_t { OpenDrain = 0 , PushPull = 1 }
enum class	Mode : uint8_t {   AUTO = 0 , MANUAL = 1 , BREATH = 2 , DISABLE = 3 ,   VENDOR = 255 }
	High-level LED operating mode (portable subset). More...
enum class	ManualState : uint8_t {   HiZ = 0 , LEVEL_LOW = 1 , LEVEL_HIGH = 2 , BLINK_1HZ = 3 ,   BLINK_4HZ = 4 , UNDEFINED = 255 }
	Manual LED state (portable subset). More...

Detailed Description

BQ25896 LED/STAT Pin Control.

Definition at line 55 of file BQ25896Led.hpp.

Constructor & Destructor Documentation

BQ25896Led()

BQ25896Led::BQ25896Led ( BQ25896Core &  core )

explicit

Construct LED interface.

Parameters

core	Reference to BQ25896 core communication

Definition at line 38 of file BQ25896Led.cpp.

~BQ25896Led()

BQ25896Led::~BQ25896Led ( )

default

Member Function Documentation

getManualState()

PmicLedBase::ManualState BQ25896Led::getManualState ( )

overridevirtual

Get manual LED state.

Returns

UNDEFINED as manual control is not supported

Implements PmicLedBase.

Definition at line 69 of file BQ25896Led.cpp.

References PmicLedBase::UNDEFINED.

getMode()

PmicLedBase::Mode BQ25896Led::getMode ( )

overridevirtual

Get LED operating mode.

Returns

Current LED mode (AUTO, DISABLE, or VENDOR on error)

Implements PmicLedBase.

Definition at line 56 of file BQ25896Led.cpp.

References PmicLedBase::AUTO, PmicLedBase::DISABLE, SensorCommWrapper::readReg(), and PmicLedBase::VENDOR.

setManualState()

bool BQ25896Led::setManualState ( ManualState  state )

overridevirtual

Set manual LED state.

Note

BQ25896 does not support manual LED control

Returns

false always

Implements PmicLedBase.

Definition at line 63 of file BQ25896Led.cpp.

setMode()

bool BQ25896Led::setMode ( Mode  mode )

overridevirtual

Set LED operating mode.

Controls the STAT pin behavior. BQ25896 supports:

• AUTO: Hardware-controlled (charging indicator)
• DISABLE: STAT pin disabled

Parameters

mode	Operating mode

Returns

true on success, false on I2C error

Implements PmicLedBase.

Definition at line 46 of file BQ25896Led.cpp.

References PmicLedBase::AUTO, PmicLedBase::DISABLE, and SensorCommWrapper::updateBits().

Referenced by setup().

setOutputType()

bool BQ25896Led::setOutputType ( OutputType  type )

overridevirtual

Set LED output type.

Sets the STAT pin output configuration. BQ25896 only supports OpenDrain mode.

Parameters

type	Output type (OpenDrain or PushPull)

Returns

true on success, false on I2C error

Note

BQ25896 STAT pin is open-drain; PushPull is not supported This function always returns false.

Implements PmicLedBase.

Definition at line 40 of file BQ25896Led.cpp.

---

The documentation for this class was generated from the following files:

• BQ25896Led.hpp
• BQ25896Led.cpp