#include <ADC.h>

Classes
struct	Sync_result
	Struct for synchronous measurements. More...

Public Member Functions
	ADC ()

void	resetError ()

ADC settings
void	setReference (ADC_REFERENCE type)
	Set the voltage reference for all ADCs, default is vcc. More...

void	setResolution (uint8_t bits)
	Change the resolution for all ADCs. More...

void	setConversionSpeed (ADC_CONVERSION_SPEED speed)
	Sets the conversion speed for all ADCs. More...

void	setSamplingSpeed (ADC_SAMPLING_SPEED speed)
	Sets the sampling speed for all ADCs. More...

void	setAveraging (uint8_t num)
	Set the number of averages for all ADCs. More...

void	enableInterrupts (void(*isr)(void), uint8_t priority=255)
	Enable interrupts for all ADCs. More...

void	disableInterrupts ()
	Disable interrupts for all ADCs.

void	enableDMA ()
	Enable DMA request for all ADCs. More...

void	disableDMA ()
	Disable DMA request for all ADCs.

void	enableCompare (int16_t compValue, bool greaterThan)
	Enable the compare function to a single value. More...

void	enableCompareRange (int16_t lowerLimit, int16_t upperLimit, bool insideRange, bool inclusive)
	Enable the compare function to a range. More...

void	disableCompare ()
	Disable the compare function. More...

Blocking conversion methods
int	analogRead (uint8_t pin, int8_t adc_num=-1)
	Returns the analog value of the pin. More...

int	analogRead (ADC_INTERNAL_SOURCE pin, int8_t adc_num=-1)

int	analogReadDifferential (uint8_t pinP, uint8_t pinN, int8_t adc_num=-1)
	Reads the differential analog value of two pins (pinP - pinN). More...

Non-blocking conversion methods
bool	startSingleRead (uint8_t pin, int8_t adc_num=-1)
	Starts an analog measurement on the pin and enables interrupts. More...

bool	startSingleDifferential (uint8_t pinP, uint8_t pinN, int8_t adc_num=-1)

int	readSingle (int8_t adc_num=-1)
	Reads the analog value of a single conversion. More...

Continuous conversion methods
bool	startContinuous (uint8_t pin, int8_t adc_num=-1)
	Starts continuous conversion on the pin. More...

bool	startContinuousDifferential (uint8_t pinP, uint8_t pinN, int8_t adc_num=-1)
	Starts continuous conversion between the pins (pinP-pinN). More...

int	analogReadContinuous (int8_t adc_num=-1)
	Reads the analog value of a continuous conversion. More...

void	stopContinuous (int8_t adc_num=-1)
	Stops continuous conversion. More...

Synchronized conversion methods
ADC0 and ADC1 will measure simultaneously
Sync_result	analogSynchronizedRead (uint8_t pin0, uint8_t pin1)

Sync_result	analogSyncRead (uint8_t pin0, uint8_t pin1)
	Same as analogSynchronizedRead. More...

Sync_result	analogSynchronizedReadDifferential (uint8_t pin0P, uint8_t pin0N, uint8_t pin1P, uint8_t pin1N)

Sync_result	analogSyncReadDifferential (uint8_t pin0P, uint8_t pin0N, uint8_t pin1P, uint8_t pin1N)
	Same as analogSynchronizedReadDifferential. More...

bool	startSynchronizedSingleRead (uint8_t pin0, uint8_t pin1)
	Starts an analog measurement at the same time on the two ADC modules. More...

bool	startSynchronizedSingleDifferential (uint8_t pin0P, uint8_t pin0N, uint8_t pin1P, uint8_t pin1N)

Sync_result	readSynchronizedSingle ()
	Reads the analog value of a single conversion. More...

bool	startSynchronizedContinuous (uint8_t pin0, uint8_t pin1)
	Starts a continuous conversion in both ADCs simultaneously. More...

bool	startSynchronizedContinuousDifferential (uint8_t pin0P, uint8_t pin0N, uint8_t pin1P, uint8_t pin1N)
	Starts a continuous differential conversion in both ADCs simultaneously. More...

Sync_result	readSynchronizedContinuous ()
	Returns the values of both ADCs. More...

void	stopSynchronizedContinuous ()
	Stops synchronous continuous conversion.

Public Attributes
ADC_Module *const	adc0 = &adc0_obj
	Object to control the ADC0.

ADC_Module *const	adc1 = &adc1_obj
	Object to control the ADC1.

ADC_Module *const	adc [ADC_NUM_ADCS] = {adc0, adc1}
	Array with the ADC Modules.

Static Public Attributes
static const uint8_t	channel2sc1aADC0 [ADC_MAX_PIN+1]
	Translate pin number to SC1A nomenclature. More...

static const uint8_t	channel2sc1aADC1 [ADC_MAX_PIN+1]
	Translate pin number to SC1A nomenclature. More...

static const uint8_t	sc1a2channelADC0 [ADC_MAX_PIN+1]
	Translate pin number to SC1A nomenclature for differential pins. More...

static const uint8_t	sc1a2channelADC1 [ADC_MAX_PIN+1]
	Translate pin number to SC1A nomenclature for differential pins. More...

static const ADC_Module::ADC_NLIST	diff_table_ADC0 [ADC_DIFF_PAIRS]
	Translate differential pin number to SC1A nomenclature. More...

static const ADC_Module::ADC_NLIST	diff_table_ADC1 [ADC_DIFF_PAIRS]
	Translate differential pin number to SC1A nomenclature. More...

Detailed Description

Class ADC: Controls the Teensy 3.x, 4 ADC

Definition at line 69 of file ADC.h.

Constructor & Destructor Documentation

◆ ADC()

ADC::ADC ( )

Default constructor

Definition at line 257 of file ADC.cpp.

Member Function Documentation

◆ analogRead() [1/2]

int ADC::analogRead	(	ADC_INTERNAL_SOURCE	pin,
		int8_t	adc_num = `-1`
	)

inline

Returns the analog value of the special internal source, such as the temperature sensor.

Parameters

pin	ADC_INTERNAL_SOURCE to read.
adc_num	ADC_X ADC module

Returns: the value of the pin.

Definition at line 323 of file ADC.h.

◆ analogRead() [2/2]

int ADC::analogRead	(	uint8_t	pin,
		int8_t	adc_num = `-1`
	)

Returns the analog value of the pin.

It waits until the value is read and then returns the result. If a comparison has been set up and fails, it will return ADC_ERROR_VALUE. This function is interrupt safe, so it will restore the adc to the state it was before being called If more than one ADC exists, it will select the module with less workload, you can force a selection using adc_num. If you select ADC1 in a board with just one ADC, it will return ADC_ERROR_VALUE.

Parameters

pin	can be any of the analog pins
adc_num	ADC_X ADC module

Returns: the analog value of the pin.

Definition at line 284 of file ADC.cpp.

◆ analogReadContinuous()

int ADC::analogReadContinuous ( int8_t adc_num = -1 )

Reads the analog value of a continuous conversion.

Set the continuous conversion with with analogStartContinuous(pin) or startContinuousDifferential(pinP, pinN). If single-ended and 16 bits it's necessary to typecast it to an unsigned type (like uint16_t), otherwise values larger than 3.3/2 V are interpreted as negative!

Parameters

adc_num ADC_X ADC module

Returns: the last converted value.

Set the continuous conversion with with analogStartContinuous(pin) or startContinuousDifferential(pinP, pinN).

Returns: the last converted value. If single-ended and 16 bits it's necessary to typecast it to an unsigned type (like uint16_t), otherwise values larger than 3.3/2 V are interpreted as negative!

Definition at line 660 of file ADC.cpp.

◆ analogReadDifferential()

int ADC::analogReadDifferential	(	uint8_t	pinP,
		uint8_t	pinN,
		int8_t	adc_num = `-1`
	)

Reads the differential analog value of two pins (pinP - pinN).

It waits until the value is read and then returns the result. This function is interrupt safe, so it will restore the adc to the state it was before being called If more than one ADC exists, it will select the module with less workload, you can force a selection using adc_num

Parameters

pinP	must be A10 or A12.
pinN	must be A11 (if pinP=A10) or A13 (if pinP=A12).
adc_num	ADC_X ADC module

Returns: the differential value of the pins, invalid pins return ADC_ERROR_VALUE. If a comparison has been set up and fails, it will return ADC_ERROR_VALUE.

Definition at line 347 of file ADC.cpp.

◆ analogSynchronizedRead()

ADC::Sync_result ADC::analogSynchronizedRead	(	uint8_t	pin0,
		uint8_t	pin1
	)

Returns the analog values of both pins, measured at the same time by the two ADC modules. It waits until the values are read and then returns the result as a struct Sync_result, use Sync_result.result_adc0 and Sync_result.result_adc1. If a comparison has been set up and fails, it will return ADC_ERROR_VALUE in both fields of the struct. This function is interrupt safe, so it will restore the adc to the state it was before being called

Parameters

pin0	pin in ADC0
pin1	pin in ADC1

Returns: a Sync_result struct with the result of each ADC value.

Definition at line 700 of file ADC.cpp.

◆ analogSynchronizedReadDifferential()

ADC::Sync_result ADC::analogSynchronizedReadDifferential	(	uint8_t	pin0P,
		uint8_t	pin0N,
		uint8_t	pin1P,
		uint8_t	pin1N
	)

Returns the differential analog values of both sets of pins, measured at the same time by the two ADC modules. It waits until the values are read and then returns the result as a struct Sync_result, use Sync_result.result_adc0 and Sync_result.result_adc1. If a comparison has been set up and fails, it will return ADC_ERROR_VALUE in both fields of the struct. This function is interrupt safe, so it will restore the adc to the state it was before being called

Parameters

pin0P	positive pin in ADC0
pin0N	negative pin in ADC0
pin1P	positive pin in ADC1
pin1N	negative pin in ADC1

Returns: a Sync_result struct with the result of each differential ADC value.

Definition at line 796 of file ADC.cpp.

◆ analogSyncRead()

Sync_result ADC::analogSyncRead	(	uint8_t	pin0,
		uint8_t	pin1
	)

inline

Same as analogSynchronizedRead.

Parameters

pin0	pin in ADC0
pin1	pin in ADC1

Returns: a Sync_result struct with the result of each ADC value.

Definition at line 467 of file ADC.h.

◆ analogSyncReadDifferential()

Sync_result ADC::analogSyncReadDifferential	(	uint8_t	pin0P,
		uint8_t	pin0N,
		uint8_t	pin1P,
		uint8_t	pin1N
	)

inline

Same as analogSynchronizedReadDifferential.

Parameters

pin0P	positive pin in ADC0
pin0N	negative pin in ADC0
pin1P	positive pin in ADC1
pin1N	negative pin in ADC1

Returns: a Sync_result struct with the result of each differential ADC value.

Definition at line 499 of file ADC.h.

◆ disableCompare()

void ADC::disableCompare ( )

inline

Disable the compare function.

Definition at line 266 of file ADC.h.

◆ enableCompare()

void ADC::enableCompare	(	int16_t	compValue,
		bool	greaterThan
	)

inline

Enable the compare function to a single value.

A conversion will be completed only when the ADC value is >= compValue (greaterThan=1) or < compValue (greaterThan=0) Call it after changing the resolution Use with interrupts or poll conversion completion with isComplete()

Parameters

compValue	value to compare
greaterThan	true or false

Definition at line 233 of file ADC.h.

◆ enableCompareRange()

void ADC::enableCompareRange	(	int16_t	lowerLimit,
		int16_t	upperLimit,
		bool	insideRange,
		bool	inclusive
	)

inline

Enable the compare function to a range.

A conversion will be completed only when the ADC value is inside (insideRange=1) or outside (=0) the range given by (lowerLimit, upperLimit),including (inclusive=1) the limits or not (inclusive=0). See Table 31-78, p. 617 of the freescale manual. Call it after changing the resolution Use with interrupts or poll conversion completion with isComplete()

Parameters

lowerLimit	lower value to compare
upperLimit	upper value to compare
insideRange	true or false
inclusive	true or false

Definition at line 254 of file ADC.h.

◆ enableDMA()

void ADC::enableDMA ( )

inline

Enable DMA request for all ADCs.

An ADC DMA request will be raised when the conversion is completed (including hardware averages and if the comparison (if any) is true).

Definition at line 205 of file ADC.h.

◆ enableInterrupts()

void ADC::enableInterrupts	(	void(*)(void)	isr,
		uint8_t	priority = `255`
	)

inline

Enable interrupts for all ADCs.

An IRQ_ADCx Interrupt will be raised when the conversion is completed (including hardware averages and if the comparison (if any) is true).

Parameters

isr	function (returns void and accepts no arguments) that will be executed after an interrupt.
priority	Interrupt priority, highest is 0, lowest is 255.

Definition at line 181 of file ADC.h.

◆ readSingle()

int ADC::readSingle ( int8_t adc_num = -1 )

Reads the analog value of a single conversion.

Set the conversion with with startSingleRead(pin) or startSingleDifferential(pinP, pinN).

Parameters

adc_num ADC_X ADC module

Returns: the converted value.

Definition at line 526 of file ADC.cpp.

◆ readSynchronizedContinuous()

ADC::Sync_result ADC::readSynchronizedContinuous ( )

Returns the values of both ADCs.

Returns: the converted value.

Definition at line 1087 of file ADC.cpp.

◆ readSynchronizedSingle()

ADC::Sync_result ADC::readSynchronizedSingle ( )

Reads the analog value of a single conversion.

Returns: the converted value.

Definition at line 1012 of file ADC.cpp.

◆ resetError()

void ADC::resetError ( )

inline

ERRORS ///// Resets all errors from all ADCs, if any.

Definition at line 578 of file ADC.h.

◆ setAveraging()

void ADC::setAveraging ( uint8_t num )

inline

Set the number of averages for all ADCs.

Parameters

num	can be 0, 4, 8, 16 or 32.

Definition at line 165 of file ADC.h.

◆ setConversionSpeed()

void ADC::setConversionSpeed ( ADC_CONVERSION_SPEED speed )

inline

Sets the conversion speed for all ADCs.

Parameters

speed can be any from the ADC_CONVERSION_SPEED enum.

Definition at line 139 of file ADC.h.

◆ setReference()

void ADC::setReference ( ADC_REFERENCE type )

inline

Set the voltage reference for all ADCs, default is vcc.

Parameters

type	Any of ADC_REFERENCE

Definition at line 111 of file ADC.h.

◆ setResolution()

void ADC::setResolution ( uint8_t bits )

inline

Change the resolution for all ADCs.

Parameters

bits is the number of bits of resolution. For single-ended measurements: 8, 10, 12 or 16 bits. For differential measurements: 9, 11, 13 or 16 bits. If you want something in between (11 bits single-ended for example) select the immediate higher and shift the result one to the right. Whenever you change the resolution, change also the comparison values (if you use them).

Definition at line 127 of file ADC.h.

◆ setSamplingSpeed()

void ADC::setSamplingSpeed ( ADC_SAMPLING_SPEED speed )

inline

Sets the sampling speed for all ADCs.

Increase the sampling speed for low impedance sources, decrease it for higher impedance ones.

Parameters

speed can be any of the ADC_SAMPLING_SPEED.

Definition at line 154 of file ADC.h.

◆ startContinuous()

bool ADC::startContinuous	(	uint8_t	pin,
		int8_t	adc_num = `-1`
	)

Starts continuous conversion on the pin.

It returns as soon as the ADC is set, use analogReadContinuous() to read the value.

Parameters

pin	can be any of the analog pins
adc_num	ADC_X ADC module

Returns: true if the pin is valid, false otherwise.

Definition at line 542 of file ADC.cpp.

◆ startContinuousDifferential()

bool ADC::startContinuousDifferential	(	uint8_t	pinP,
		uint8_t	pinN,
		int8_t	adc_num = `-1`
	)

Starts continuous conversion between the pins (pinP-pinN).

It returns as soon as the ADC is set, use analogReadContinuous() to read the value.

Parameters

pinP	must be A10 or A12.
pinN	must be A11 (if pinP=A10) or A13 (if pinP=A12).
adc_num	ADC_X ADC module

Returns: true if the pins are valid, false otherwise.

Definition at line 601 of file ADC.cpp.

◆ startSingleDifferential()

bool ADC::startSingleDifferential	(	uint8_t	pinP,
		uint8_t	pinN,
		int8_t	adc_num = `-1`
	)

Start a differential conversion between two pins (pinP - pinN) and enables interrupts. It returns immediately, get value with readSingle(). If this function interrupts a measurement, it stores the settings in adc_config

Parameters

pinP	must be A10 or A12.
pinN	must be A11 (if pinP=A10) or A13 (if pinP=A12).
adc_num	ADC_X ADC module

Returns: true if the pins are valid, false otherwise.

Definition at line 469 of file ADC.cpp.

◆ startSingleRead()

bool ADC::startSingleRead	(	uint8_t	pin,
		int8_t	adc_num = `-1`
	)

Starts an analog measurement on the pin and enables interrupts.

It returns immediately, get value with readSingle(). If this function interrupts a measurement, it stores the settings in adc_config

Parameters

pin	can be any of the analog pins
adc_num	ADC_X ADC module

Returns: true if the pin is valid, false otherwise.

Definition at line 407 of file ADC.cpp.

◆ startSynchronizedContinuous()

bool ADC::startSynchronizedContinuous	(	uint8_t	pin0,
		uint8_t	pin1
	)

Starts a continuous conversion in both ADCs simultaneously.

Use readSynchronizedContinuous to get the values

Parameters

pin0	pin in ADC0
pin1	pin in ADC1

Returns: true if the pins are valid, false otherwise.

Use readSynchronizedContinuous to get the values

Definition at line 1028 of file ADC.cpp.

◆ startSynchronizedContinuousDifferential()

bool ADC::startSynchronizedContinuousDifferential	(	uint8_t	pin0P,
		uint8_t	pin0N,
		uint8_t	pin1P,
		uint8_t	pin1N
	)

Starts a continuous differential conversion in both ADCs simultaneously.

Use readSynchronizedContinuous to get the values

Parameters

pin0P	positive pin in ADC0
pin0N	negative pin in ADC0
pin1P	positive pin in ADC1
pin1N	negative pin in ADC1

Returns: true if the pins are valid, false otherwise.

Use readSynchronizedContinuous to get the values

Definition at line 1059 of file ADC.cpp.

◆ startSynchronizedSingleDifferential()

bool ADC::startSynchronizedSingleDifferential	(	uint8_t	pin0P,
		uint8_t	pin0N,
		uint8_t	pin1P,
		uint8_t	pin1N
	)

Start a differential conversion between two pins (pin0P - pin0N) and (pin1P - pin1N) It returns immediately, get value with readSynchronizedSingle(). If this function interrupts a measurement, it stores the settings in adc_config

Parameters

pin0P	positive pin in ADC0
pin0N	negative pin in ADC0
pin1P	positive pin in ADC1
pin1N	negative pin in ADC1

Returns: true if the pins are valid, false otherwise.

Definition at line 959 of file ADC.cpp.

◆ startSynchronizedSingleRead()

bool ADC::startSynchronizedSingleRead	(	uint8_t	pin0,
		uint8_t	pin1
	)

Starts an analog measurement at the same time on the two ADC modules.

It returns immediately, get value with readSynchronizedSingle(). If this function interrupts a measurement, it stores the settings in adc_config

Parameters

pin0	pin in ADC0
pin1	pin in ADC1

Returns: true if the pins are valid, false otherwise.

Definition at line 905 of file ADC.cpp.

◆ stopContinuous()

void ADC::stopContinuous ( int8_t adc_num = -1 )

Stops continuous conversion.

Parameters

adc_num ADC_X ADC module

Definition at line 674 of file ADC.cpp.

Member Data Documentation

◆ channel2sc1aADC0

const uint8_t ADC::channel2sc1aADC0

static

Initial value:

= {
    
    5, 14, 8, 9, 13, 12, 6, 7, 15, 4, 3, 31, 31, 31,                     
    5, 14, 8, 9, 13, 12, 6, 7, 15, 4,                                    
    26, 27, 29, 30, 31, 31, 31,                                          
    31, 31, 17, 18,                                                      
    31, 31, 31, 31, 31, 31, 31, 31, 31,                                  
    31, 31, 31, 31, 31, 31, 31, 31, 31,                                  
    31, 31, 31, 31, 31, 31, 31, 31, 31,                                  
    31, 31, 3 + ADC_SC1A_PIN_DIFF, 31 + ADC_SC1A_PIN_DIFF, 23, 31, 1, 31 
}

Translate pin number to SC1A nomenclature.

Definition at line 586 of file ADC.h.

◆ channel2sc1aADC1

const uint8_t ADC::channel2sc1aADC1

static

Initial value:

= {
    
    31, 31, 8, 9, 31, 31, 31, 31, 31, 31, 31, 19, 14, 15,                
    31, 31, 8, 9, 31, 31, 31, 31, 31, 31,                                
    26, 27, 29, 30, 18, 31, 31,                                          
    14, 15, 31, 31, 4, 5, 6, 7, 17,                                      
    31, 31, 31, 31,                                                      
    31, 31, 31, 31, 31, 10, 11, 31, 31,                                  
    31, 31, 31, 31, 31, 31, 31, 31, 31,                                  
    31, 31, 0 + ADC_SC1A_PIN_DIFF, 19 + ADC_SC1A_PIN_DIFF, 31, 23, 31, 1 
}

Translate pin number to SC1A nomenclature.

Definition at line 589 of file ADC.h.

◆ diff_table_ADC0

const ADC_Module::ADC_NLIST ADC::diff_table_ADC0

static

Initial value:

= {

{A10, 3}}

Translate differential pin number to SC1A nomenclature.

Definition at line 601 of file ADC.h.

◆ diff_table_ADC1

const ADC_Module::ADC_NLIST ADC::diff_table_ADC1

static

Initial value:

= {

{A10, 0}}

Translate differential pin number to SC1A nomenclature.

Definition at line 604 of file ADC.h.

◆ sc1a2channelADC0

const uint8_t ADC::sc1a2channelADC0

static

Initial value:

= {
    
    0, 68, 0, 64, 23, 14, 20, 21, 16, 17, 0, 0, 19, 18, 
    15, 22, 0, 33, 34, 0, 0, 0,                         
    0, 66, 0, 0, 70, 0, 0, 0,                           
    0                                                   
}

Translate pin number to SC1A nomenclature for differential pins.

Definition at line 593 of file ADC.h.

◆ sc1a2channelADC1

const uint8_t ADC::sc1a2channelADC1

static

Initial value:

= {            
    0, 69, 0, 0, 35, 36, 37, 38, 0, 0, 49, 50, 0, 0, 
    31, 32, 0, 39, 71, 65, 0, 0,                     
    0, 67, 0, 0, 0, 0, 0, 0,                         
    0}

Translate pin number to SC1A nomenclature for differential pins.

Definition at line 596 of file ADC.h.

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

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ADC()

Member Function Documentation

◆ analogRead() [1/2]

◆ analogRead() [2/2]

◆ analogReadContinuous()

◆ analogReadDifferential()

◆ analogSynchronizedRead()

◆ analogSynchronizedReadDifferential()

◆ analogSyncRead()

◆ analogSyncReadDifferential()

◆ disableCompare()

◆ enableCompare()

◆ enableCompareRange()

◆ enableDMA()

◆ enableInterrupts()

◆ readSingle()

◆ readSynchronizedContinuous()

◆ readSynchronizedSingle()

◆ resetError()

◆ setAveraging()

◆ setConversionSpeed()

◆ setReference()

◆ setResolution()

◆ setSamplingSpeed()

◆ startContinuous()

◆ startContinuousDifferential()

◆ startSingleDifferential()

◆ startSingleRead()

◆ startSynchronizedContinuous()

◆ startSynchronizedContinuousDifferential()

◆ startSynchronizedSingleDifferential()

◆ startSynchronizedSingleRead()

◆ stopContinuous()

Member Data Documentation

◆ channel2sc1aADC0

◆ channel2sc1aADC1

◆ diff_table_ADC0

◆ diff_table_ADC1

◆ sc1a2channelADC0

◆ sc1a2channelADC1