Myriota UltraLite SDK 2.4.0
Loading...
Searching...
No Matches

Analog-to-Digital Converter (ADC) interface for reading analog signals. More...

Enumerations

enum  ADCReference { ADC_REF_VIO = 0 , ADC_REF_2V5 , ADC_REF_1V25 }
 Reference voltages. More...
 

Functions

MYRIOTA_HARDWARE_API int ADCGetVoltage (uint8_t PinNum, ADCReference Reference, uint32_t *mV)
 Get the converted voltage (mV) from the MCU ADC port.
 
MYRIOTA_HARDWARE_API int ADCGetValue (uint8_t PinNum, ADCReference Reference, uint16_t *Value)
 Get raw value from the ADC port (0 - 0xFFF).
 

Detailed Description

Analog-to-Digital Converter (ADC) interface for reading analog signals.

Enumeration Type Documentation

◆ ADCReference

Reference voltages.

Enumerator
ADC_REF_VIO 

Use VIO_REF as reference voltage.

ADC_REF_2V5 

Use 2.5V as reference voltage.

ADC_REF_1V25 

Use 1.25V as reference voltage.

Function Documentation

◆ ADCGetVoltage()

MYRIOTA_HARDWARE_API int ADCGetVoltage ( uint8_t  PinNum,
ADCReference  Reference,
uint32_t *  mV 
)

Get the converted voltage (mV) from the MCU ADC port.

Parameters
PinNumThe ADC pin number. Can be PIN_ADC0 or PIN_ADC1.
ReferenceThe reference voltage.
mV[out]Pointer to store the converted voltage in millivolts.
Returns
0 if read succeeds, -1 if read fails.

◆ ADCGetValue()

MYRIOTA_HARDWARE_API int ADCGetValue ( uint8_t  PinNum,
ADCReference  Reference,
uint16_t *  Value 
)

Get raw value from the ADC port (0 - 0xFFF).

Parameters
PinNumThe ADC pin number. Can be PIN_ADC0 or PIN_ADC1.
ReferenceThe reference voltage.
Value[out]Pointer to store the raw ADC value.
Returns
0 if read succeeds, -1 if read fails.