SensorLib 0.5.0
Multi-platform sensor driver library for Arduino, PlatformIO, and ESP-IDF
Loading...
Searching...
No Matches
PmicAdcBase.hpp File Reference

@license MIT License More...

#include <stdint.h>
#include <math.h>
Include dependency graph for PmicAdcBase.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  PmicAdcBase
 

Functions

PmicAdcBase::Channel operator| (PmicAdcBase::Channel a, PmicAdcBase::Channel b)
 Bitwise OR operator for combining Channel values.
 
PmicAdcBase::Channeloperator|= (PmicAdcBase::Channel &a, PmicAdcBase::Channel b)
 Bitwise OR assignment operator for Channel values.
 

Detailed Description

@license MIT License

Copyright (c) 2026 lewis he

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author
Lewis He (lewis.nosp@m.he@o.nosp@m.utloo.nosp@m.k.co.nosp@m.m)
Date
2026-03-13

PMIC analog data interface.

This interface standardizes the most common ADC controls across PMICs.

Design notes:

  • Channel is a bitmask enum. Common channels can be combined with |.
  • enableChannels(uint32_t) is the virtual interface. Subclasses accept both Channel values AND chip-specific masks (e.g. AXP202 GPIO ADC).
  • Not all chips support all channels; unsupported channels return false.

Definition in file PmicAdcBase.hpp.

Function Documentation

◆ operator|()

Bitwise OR operator for combining Channel values.

Enables: Channel::BAT_VOLTAGE | Channel::VBUS_VOLTAGE

Definition at line 156 of file PmicAdcBase.hpp.

◆ operator|=()

PmicAdcBase::Channel & operator|= ( PmicAdcBase::Channel a,
PmicAdcBase::Channel  b 
)
inline

Bitwise OR assignment operator for Channel values.

Definition at line 165 of file PmicAdcBase.hpp.