 |
AIROC™ BTSDK v4.9 - Documentation | |||
|
AIROC™ BTSDK v4.9 - Documentation | |||
Typedefs | |
| typedef enum ADC_INPUT_CHANNEL_SEL | ADC_INPUT_CHANNEL_SEL |
| Defines a driver to facilitate interfacing with the Analog-to-Digital Converter (ADC) driver. More... | |
| typedef enum ADC_POWER_TYPE | ADC_POWER_TYPE |
| ADC power type. | |
| typedef enum ADC_INPUT_RANGE_SEL | ADC_INPUT_RANGE_SEL |
| input voltage range selection | |
Enumerations | |
| enum | ADC_INPUT_CHANNEL_SEL { ADC_INPUT_P18 = 0x0, ADC_INPUT_P17 = 0x1, ADC_INPUT_P16 = 0x2, ADC_INPUT_P15 = 0x3, ADC_INPUT_P14 = 0x4, ADC_INPUT_P13 = 0x5, ADC_INPUT_P12 = 0x6, ADC_INPUT_P11 = 0x7, ADC_INPUT_P10 = 0x8, ADC_INPUT_P9 = 0x9, ADC_INPUT_P8 = 0xA, ADC_INPUT_P1 = 0xB, ADC_INPUT_P0 = 0xC, ADC_INPUT_VDD_CORE = 0xD, ADC_INPUT_ADC_BGREF = 0xE, ADC_INPUT_ADC_REFGND = 0xF, ADC_INPUT_P19 = 0x1F, ADC_INPUT_CHANNEL_MASK = 0x1f } |
| Defines a driver to facilitate interfacing with the Analog-to-Digital Converter (ADC) driver. More... | |
| enum | ADC_POWER_TYPE { ADC_POWER_DOWN = 1, ADC_POWER_UP = 0 } |
| ADC power type. | |
| enum | ADC_INPUT_RANGE_SEL { ADC_RANGE_0_3P6V = 0, ADC_RANGE_0_1P8V = 1 } |
| input voltage range selection | |
Functions | |
| void | wiced_hal_adc_init (void) |
| Initialize the ADC hardware to its default state. More... | |
| ADC_POWER_TYPE | wiced_hal_adc_set_power (ADC_POWER_TYPE pwr) |
| Power up or power down the ADC hardware. More... | |
| void | wiced_hal_adc_set_input_range (ADC_INPUT_RANGE_SEL rangeIdx) |
| Calibrate and set the input voltage range expected for the ADC hardware. More... | |
| int16_t | wiced_hal_adc_read_raw_sample (ADC_INPUT_CHANNEL_SEL channel) |
| Read the raw ADC register value for the given channel. More... | |
| uint32_t | wiced_hal_adc_read_voltage (ADC_INPUT_CHANNEL_SEL channel) |
| Read the ADC voltage value for the given channel. More... | |
| typedef enum ADC_INPUT_CHANNEL_SEL ADC_INPUT_CHANNEL_SEL |
Defines a driver to facilitate interfacing with the Analog-to-Digital Converter (ADC) driver.
Use this driver to measure a DC voltage via a GPIO pin. Voltage measurement values are reported in millivolts (mV).
Note that the ADC channels do not correspond directly to the GPIO pin numbering convention (e.g. ADC channel 0 is tied to GPIO P18, etc). Please reference the User Documentation for more information regarding your specific platform.supported ADC input channel selection
Defines a driver to facilitate interfacing with the Analog-to-Digital Converter (ADC) driver.
Use this driver to measure a DC voltage via a GPIO pin. Voltage measurement values are reported in millivolts (mV).
Note that the ADC channels do not correspond directly to the GPIO pin numbering convention (e.g. ADC channel 0 is tied to GPIO P18, etc). Please reference the User Documentation for more information regarding your specific platform.supported ADC input channel selection
| void wiced_hal_adc_init | ( | void | ) |
Initialize the ADC hardware to its default state.
| none |
| int16_t wiced_hal_adc_read_raw_sample | ( | ADC_INPUT_CHANNEL_SEL | channel | ) |
Read the raw ADC register value for the given channel.
The value returned here is direct from the register.
| channel | - The input channel that corresponds to a GPIO pin. |
| uint32_t wiced_hal_adc_read_voltage | ( | ADC_INPUT_CHANNEL_SEL | channel | ) |
Read the ADC voltage value for the given channel.
The value returned here is converted to a voltage value from the register.
| channel | - The input channel that corresponds to a GPIO pin. |
| void wiced_hal_adc_set_input_range | ( | ADC_INPUT_RANGE_SEL | rangeIdx | ) |
Calibrate and set the input voltage range expected for the ADC hardware.
| range_idx | - 0 to 3.6v(0) or 0 to 1.8v(1). |
| ADC_POWER_TYPE wiced_hal_adc_set_power | ( | ADC_POWER_TYPE | pwr | ) |
Power up or power down the ADC hardware.
| pwr | - ADC_POWER_UP(0) or ADC_POWER_DOWN(1). |
