STAR
Cal STAR — firmware, DAQ server, and engine design
Loading...
Searching...
No Matches
ADS126X Class Reference

#include <STAR_ADS126X.h>

Collaboration diagram for ADS126X:
[legend]

Classes

struct  ADCReading

Public Member Functions

void bypassPGA ()
void setInputMux (uint8_t pos, uint8_t neg)
void setOutputTDACP (uint8_t on)
void setOutputTDACN (uint8_t on)
void setOutputmagnitudeTDACP (uint8_t mag)
void setOutputmagnitudeTDACN (uint8_t mag)
 IDAC functionality.
void setReference (uint8_t neg, uint8_t pos)
 TDAC Registers.
ads126x_reading readADC1 ()
void setIDAC1Mag (uint8_t mag)
void setIDAC2Mag (uint8_t mag)
void setBiasADC (uint8_t adc)
void setBiasPolarity (uint8_t pol)
void setBiasMagnitude (uint8_t mag)
 MODE2 register.
void stopADC1 ()
void startADC1 ()
 ADS126X (void)
 < Initial ADC Setup
void begin (uint8_t chip_select)
void begin (uint8_t chip_select, SPIClass *spi)
 Regular ADC Commands.
void begin (void)
void setStartPin (uint8_t pin)
void noOperation (void)
void reset (void)
void startADC1 (void)
void stopADC1 (void)
void startADC2 (void)
void stopADC2 (void)
void setInputMux (uint8_t pos_pin, uint8_t neg_pin)
void setADC2Mux (uint8_t pos_pin, uint8_t neg_pin)
ADCReading readADC1 ()
ADCReading readADC1 (uint8_t pos_pin, uint8_t neg_pin)
ADCReading readADC2 ()
ADCReading readADC2 (uint8_t pos_pin, uint8_t neg_pin)
 SPI Communication Commands.
void calibrateSysOffsetADC1 (uint8_t shorted1, uint8_t shorted2)
void calibrateGainADC1 (uint8_t vcc_pin, uint8_t gnd_pin)
void calibrateSelfOffsetADC1 (void)
void calibrateSysOffsetADC2 (uint8_t shorted1, uint8_t shorted2)
void calibrateGainADC2 (uint8_t vcc_pin, uint8_t gnd_pin)
void calibrateSelfOffsetADC2 (void)
void setIDAC1Pin (uint8_t pin)
void setIDAC2Pin (uint8_t pin)
void setIDAC1Mag (uint8_t magnitude)
void setIDAC2Mag (uint8_t magnitude)
bool checkResetBit (void)
void clearResetBit (void)
void enableLevelShift (void)
void disableLevelShift (void)
void enableInternalReference (void)
void disableInternalReference (void)
void disableCheck (void)
void setChecksumMode (void)
void setCRCMode (void)
bool lastChecksum (void)
void enableStatus (void)
void disableStatus (void)
uint8_t lastStatus (void)
bool lastADC2Status (void)
bool lastADC1Status (void)
bool lastClockSource (void)
bool lastADC1LowReferenceAlarm (void)
bool lastADC1PGAOutputLowAlarm (void)
bool lastADC1PGAOutputHighAlarm (void)
bool lastADC1PGADifferentialOutputAlarm (void)
bool lastReset (void)
void setContinuousMode (void)
void setPulseMode (void)
void setChopMode (uint8_t mode)
void setDelay (uint8_t del)
 MODE1 register.
void setFilter (uint8_t filter)
void setBiasADC (uint8_t adc_choice)
void setBiasPolarity (uint8_t polarity)
void setBiasMagnitude (uint8_t mag)
void enablePGA (void)
void bypassPGA (void)
void setGain (uint8_t gain)
void setRate (uint8_t rate)
void setReference (uint8_t negativeReference, uint8_t positiveReference)
void setOutputTDACP (bool enable)
void setReservedTDACP ()
void setOutputmagnitudeTDACP (uint8_t mag)
void setOutputTDACN (bool enable)
void setReservedTDACN ()
void setOutputmagnitudeTDACN (uint8_t mag)
void sendCommand (uint8_t command)
void readRegisters (uint8_t start_reg, uint8_t num)
void writeRegisters (uint8_t start_reg, uint8_t num)
uint8_t readRegister (uint8_t reg)
 SPI Communication Commands.
void readAllRegisters ()
void writeRegister (uint8_t reg)
void spi_rw (uint8_t buff[], uint8_t len)
bool check_checksum (uint32_t val, uint8_t byt)
bool check_crc (uint32_t val, uint8_t byt)
uint8_t msb_pos (uint64_t val)
 MODE0 register.

Public Attributes

ADS126X_REGISTER_Type REGISTER
__IO unsigned char * REGISTER_ARRAY = (uint8_t *)&REGISTER.ID.reg
bool cs_used = false
uint8_t cs_pin
bool start_used = false
uint8_t start_pin
SPIClass * _spi
ADS126X_STATUS_Type STATUS
bool CHECKSUM

Detailed Description

Definition at line 25 of file STAR_ADS126X.h.

Constructor & Destructor Documentation

◆ ADS126X()

ADS126X::ADS126X ( void )

< Initial ADC Setup

Definition at line 7 of file STAR_ADS126X.cpp.

Member Function Documentation

◆ begin() [1/3]

void ADS126X::begin ( uint8_t chip_select)

Definition at line 10 of file STAR_ADS126X.cpp.

References begin().

◆ begin() [2/3]

void ADS126X::begin ( uint8_t chip_select,
SPIClass * spi )

Regular ADC Commands.

Definition at line 14 of file STAR_ADS126X.cpp.

References _spi, cs_pin, cs_used, digitalWrite(), HIGH, OUTPUT, pinMode(), readAllRegisters(), and reset().

◆ begin() [3/3]

void ADS126X::begin ( void )

Referenced by begin().

◆ bypassPGA() [1/2]

void ADS126X::bypassPGA ( )
inline

Definition at line 27 of file STAR_ADS126X.h.

◆ bypassPGA() [2/2]

void ADS126X::bypassPGA ( void )

◆ calibrateGainADC1()

void ADS126X::calibrateGainADC1 ( uint8_t vcc_pin,
uint8_t gnd_pin )

◆ calibrateGainADC2()

void ADS126X::calibrateGainADC2 ( uint8_t vcc_pin,
uint8_t gnd_pin )

◆ calibrateSelfOffsetADC1()

void ADS126X::calibrateSelfOffsetADC1 ( void )

◆ calibrateSelfOffsetADC2()

void ADS126X::calibrateSelfOffsetADC2 ( void )

◆ calibrateSysOffsetADC1()

void ADS126X::calibrateSysOffsetADC1 ( uint8_t shorted1,
uint8_t shorted2 )

◆ calibrateSysOffsetADC2()

void ADS126X::calibrateSysOffsetADC2 ( uint8_t shorted1,
uint8_t shorted2 )

◆ check_checksum()

bool ADS126X::check_checksum ( uint32_t val,
uint8_t byt )

Definition at line 335 of file STAR_ADS126X.cpp.

References ADS126X_CHECK_BYTE, and diff().

Referenced by readADC2().

◆ check_crc()

bool ADS126X::check_crc ( uint32_t val,
uint8_t byt )

Definition at line 351 of file STAR_ADS126X.cpp.

References ADS126X_CRC_BYTE, CRC, and msb_pos().

Referenced by readADC2().

◆ checkResetBit()

bool ADS126X::checkResetBit ( void )

◆ clearResetBit()

void ADS126X::clearResetBit ( void )

◆ disableCheck()

void ADS126X::disableCheck ( void )

◆ disableInternalReference()

void ADS126X::disableInternalReference ( void )

◆ disableLevelShift()

void ADS126X::disableLevelShift ( void )

◆ disableStatus()

void ADS126X::disableStatus ( void )

◆ enableInternalReference()

void ADS126X::enableInternalReference ( void )

◆ enableLevelShift()

void ADS126X::enableLevelShift ( void )

◆ enablePGA()

void ADS126X::enablePGA ( void )

Definition at line 425 of file STAR_ADS126X.cpp.

References ADS126X_MODE2, ADS126X_PGA_ENABLE, REGISTER, and writeRegister().

◆ enableStatus()

void ADS126X::enableStatus ( void )

◆ lastADC1LowReferenceAlarm()

bool ADS126X::lastADC1LowReferenceAlarm ( void )

◆ lastADC1PGADifferentialOutputAlarm()

bool ADS126X::lastADC1PGADifferentialOutputAlarm ( void )

◆ lastADC1PGAOutputHighAlarm()

bool ADS126X::lastADC1PGAOutputHighAlarm ( void )

◆ lastADC1PGAOutputLowAlarm()

bool ADS126X::lastADC1PGAOutputLowAlarm ( void )

◆ lastADC1Status()

bool ADS126X::lastADC1Status ( void )

◆ lastADC2Status()

bool ADS126X::lastADC2Status ( void )

◆ lastChecksum()

bool ADS126X::lastChecksum ( void )

◆ lastClockSource()

bool ADS126X::lastClockSource ( void )

◆ lastReset()

bool ADS126X::lastReset ( void )

◆ lastStatus()

uint8_t ADS126X::lastStatus ( void )

◆ msb_pos()

uint8_t ADS126X::msb_pos ( uint64_t val)

MODE0 register.

Definition at line 368 of file STAR_ADS126X.cpp.

Referenced by check_crc().

◆ noOperation()

void ADS126X::noOperation ( void )

Definition at line 29 of file STAR_ADS126X.cpp.

References ADS126X_NOP, and sendCommand().

◆ readADC1() [1/3]

ADS126X::ADCReading ADS126X::readADC1 ( )
inline

Definition at line 42 of file STAR_ADS126X.h.

References g_mock_adc_checksum, and g_mock_adc_value.

Referenced by readADC1().

◆ readADC1() [2/3]

ADCReading ADS126X::readADC1 ( )

References neg_pin.

◆ readADC1() [3/3]

ADS126X::ADCReading ADS126X::readADC1 ( uint8_t pos_pin,
uint8_t neg_pin )

Definition at line 188 of file STAR_ADS126X.cpp.

References neg_pin, readADC1(), and setInputMux().

◆ readADC2() [1/2]

◆ readADC2() [2/2]

ADS126X::ADCReading ADS126X::readADC2 ( uint8_t pos_pin,
uint8_t neg_pin )

SPI Communication Commands.

Definition at line 253 of file STAR_ADS126X.cpp.

References neg_pin, readADC2(), and setADC2Mux().

◆ readAllRegisters()

void ADS126X::readAllRegisters ( )

Definition at line 322 of file STAR_ADS126X.cpp.

References ADS126X_REG_NUM, and readRegisters().

Referenced by begin().

◆ readRegister()

uint8_t ADS126X::readRegister ( uint8_t reg)

SPI Communication Commands.

Definition at line 327 of file STAR_ADS126X.cpp.

References readRegisters(), reg, and REGISTER_ARRAY.

◆ readRegisters()

void ADS126X::readRegisters ( uint8_t start_reg,
uint8_t num )

Definition at line 295 of file STAR_ADS126X.cpp.

References ADS126X_RREG, cs_pin, digitalWrite(), HIGH, LOW, REGISTER_ARRAY, and spi_rw().

Referenced by readAllRegisters(), and readRegister().

◆ reset()

void ADS126X::reset ( void )

Definition at line 33 of file STAR_ADS126X.cpp.

References ADS126X_RESET, and sendCommand().

Referenced by begin().

◆ sendCommand()

void ADS126X::sendCommand ( uint8_t command)

Definition at line 260 of file STAR_ADS126X.cpp.

References cs_pin, digitalWrite(), HIGH, LOW, and spi_rw().

Referenced by noOperation(), reset(), startADC2(), and stopADC2().

◆ setADC2Mux()

void ADS126X::setADC2Mux ( uint8_t pos_pin,
uint8_t neg_pin )

Definition at line 123 of file STAR_ADS126X.cpp.

References ADS126X_ADC2MUX, neg_pin, REGISTER, and writeRegister().

Referenced by readADC2().

◆ setBiasADC() [1/2]

void ADS126X::setBiasADC ( uint8_t adc)
inline

Definition at line 50 of file STAR_ADS126X.h.

References adc().

◆ setBiasADC() [2/2]

void ADS126X::setBiasADC ( uint8_t adc_choice)

◆ setBiasMagnitude() [1/2]

void ADS126X::setBiasMagnitude ( uint8_t mag)
inline

MODE2 register.

Definition at line 54 of file STAR_ADS126X.h.

◆ setBiasMagnitude() [2/2]

void ADS126X::setBiasMagnitude ( uint8_t mag)

◆ setBiasPolarity() [1/2]

void ADS126X::setBiasPolarity ( uint8_t pol)
inline

Definition at line 52 of file STAR_ADS126X.h.

◆ setBiasPolarity() [2/2]

void ADS126X::setBiasPolarity ( uint8_t polarity)

◆ setChecksumMode()

void ADS126X::setChecksumMode ( void )

◆ setChopMode()

void ADS126X::setChopMode ( uint8_t mode)

Definition at line 387 of file STAR_ADS126X.cpp.

References ADS126X_MODE0, REGISTER, and writeRegister().

◆ setContinuousMode()

void ADS126X::setContinuousMode ( void )

Definition at line 377 of file STAR_ADS126X.cpp.

References ADS126X_CONV_CONT, ADS126X_MODE0, REGISTER, and writeRegister().

◆ setCRCMode()

void ADS126X::setCRCMode ( void )

◆ setDelay()

void ADS126X::setDelay ( uint8_t del)

MODE1 register.

Definition at line 392 of file STAR_ADS126X.cpp.

References ADS126X_MODE0, REGISTER, and writeRegister().

◆ setFilter()

void ADS126X::setFilter ( uint8_t filter)

Definition at line 401 of file STAR_ADS126X.cpp.

References ADS126X_MODE1, REGISTER, and writeRegister().

◆ setGain()

void ADS126X::setGain ( uint8_t gain)

Definition at line 435 of file STAR_ADS126X.cpp.

References ADS126X_MODE2, REGISTER, and writeRegister().

◆ setIDAC1Mag() [1/2]

void ADS126X::setIDAC1Mag ( uint8_t mag)
inline

Definition at line 46 of file STAR_ADS126X.h.

◆ setIDAC1Mag() [2/2]

void ADS126X::setIDAC1Mag ( uint8_t magnitude)

◆ setIDAC1Pin()

void ADS126X::setIDAC1Pin ( uint8_t pin)

Definition at line 501 of file STAR_ADS126X.cpp.

References ADS126X_IDACMUX, REGISTER, and writeRegister().

◆ setIDAC2Mag() [1/2]

void ADS126X::setIDAC2Mag ( uint8_t mag)
inline

Definition at line 48 of file STAR_ADS126X.h.

◆ setIDAC2Mag() [2/2]

void ADS126X::setIDAC2Mag ( uint8_t magnitude)

◆ setIDAC2Pin()

void ADS126X::setIDAC2Pin ( uint8_t pin)

Definition at line 509 of file STAR_ADS126X.cpp.

References ADS126X_IDACMUX, REGISTER, and writeRegister().

◆ setInputMux() [1/2]

void ADS126X::setInputMux ( uint8_t pos,
uint8_t neg )
inline

Definition at line 29 of file STAR_ADS126X.h.

Referenced by readADC1().

◆ setInputMux() [2/2]

void ADS126X::setInputMux ( uint8_t pos_pin,
uint8_t neg_pin )

References neg_pin.

◆ setOutputmagnitudeTDACN() [1/2]

void ADS126X::setOutputmagnitudeTDACN ( uint8_t mag)
inline

IDAC functionality.

Definition at line 37 of file STAR_ADS126X.h.

◆ setOutputmagnitudeTDACN() [2/2]

void ADS126X::setOutputmagnitudeTDACN ( uint8_t mag)

◆ setOutputmagnitudeTDACP() [1/2]

void ADS126X::setOutputmagnitudeTDACP ( uint8_t mag)
inline

Definition at line 35 of file STAR_ADS126X.h.

◆ setOutputmagnitudeTDACP() [2/2]

void ADS126X::setOutputmagnitudeTDACP ( uint8_t mag)

References enable().

◆ setOutputTDACN() [1/2]

void ADS126X::setOutputTDACN ( bool enable)

Definition at line 480 of file STAR_ADS126X.cpp.

References ADS126X_TDACN, enable(), REGISTER, and writeRegister().

◆ setOutputTDACN() [2/2]

void ADS126X::setOutputTDACN ( uint8_t on)
inline

Definition at line 33 of file STAR_ADS126X.h.

◆ setOutputTDACP() [1/2]

void ADS126X::setOutputTDACP ( bool enable)

Definition at line 458 of file STAR_ADS126X.cpp.

References ADS126X_TDACP, enable(), REGISTER, and writeRegister().

◆ setOutputTDACP() [2/2]

void ADS126X::setOutputTDACP ( uint8_t on)
inline

Definition at line 31 of file STAR_ADS126X.h.

◆ setPulseMode()

void ADS126X::setPulseMode ( void )

Definition at line 382 of file STAR_ADS126X.cpp.

References ADS126X_CONV_PULSE, ADS126X_MODE0, REGISTER, and writeRegister().

◆ setRate()

void ADS126X::setRate ( uint8_t rate)

Definition at line 440 of file STAR_ADS126X.cpp.

References ADS126X_MODE2, REGISTER, and writeRegister().

◆ setReference() [1/2]

void ADS126X::setReference ( uint8_t neg,
uint8_t pos )
inline

TDAC Registers.

Definition at line 39 of file STAR_ADS126X.h.

◆ setReference() [2/2]

void ADS126X::setReference ( uint8_t negativeReference,
uint8_t positiveReference )

References enable().

◆ setReservedTDACN()

void ADS126X::setReservedTDACN ( )

◆ setReservedTDACP()

void ADS126X::setReservedTDACP ( )

◆ setStartPin()

void ADS126X::setStartPin ( uint8_t pin)

◆ spi_rw()

void ADS126X::spi_rw ( uint8_t buff[],
uint8_t len )

Definition at line 529 of file STAR_ADS126X.cpp.

References _spi, and SPI_MODE1.

Referenced by readADC2(), readRegisters(), sendCommand(), and writeRegisters().

◆ startADC1() [1/2]

void ADS126X::startADC1 ( )
inline

Definition at line 58 of file STAR_ADS126X.h.

◆ startADC1() [2/2]

void ADS126X::startADC1 ( void )

◆ startADC2()

void ADS126X::startADC2 ( void )

Definition at line 45 of file STAR_ADS126X.cpp.

References ADS126X_START2, and sendCommand().

◆ stopADC1() [1/2]

void ADS126X::stopADC1 ( )
inline

Definition at line 56 of file STAR_ADS126X.h.

◆ stopADC1() [2/2]

void ADS126X::stopADC1 ( void )

◆ stopADC2()

void ADS126X::stopADC2 ( void )

Definition at line 49 of file STAR_ADS126X.cpp.

References ADS126X_STOP2, and sendCommand().

◆ writeRegister()

void ADS126X::writeRegister ( uint8_t reg)

◆ writeRegisters()

void ADS126X::writeRegisters ( uint8_t start_reg,
uint8_t num )

Definition at line 271 of file STAR_ADS126X.cpp.

References ADS126X_WREG, cs_pin, digitalWrite(), HIGH, LOW, REGISTER_ARRAY, and spi_rw().

Referenced by writeRegister().

Member Data Documentation

◆ _spi

SPIClass* ADS126X::_spi

Definition at line 130 of file STAR_ADS126X.h.

Referenced by begin(), and spi_rw().

◆ CHECKSUM

bool ADS126X::CHECKSUM

Definition at line 133 of file STAR_ADS126X.h.

Referenced by readADC2().

◆ cs_pin

uint8_t ADS126X::cs_pin

Definition at line 126 of file STAR_ADS126X.h.

Referenced by begin(), readADC2(), readRegisters(), sendCommand(), and writeRegisters().

◆ cs_used

bool ADS126X::cs_used = false

Definition at line 125 of file STAR_ADS126X.h.

Referenced by begin().

◆ REGISTER

◆ REGISTER_ARRAY

__IO unsigned char* ADS126X::REGISTER_ARRAY = (uint8_t *)&REGISTER.ID.reg

Definition at line 123 of file STAR_ADS126X.h.

Referenced by readRegister(), readRegisters(), and writeRegisters().

◆ start_pin

uint8_t ADS126X::start_pin

Definition at line 128 of file STAR_ADS126X.h.

◆ start_used

bool ADS126X::start_used = false

Definition at line 127 of file STAR_ADS126X.h.

◆ STATUS

ADS126X_STATUS_Type ADS126X::STATUS

Definition at line 132 of file STAR_ADS126X.h.

Referenced by readADC2().


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