PmicTimerBase Class Reference

#include <PmicTimerBase.hpp>

Inheritance diagram for PmicTimerBase:

Public Member Functions
virtual	~PmicTimerBase ()=default
virtual bool	setTimer (uint8_t minutes)=0
	Start the timer with the given duration, or stop it.
virtual uint8_t	getTimer () const =0
	Read the current timer value.
virtual bool	isTimedOut () const =0
	Check whether the timer has expired.
virtual bool	clearTimeout ()=0
	Clear the timeout status flag.

Detailed Description

Definition at line 37 of file PmicTimerBase.hpp.

Constructor & Destructor Documentation

~PmicTimerBase()

virtual PmicTimerBase::~PmicTimerBase ( )

virtualdefault

Member Function Documentation

clearTimeout()

virtual bool PmicTimerBase::clearTimeout ( )

pure virtual

Clear the timeout status flag.

Return values

true	Flag was cleared successfully.
false	I2C communication failed.

Implemented in AXP1xxTimer< Regs >, AXP1xxTimer< axp192_regs >, and AXP1xxTimer< axp202_regs >.

getTimer()

virtual uint8_t PmicTimerBase::getTimer ( ) const

pure virtual

Read the current timer value.

Returns

Timer value in minutes (0 = stopped), or 0 on error.

Implemented in AXP1xxTimer< Regs >, AXP1xxTimer< axp192_regs >, and AXP1xxTimer< axp202_regs >.

isTimedOut()

virtual bool PmicTimerBase::isTimedOut ( ) const

pure virtual

Check whether the timer has expired.

Return values

true	Timer has counted down to zero.
false	Timer is still running, or stopped, or I2C error.

Implemented in AXP1xxTimer< Regs >, AXP1xxTimer< axp192_regs >, and AXP1xxTimer< axp202_regs >.

setTimer()

virtual bool PmicTimerBase::setTimer ( uint8_t  minutes )

pure virtual

Start the timer with the given duration, or stop it.

Writing a non-zero value starts (or restarts) the countdown. Writing 0 stops the timer.

Parameters

minutes

Timeout in minutes.

Return values

true	Timer was configured successfully.
false	Value out of range or I2C error.

Implemented in AXP1xxTimer< Regs >, AXP1xxTimer< axp192_regs >, and AXP1xxTimer< axp202_regs >.

---

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

• PmicTimerBase.hpp