SensorLib 0.5.0
Multi-platform sensor driver library for Arduino, PlatformIO, and ESP-IDF
Loading...
Searching...
No Matches
PmicBc12Base Class Referenceabstract

#include <PmicBc12Base.hpp>

Inheritance diagram for PmicBc12Base:
[legend]

Classes

struct  Result
 

Public Types

enum class  PortType : uint8_t {
  Unknown = 0 , None , SDP , CDP ,
  DCP , Apple_1A , Apple_2A , Apple_2_4A
}
 Common detected port/source type. More...
 

Public Member Functions

virtual ~PmicBc12Base ()=default
 
virtual bool enableAutoDetect (bool enable)=0
 Enable/disable auto BC1.2 detection (if supported).
 
virtual bool triggerDetect ()=0
 Force/trigger a BC1.2 detection cycle (if supported).
 
virtual bool isDetecting ()=0
 Query whether PMIC is currently detecting.
 
virtual Result readResult ()=0
 Read current BC1.2 result.
 

Detailed Description

Definition at line 39 of file PmicBc12Base.hpp.

Member Enumeration Documentation

◆ PortType

enum class PmicBc12Base::PortType : uint8_t
strong

Common detected port/source type.

Enumerator
Unknown 
None 

no valid detection / not connected

SDP 

Standard Downstream Port (USB 500mA/900mA)

CDP 

Charging Downstream Port.

DCP 

Dedicated Charging Port.

Apple_1A 

optional

Apple_2A 

optional

Apple_2_4A 

optional

Definition at line 47 of file PmicBc12Base.hpp.

Constructor & Destructor Documentation

◆ ~PmicBc12Base()

virtual PmicBc12Base::~PmicBc12Base ( )
virtualdefault

Member Function Documentation

◆ enableAutoDetect()

virtual bool PmicBc12Base::enableAutoDetect ( bool  enable)
pure virtual

Enable/disable auto BC1.2 detection (if supported).

Implemented in AXP517Bc12.

◆ isDetecting()

virtual bool PmicBc12Base::isDetecting ( )
pure virtual

Query whether PMIC is currently detecting.

Implemented in AXP517Bc12.

◆ readResult()

virtual Result PmicBc12Base::readResult ( )
pure virtual

Read current BC1.2 result.

Implemented in AXP517Bc12.

◆ triggerDetect()

virtual bool PmicBc12Base::triggerDetect ( )
pure virtual

Force/trigger a BC1.2 detection cycle (if supported).

Implemented in AXP517Bc12.


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