#include <ADS101x.h>

Inheritance diagram for aruna::driver::ADS101x:

Collaboration diagram for aruna::driver::ADS101x:

Public Types
enum	MUX { MUX::DEFAULT = 0b000 << 12, MUX::AINp0_AINn1 = 0b000 << 12, MUX::AINp0_AINn3 = 0b001 << 12, MUX::AINp1_AINn3 = 0b010 << 12, MUX::AINp2_AINn3 = 0b011 << 12, MUX::AINp0_AINnGND = 0b100 << 12, MUX::AINp1_AINnGND = 0b101 << 12, MUX::AINp2_AINnGND = 0b110 << 12, MUX::AINp3_AINnGND = 0b111 << 12 }
	Input multiplexer configuration (ADS1015 only) These bits configure the input multiplexer. More...

Public Member Functions
err_t	isConnected (uint8_t address)
	check if device is connected and functional More...

	ADS101x (MUX compare, I2C_master *i2c_bus, uint8_t address=default_address)
	ADS101x I²C 12 bit ADC with four channels. More...

Public Member Functions inherited from aruna::driver::ADC
template<typename T >
err_t	read_raw (T &raw)
	Read raw value from ADC, convert to voltage yourself. More...

template<typename T >
err_t	read_voltage (T &mV)
	Read voltage level of input. More...

size_t	get_resolution () const
	Get the resolution in bits of the ADC. More...

uint16_t	get_reference () const
	Get the reference voltage in micro Voltage. More...

virtual int32_t	raw_to_voltage (int32_t raw)
	Convert raw data to voltage. More...

template<typename T >
aruna::err_t	read_raw (T &raw)

template<typename T >
aruna::err_t	read_voltage (T &mV)

Private Types
enum	register_address_pointer { register_address_pointer::CONVERSION = 0b00, register_address_pointer::CONFIG = 0b01, register_address_pointer::LO_TRESH = 0b10, register_address_pointer::HI_TRESH = 0b11 }
	Pointer to the registers. More...

enum	reset_value { reset_value::CONVERSION = 0x0000, reset_value::CONFIG = 0x8583, reset_value::LO_THRESH = 0x8000, reset_value::HI_THRESH = 0x7FFF }
	write these values to the respected registers to reset them to their default value. More...

enum	OS { OS::W_NO_EFFECT = 0b0 << 15, OS::W_START_A_SINGLE_CONVERSION = 0b1 << 15, OS::R_DEVICE_IS_CURRENTLY_PERFORMING_A_CONVERSION = 0b0 << 15, OS::R_DEVICE_IS_NOT_CURRENTLY_PERFORMING_A_CONVERSION = 0b1 << 15 }
	Operational status or single-shot conversion start This bit determines the operational status of the device. More...

enum	PGA { PGA::DEFAULT = 0b010 << 9, PGA::FSR_6144mV = 0b000 << 9, PGA::FSR_4096mV = 0b001 << 9, PGA::FSR_2048mV = 0b010 << 9, PGA::FSR_1024mV = 0b011 << 9, PGA::FSR_0512mV = 0b100 << 9, PGA::FSR_0256mV = 0b101 << 9 }
	Programmable gain amplifier configuration These bits set the FSR of the programmable gain amplifier. More...

enum	MODE { MODE::DEFAULT = 0b1 << 8, MODE::CONTINUOUS_CONVERSION = 0b0 << 8, MODE::SINGLE_SHOT = 0b1 << 8 }
	Device operating mode This bit controls the operating mode. More...

enum	DR { DR::DEFAULT = 0b100 << 5, DR::SPS_128 = 0b000 << 5, DR::SPS_250 = 0b001 << 5, DR::SPS_490 = 0b010 << 5, DR::SPS_920 = 0b011 << 5, DR::SPS_1600 = 0b100 << 5, DR::SPS_2400 = 0b101 << 5, DR::SPS_3300 = 0b110 << 5 }
	Data rate These bits control the data rate setting. More...

enum	COMP_MODE { COMP_MODE::DEFAULT = 0b0 << 4, COMP_MODE::TRADITIONAL = 0b0 << 4, COMP_MODE::WINDOW = 0b1 << 4 }
	Comparator mode (ADS1014 and ADS1015 only) This bit configures the comparator operating mode. More...

enum	COMP_POL { COMP_POL::DEFAULT = 0b0 << 3, COMP_POL::ACTIVE_LOW = 0b0 << 3, COMP_POL::ACTIVE_HIGH = 0b1 << 3 }
	Comparator polarity (ADS1014 and ADS1015 only) This bit controls the polarity of the ALERT/RDY pin. More...

enum	COMP_LAT { COMP_LAT::DEFAULT = 0b0 << 2, COMP_LAT::NONLATCHING_COMPARATOR = 0b0 << 2, COMP_LAT::LATCHING_COMPARATOR = 0b1 << 2 }
	Latching comparator (ADS1014 and ADS1015 only) This bit controls whether the ALERT/RDY pin latches after being asserted or clears after conversions are within the margin of the upper and lower threshold values. More...

enum	COMP_QUEUE { COMP_QUEUE::DEFAULT = 0b11, COMP_QUEUE::ASSERT_AFTER_ONE_CONVERSION = 0b00, COMP_QUEUE::ASSERT_AFTER_TWO_CONVERSIONS = 0b01, COMP_QUEUE::ASSERT_AFTER_FOUR_CONVERSION = 0b10, COMP_QUEUE::DISABLE_COMPARATOR_AND_SET_ALERT_RDY_PIN_TO_HIGH_IMPEDANCE = 0b11 }
	Comparator queue and disable (ADS1014 and ADS1015 only) These bits perform two functions. More...

Private Member Functions
err_t	_read (int32_t &raw) override
	Read analogue value and convert to 32bit signed resolution. More...

Private Attributes
const MUX	compare

I2C_master *	i2c_bus

uint8_t const	i2c_address

Static Private Attributes
uint8_t static const	default_address = 0b1001000

Additional Inherited Members
Protected Member Functions inherited from aruna::driver::ADC
err_t	set_resolution (size_t bits)
	Set resolution of ADC. More...

err_t	set_reference (uint16_t mV)
	set reference voltage, used to convert raw data to voltage. More...

Detailed Description

Definition at line 13 of file ADS101x.h.

Member Enumeration Documentation

◆ COMP_LAT

enum aruna::driver::ADS101x::COMP_LAT

strongprivate

Latching comparator (ADS1014 and ADS1015 only) This bit controls whether the ALERT/RDY pin latches after being asserted or clears after conversions are within the margin of the upper and lower threshold values.

This bit serves no function on the ADS1013.

Enumerator
DEFAULT
NONLATCHING_COMPARATOR
LATCHING_COMPARATOR

Definition at line 148 of file ADS101x.h.

                                 {
                 DEFAULT = 0b0 << 2,
                 NONLATCHING_COMPARATOR = 0b0 << 2,
                 LATCHING_COMPARATOR = 0b1 << 2,
             };

◆ COMP_MODE

enum aruna::driver::ADS101x::COMP_MODE

strongprivate

Comparator mode (ADS1014 and ADS1015 only) This bit configures the comparator operating mode.

This bit serves no function on the ADS1013.

Enumerator
DEFAULT
TRADITIONAL
WINDOW

Definition at line 126 of file ADS101x.h.

                                  {
                 DEFAULT = 0b0 << 4,
                 TRADITIONAL = 0b0 << 4,
                 WINDOW = 0b1 << 4,
             };

◆ COMP_POL

enum aruna::driver::ADS101x::COMP_POL

strongprivate

Comparator polarity (ADS1014 and ADS1015 only) This bit controls the polarity of the ALERT/RDY pin.

This bit serves no function on the ADS1013.

Enumerator
DEFAULT
ACTIVE_LOW
ACTIVE_HIGH

Definition at line 136 of file ADS101x.h.

                                 {
                 DEFAULT = 0b0 << 3,
                 ACTIVE_LOW = 0b0 << 3,
                 ACTIVE_HIGH = 0b1 << 3,
             };

◆ COMP_QUEUE

enum aruna::driver::ADS101x::COMP_QUEUE

strongprivate

Comparator queue and disable (ADS1014 and ADS1015 only) These bits perform two functions.

When set to 11, the comparator is disabled and the ALERT/RDY pin is set to a high-impedance state. When set to any other value, the ALERT/RDY pin and the comparator function are enabled, and the set value determines the number of successive conversions exceeding the upper or lower threshold required before asserting the ALERT/RDY pin. These bits serve no function on the ADS1013.

Enumerator
DEFAULT
ASSERT_AFTER_ONE_CONVERSION
ASSERT_AFTER_TWO_CONVERSIONS
ASSERT_AFTER_FOUR_CONVERSION
DISABLE_COMPARATOR_AND_SET_ALERT_RDY_PIN_TO_HIGH_IMPEDANCE

Definition at line 163 of file ADS101x.h.

                                   {
                 DEFAULT = 0b11,
                 ASSERT_AFTER_ONE_CONVERSION = 0b00,
                 ASSERT_AFTER_TWO_CONVERSIONS = 0b01,
                 ASSERT_AFTER_FOUR_CONVERSION = 0b10,
                 DISABLE_COMPARATOR_AND_SET_ALERT_RDY_PIN_TO_HIGH_IMPEDANCE = 0b11,
             };

◆ DR

enum aruna::driver::ADS101x::DR

strongprivate

Data rate These bits control the data rate setting.

Enumerator
DEFAULT
SPS_128
SPS_250
SPS_490
SPS_920
SPS_1600
SPS_2400
SPS_3300

Definition at line 111 of file ADS101x.h.

                           {
                 DEFAULT = 0b100 << 5,
                 SPS_128 = 0b000 << 5,
                 SPS_250 = 0b001 << 5,
                 SPS_490 = 0b010 << 5,
                 SPS_920 = 0b011 << 5,
                 SPS_1600 = 0b100 << 5,
                 SPS_2400 = 0b101 << 5,
                 SPS_3300 = 0b110 << 5,
             };

◆ MODE

enum aruna::driver::ADS101x::MODE

strongprivate

Device operating mode This bit controls the operating mode.

Enumerator
DEFAULT
CONTINUOUS_CONVERSION
SINGLE_SHOT

Definition at line 101 of file ADS101x.h.

                             {
                 DEFAULT = 0b1 << 8,
                 CONTINUOUS_CONVERSION = 0b0 << 8,
                 SINGLE_SHOT = 0b1 << 8,
             };

◆ MUX

enum aruna::driver::ADS101x::MUX

strong

Input multiplexer configuration (ADS1015 only) These bits configure the input multiplexer.

These bits serve no function on the ADS1013 and ADS1014.

Enumerator
DEFAULT
AINp0_AINn1
AINp0_AINn3
AINp1_AINn3
AINp2_AINn3
AINp0_AINnGND
AINp1_AINnGND
AINp2_AINnGND
AINp3_AINnGND

Definition at line 19 of file ADS101x.h.

                            {
                 DEFAULT = 0b000 << 12,
                 AINp0_AINn1 = 0b000 << 12,
                 AINp0_AINn3 = 0b001 << 12,
                 AINp1_AINn3 = 0b010 << 12,
                 AINp2_AINn3 = 0b011 << 12,
                 AINp0_AINnGND = 0b100 << 12,
                 AINp1_AINnGND = 0b101 << 12,
                 AINp2_AINnGND = 0b110 << 12,
                 AINp3_AINnGND = 0b111 << 12,
             };

◆ OS

enum aruna::driver::ADS101x::OS

strongprivate

Operational status or single-shot conversion start This bit determines the operational status of the device.

OS can only be written when in power-down state and has no effect when a conversion is ongoing.

Enumerator
W_NO_EFFECT
W_START_A_SINGLE_CONVERSION
R_DEVICE_IS_CURRENTLY_PERFORMING_A_CONVERSION
R_DEVICE_IS_NOT_CURRENTLY_PERFORMING_A_CONVERSION

Definition at line 75 of file ADS101x.h.

                           {
                 W_NO_EFFECT = 0b0 << 15,
                 W_START_A_SINGLE_CONVERSION = 0b1 << 15,
                 R_DEVICE_IS_CURRENTLY_PERFORMING_A_CONVERSION = 0b0 << 15,
                 R_DEVICE_IS_NOT_CURRENTLY_PERFORMING_A_CONVERSION = 0b1 << 15,
             };

◆ PGA

enum aruna::driver::ADS101x::PGA

strongprivate

Programmable gain amplifier configuration These bits set the FSR of the programmable gain amplifier.

These bits serve no function on the ADS1013.

Enumerator
DEFAULT
FSR_6144mV
FSR_4096mV
FSR_2048mV
FSR_1024mV
FSR_0512mV
FSR_0256mV

Definition at line 87 of file ADS101x.h.

                            {
                 DEFAULT = 0b010 << 9,
                 FSR_6144mV = 0b000 << 9,
                 FSR_4096mV = 0b001 << 9,
                 FSR_2048mV = 0b010 << 9,
                 FSR_1024mV = 0b011 << 9,
                 FSR_0512mV = 0b100 << 9,
                 FSR_0256mV = 0b101 << 9,
             };

◆ register_address_pointer

enum aruna::driver::ADS101x::register_address_pointer

strongprivate

Pointer to the registers.

Enumerator
CONVERSION
CONFIG
LO_TRESH
HI_TRESH

Definition at line 53 of file ADS101x.h.

                                                 {
                 CONVERSION = 0b00,
                 CONFIG = 0b01,
                 LO_TRESH = 0b10,
                 HI_TRESH = 0b11,
             };

◆ reset_value

enum aruna::driver::ADS101x::reset_value

strongprivate

write these values to the respected registers to reset them to their default value.

Enumerator
CONVERSION
CONFIG
LO_THRESH
HI_THRESH

Definition at line 63 of file ADS101x.h.

                                    {
                 CONVERSION = 0x0000,
                 CONFIG = 0x8583,
                 LO_THRESH = 0x8000,
                 HI_THRESH = 0x7FFF,
             };

Constructor & Destructor Documentation

◆ ADS101x()

ADS101x::ADS101x	(	ADS101x::MUX	compare,
		I2C_master *	i2c_bus,
		uint8_t	address = `default_address`
	)

ADS101x I²C 12 bit ADC with four channels.

Parameters

compare	select pin and comparison
i2c_bus	I²C Bus for communication
address	optional I²C address, will use default address if not omitted.

Definition at line 53 of file ADS101x.cpp.

                                                                          : compare(compare), i2c_bus(i2c_bus),
                                                                                i2c_address(address) {
     set_reference(3300);
     set_resolution(12);
 
 }

Here is the call graph for this function:

Member Function Documentation

◆ _read()

err_t ADS101x::_read ( int32_t & raw )

overrideprivatevirtual

Read analogue value and convert to 32bit signed resolution.

Parameters

raw	store result here

Returns: error code

Implements aruna::driver::ADC.

Definition at line 12 of file ADS101x.cpp.

                                  {
     err_t err = err_t::OK;
     int16_t conversion = 0;
     uint16_t config = (int) ADS101x::OS::W_START_A_SINGLE_CONVERSION |
                       (int) compare |
                       (int) ADS101x::PGA::DEFAULT |
                       (int) ADS101x::MODE::CONTINUOUS_CONVERSION |
                       (int) ADS101x::DR::DEFAULT |
                       (int) ADS101x::COMP_MODE::DEFAULT |
                       (int) ADS101x::COMP_POL::DEFAULT |
                       (int) ADS101x::COMP_LAT::DEFAULT |
                       (int) ADS101x::COMP_QUEUE::DEFAULT;
 
     uint8_t data[2];
     uint8_t config_array[2]={ static_cast<uint8_t>(config & 0xff), static_cast<uint8_t>(config >> 8) };
 //                write config
     err = i2c_bus->write(i2c_address, (uint8_t) register_address_pointer::CONFIG, config_array, 2);
     if ((bool) err)
         return err;
 //                set Conversion register to read and read conversion register
     err = i2c_bus->read(i2c_address, (uint8_t) register_address_pointer::CONVERSION, data, 2);
 //    printf("read: 0x%X%X\n", data[0], data[1]);
     conversion = (int16_t) (data[0] << 8 | (data[1] & 0xFF));
     conversion = conversion >> 4;
 //              TODO use function from Actuator.h
 //    raw = ((conversion * (4096 - 0)) / 2047) + 0;
 
     double input, inputLow, inputHigh, outputHigh, outputLow;
     input = conversion;
     inputLow = -2048;
     inputHigh = 2047;
     outputHigh = INT32_MAX;
     outputLow = INT32_MIN;
 // TODO make convert_range function and replace Actuator::convert_range with this
 // TODO range converting should be done by the ADC parent.
 // https://gamedev.stackexchange.com/questions/33441/how-to-convert-a-number-from-one-min-max-set-to-another-min-max-set
     raw = ((input - inputLow) / (inputHigh - inputLow)) * (outputHigh - outputLow) + outputLow;
     return err;
 }

Here is the call graph for this function:

◆ isConnected()

err_t aruna::driver::ADS101x::isConnected ( uint8_t address )

check if device is connected and functional

Parameters

address,I²C address

Returns: err_t::OK if OK.

Member Data Documentation

◆ compare

const MUX aruna::driver::ADS101x::compare

private

Definition at line 171 of file ADS101x.h.

◆ default_address

uint8_t static const aruna::driver::ADS101x::default_address = 0b1001000

staticprivate

Definition at line 48 of file ADS101x.h.

◆ i2c_address

uint8_t const aruna::driver::ADS101x::i2c_address

private

Definition at line 173 of file ADS101x.h.

◆ i2c_bus

I2C_master* aruna::driver::ADS101x::i2c_bus

private

Definition at line 172 of file ADS101x.h.

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

include/aruna/driver/ADS101x.h
src/driver/ADS101x.cpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ COMP_LAT

◆ COMP_MODE

◆ COMP_POL

◆ COMP_QUEUE

◆ DR

◆ MODE

◆ MUX

◆ OS

◆ PGA

◆ register_address_pointer

◆ reset_value

Constructor & Destructor Documentation

◆ ADS101x()

Member Function Documentation

◆ _read()

◆ isConnected()

Member Data Documentation

◆ compare

◆ default_address

◆ i2c_address

◆ i2c_bus