SY6970Charger Class Reference

#include <SY6970Charger.hpp>

Inheritance diagram for SY6970Charger:

Public Member Functions
	SY6970Charger (SY6970Core &core)
	~SY6970Charger ()=default
bool	enableCharging (bool enable) override
	Enable/disable charging.
bool	isCharging () override
	Check whether charger is currently charging (best-effort).
bool	setPreChargeCurrent (uint16_t mA) override
	Set pre-charge current.
uint16_t	getPreChargeCurrent () override
	Get pre-charge current.
bool	setFastChargeCurrent (uint16_t mA) override
	Set fast charge (constant-current) current.
uint16_t	getFastChargeCurrent () override
	Get fast charge (constant-current) current.
bool	setTerminationCurrent (uint16_t mA) override
	Set termination current.
uint16_t	getTerminationCurrent () override
	Get termination current.
bool	setChargeVoltage (uint16_t mV) override
	Set charge voltage (CV).
uint16_t	getChargeVoltage () override
	Get charge voltage (CV).
Status	getStatus () override
	Get charger status.
Public Member Functions inherited from PmicChargerBase
virtual	~PmicChargerBase ()=default
	Virtual destructor.

Additional Inherited Members
Public Types inherited from PmicChargerBase
enum class	ChargingStatus : uint8_t {   NO_CHARGING = 0 , PRE_CHARGE = 1 , FAST_CHARGE = 2 , TERMINATION = 3 ,   UNKNOWN = 0xFF }
	Charging status enumeration. More...

Detailed Description

Definition at line 35 of file SY6970Charger.hpp.

Constructor & Destructor Documentation

SY6970Charger()

SY6970Charger::SY6970Charger ( SY6970Core &  core )

explicit

Definition at line 38 of file SY6970Charger.cpp.

~SY6970Charger()

SY6970Charger::~SY6970Charger ( )

default

Member Function Documentation

enableCharging()

bool SY6970Charger::enableCharging ( bool  enable )

overridevirtual

Enable/disable charging.

Parameters

enable

true to enable charging, false to disable.

Returns

true on success.

Implements PmicChargerBase.

Definition at line 40 of file SY6970Charger.cpp.

References SensorCommWrapper::updateBits().

getChargeVoltage()

uint16_t SY6970Charger::getChargeVoltage ( )

overridevirtual

Get charge voltage (CV).

Returns

Charge voltage in millivolts.

Implements PmicChargerBase.

Definition at line 133 of file SY6970Charger.cpp.

References SensorCommWrapper::readReg().

Referenced by setup().

getFastChargeCurrent()

uint16_t SY6970Charger::getFastChargeCurrent ( )

overridevirtual

Get fast charge (constant-current) current.

Returns

Fast charge current in milliamps.

Implements PmicChargerBase.

Definition at line 92 of file SY6970Charger.cpp.

References SensorCommWrapper::readReg().

Referenced by setup().

getPreChargeCurrent()

uint16_t SY6970Charger::getPreChargeCurrent ( )

overridevirtual

Get pre-charge current.

Returns

Pre-charge current in milliamps.

Implements PmicChargerBase.

Definition at line 69 of file SY6970Charger.cpp.

References SensorCommWrapper::readReg().

Referenced by setup().

getStatus()

PmicChargerBase::Status SY6970Charger::getStatus ( )

overridevirtual

Get charger status.

Returns

Status structure containing charger state.

Implements PmicChargerBase.

Definition at line 144 of file SY6970Charger.cpp.

References PmicChargerBase::Status::chargeDone, PmicChargerBase::Status::charging, PmicChargerBase::Status::chargingStatus, PmicChargerBase::FAST_CHARGE, PmicChargerBase::Status::fault, PmicChargerBase::Status::faultCode, SY6970Core::getChargeStatus(), SY6970Core::getFaultStatus(), SY6970Core::isChargeDone(), SY6970Core::isCharging(), SY6970Core::isValid(), SY6970Core::isVbusPresent(), PmicChargerBase::NO_CHARGING, PmicChargerBase::Status::online, PmicChargerBase::PRE_CHARGE, PmicChargerBase::TERMINATION, PmicChargerBase::UNKNOWN, and PmicChargerBase::Status::vbusPresent.

Referenced by loop().

getTerminationCurrent()

uint16_t SY6970Charger::getTerminationCurrent ( )

overridevirtual

Get termination current.

Returns

Termination current in milliamps.

Implements PmicChargerBase.

Definition at line 112 of file SY6970Charger.cpp.

References SensorCommWrapper::readReg().

Referenced by setup().

isCharging()

bool SY6970Charger::isCharging ( )

overridevirtual

Check whether charger is currently charging (best-effort).

Returns

true if charging.

Implements PmicChargerBase.

Definition at line 51 of file SY6970Charger.cpp.

References SY6970Core::isCharging().

Referenced by loop().

setChargeVoltage()

bool SY6970Charger::setChargeVoltage ( uint16_t  mV )

overridevirtual

Set charge voltage (CV).

Parameters

mV	Charge voltage in millivolts. Value will be quantized to nearest valid step (16mV).

Returns

true on success.

Implements PmicChargerBase.

Definition at line 120 of file SY6970Charger.cpp.

References SensorCommWrapper::updateBits().

Referenced by setup().

setFastChargeCurrent()

bool SY6970Charger::setFastChargeCurrent ( uint16_t  mA )

overridevirtual

Set fast charge (constant-current) current.

Parameters

mA	Fast charge current in milliamps. Value will be quantized to nearest valid step (64mA).

Returns

true on success.

Implements PmicChargerBase.

Definition at line 77 of file SY6970Charger.cpp.

References SensorCommWrapper::updateBits().

Referenced by setup().

setPreChargeCurrent()

bool SY6970Charger::setPreChargeCurrent ( uint16_t  mA )

overridevirtual

Set pre-charge current.

Parameters

mA	Pre-charge current in milliamps. Value will be quantized to nearest valid step (64mA).

Returns

true on success.

Implements PmicChargerBase.

Definition at line 56 of file SY6970Charger.cpp.

References SensorCommWrapper::updateBits().

Referenced by setup().

setTerminationCurrent()

bool SY6970Charger::setTerminationCurrent ( uint16_t  mA )

overridevirtual

Set termination current.

Parameters

mA	Termination current in milliamps. Value will be quantized to nearest valid step (64mA).

Returns

true on success.

Implements PmicChargerBase.

Definition at line 99 of file SY6970Charger.cpp.

References SensorCommWrapper::updateBits().

Referenced by setup().

---

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

• SY6970Charger.hpp
• SY6970Charger.cpp