Electrochemical Gas Sensor Library 1.0.0
A library for the Electrochemical Gas Sensor breakout board
Loading...
Searching...
No Matches
ADS1X15 Class Reference

#include <ADS1X15.h>

Inherited by ADS1013, ADS1014, ADS1015, ADS1113, ADS1114, and ADS1115.

Public Member Functions

void reset ()
bool begin (uint8_t sda, uint8_t scl)
bool begin ()
bool isConnected ()
void setGain (uint8_t gain=0)
uint8_t getGain ()
float toVoltage (int16_t val=1)
float getMaxVoltage ()
void setMode (uint8_t mode=1)
uint8_t getMode ()
void setDataRate (uint8_t dataRate=4)
uint8_t getDataRate ()
int16_t readADC (uint8_t pin)
int16_t readADC_Differential_0_1 ()
int16_t getLastValue ()
int16_t getValue ()
void requestADC (uint8_t pin)
void requestADC_Differential_0_1 ()
bool isBusy ()
bool isReady ()
void setComparatorMode (uint8_t mode)
uint8_t getComparatorMode ()
void setComparatorPolarity (uint8_t pol)
uint8_t getComparatorPolarity ()
void setComparatorLatch (uint8_t latch)
uint8_t getComparatorLatch ()
void setComparatorQueConvert (uint8_t mode)
uint8_t getComparatorQueConvert ()
void setComparatorThresholdLow (int16_t lo)
int16_t getComparatorThresholdLow ()
void setComparatorThresholdHigh (int16_t hi)
int16_t getComparatorThresholdHigh ()
int8_t getError ()
void setWireClock (uint32_t clockSpeed)
uint32_t getWireClock ()

Protected Member Functions

 ADS1X15 ()
int16_t _readADC (uint16_t readmode)
void _requestADC (uint16_t readmode)
bool _writeRegister (uint8_t address, uint8_t reg, uint16_t value)
uint16_t _readRegister (uint8_t address, uint8_t reg)

Protected Attributes

uint8_t _config
uint8_t _maxPorts
uint8_t _address
uint8_t _conversionDelay
uint8_t _bitShift
uint16_t _gain
uint16_t _mode
uint16_t _datarate
uint8_t _compMode
uint8_t _compPol
uint8_t _compLatch
uint8_t _compQueConvert
int8_t _err = ADS1X15_OK
TwoWire * _wire
uint32_t _clockSpeed = 0

Constructor & Destructor Documentation

◆ ADS1X15()

ADS1X15::ADS1X15 ( )
protected

Member Function Documentation

◆ _readADC()

int16_t ADS1X15::_readADC ( uint16_t readmode)
protected

◆ _readRegister()

uint16_t ADS1X15::_readRegister ( uint8_t address,
uint8_t reg )
protected

◆ _requestADC()

void ADS1X15::_requestADC ( uint16_t readmode)
protected

◆ _writeRegister()

bool ADS1X15::_writeRegister ( uint8_t address,
uint8_t reg,
uint16_t value )
protected

◆ begin() [1/2]

bool ADS1X15::begin ( )

◆ begin() [2/2]

bool ADS1X15::begin ( uint8_t sda,
uint8_t scl )

◆ getComparatorLatch()

uint8_t ADS1X15::getComparatorLatch ( )
inline

◆ getComparatorMode()

uint8_t ADS1X15::getComparatorMode ( )
inline

◆ getComparatorPolarity()

uint8_t ADS1X15::getComparatorPolarity ( )
inline

◆ getComparatorQueConvert()

uint8_t ADS1X15::getComparatorQueConvert ( )
inline

◆ getComparatorThresholdHigh()

int16_t ADS1X15::getComparatorThresholdHigh ( )

◆ getComparatorThresholdLow()

int16_t ADS1X15::getComparatorThresholdLow ( )

◆ getDataRate()

uint8_t ADS1X15::getDataRate ( void )

◆ getError()

int8_t ADS1X15::getError ( )

◆ getGain()

uint8_t ADS1X15::getGain ( )

◆ getLastValue()

int16_t ADS1X15::getLastValue ( )
inline

◆ getMaxVoltage()

float ADS1X15::getMaxVoltage ( )

◆ getMode()

uint8_t ADS1X15::getMode ( void )

◆ getValue()

int16_t ADS1X15::getValue ( )

◆ getWireClock()

uint32_t ADS1X15::getWireClock ( )

◆ isBusy()

bool ADS1X15::isBusy ( )

◆ isConnected()

bool ADS1X15::isConnected ( )

◆ isReady()

bool ADS1X15::isReady ( )
inline

◆ readADC()

int16_t ADS1X15::readADC ( uint8_t pin)

◆ readADC_Differential_0_1()

int16_t ADS1X15::readADC_Differential_0_1 ( )

◆ requestADC()

void ADS1X15::requestADC ( uint8_t pin)

◆ requestADC_Differential_0_1()

void ADS1X15::requestADC_Differential_0_1 ( )

◆ reset()

void ADS1X15::reset ( )

◆ setComparatorLatch()

void ADS1X15::setComparatorLatch ( uint8_t latch)
inline

◆ setComparatorMode()

void ADS1X15::setComparatorMode ( uint8_t mode)
inline

◆ setComparatorPolarity()

void ADS1X15::setComparatorPolarity ( uint8_t pol)
inline

◆ setComparatorQueConvert()

void ADS1X15::setComparatorQueConvert ( uint8_t mode)
inline

◆ setComparatorThresholdHigh()

void ADS1X15::setComparatorThresholdHigh ( int16_t hi)

◆ setComparatorThresholdLow()

void ADS1X15::setComparatorThresholdLow ( int16_t lo)

◆ setDataRate()

void ADS1X15::setDataRate ( uint8_t dataRate = 4)

◆ setGain()

void ADS1X15::setGain ( uint8_t gain = 0)

◆ setMode()

void ADS1X15::setMode ( uint8_t mode = 1)

◆ setWireClock()

void ADS1X15::setWireClock ( uint32_t clockSpeed)

◆ toVoltage()

float ADS1X15::toVoltage ( int16_t val = 1)

Member Data Documentation

◆ _address

uint8_t ADS1X15::_address
protected

◆ _bitShift

uint8_t ADS1X15::_bitShift
protected

◆ _clockSpeed

uint32_t ADS1X15::_clockSpeed = 0
protected

◆ _compLatch

uint8_t ADS1X15::_compLatch
protected

◆ _compMode

uint8_t ADS1X15::_compMode
protected

◆ _compPol

uint8_t ADS1X15::_compPol
protected

◆ _compQueConvert

uint8_t ADS1X15::_compQueConvert
protected

◆ _config

uint8_t ADS1X15::_config
protected

◆ _conversionDelay

uint8_t ADS1X15::_conversionDelay
protected

◆ _datarate

uint16_t ADS1X15::_datarate
protected

◆ _err

int8_t ADS1X15::_err = ADS1X15_OK
protected

◆ _gain

uint16_t ADS1X15::_gain
protected

◆ _maxPorts

uint8_t ADS1X15::_maxPorts
protected

◆ _mode

uint16_t ADS1X15::_mode
protected

◆ _wire

TwoWire* ADS1X15::_wire
protected

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