3.2.2 ADC with Computation

This file contains the API prototypes and data types for the ADC0 driver.

This header file provides type definitions for the ADC module.

• void ADC0_Initialize (void)

  Initializes the registers based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI for the Analog-to-Digital Converter (ADC) operation.

• void ADC0_Deinitialize (void)

  Deinitializes the registers to Power-on Reset values.

• void ADC0_Enable (void)

  Sets the ADC Enable bit to 1.

• void ADC0_Disable (void)

  Sets the ADC Enable bit to 0.

• void ADC0_DifferentialChannelSelect (adc_posChannel_t posChannel, adc_negChannel_t negChannel)

  Sets the positive and negative channels to use for the ADC conversion.

• void ADC0_ConversionStart (void)

  Starts the ADC conversion on the selected channels.

• void ADC0_ConversionDoneInterruptEnable (void)

  Sets the Result Ready Interrupt Enable (RESRDY) bit to 1.

• void ADC0_ConversionDoneInterruptDisable (void)

  Sets the Result Ready Interrupt Enable (RESRDY) bit to 0.

• bool ADC0_IsConversionDone (void)

  Checks if the ongoing ADC conversion is complete.

• adc_result_t ADC0_ConversionResultGet (void)

  Retrieves the result of the latest conversion.

• void ADC0_ConversionDoneCallbackRegister (void(*callback)(void))

  Sets the callback function for the Result Ready Interrupt (RESRDY).

• adc_result_t ADC0_DifferentialChannelSelectAndConvert (adc_posChannel_t posChannel, adc_negChannel_t negChannel)

  Starts the conversion and retrieves the result of one conversion on the selected channels.

• uint8_t ADC0_ResolutionGet (void)

  Returns the resolution of the ADC module.

• void ADC0_ConversionStop (void)

  Stops the ongoing ADC conversion.

• void ADC0_SampleRepeatCountSet (adc_repeat_count_t repeatCount)

  Loads the Sample Length with the specified value.

• void ADC0_ComputationModeSet (adc_computation_mode_t computationMode)

  Sets the Computation mode.

• void ADC0_UpperThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator High Threshold (WINHT) register.

• void ADC0_LowerThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator Low Threshold (WINLT) register.

• void ADC0_ThresholdModeSet (adc_threshold_mode_t thresholdMode)

  Sets the Window Comparator mode.

• void ADC0_ThresholdInterruptEnable (void)

  Sets the Window Comparator Interrupt Enable (WCMP) bit to 1.

• void ADC0_ThresholdInterruptDisable (void)

  Sets the Window Comparator Interrupt Enable (WCMP) bit to 0.

• adc_accumulate_t ADC0_AccumulatedResultGet (void)

  Retrieves the value of the accumulated conversions.

• void ADC0_ThresholdCallbackRegister (void(*callback)(void))

  Sets the callback function for the Window Comparator Interrupt (WCMP).

• void ADC0_ContinuousConversionEnable (void)

  Sets the Free-Running (FREERUN) bit to 1.

• void ADC0_ContinuousConversionDisable (void)

  Sets the Free-Running (FREERUN) bit to 0.

• void ADC0_AutoTriggerEnable (void)

  Sets the Start Event Input (STARTEI) bit to 1.

• void ADC0_AutoTriggerDisable (void)

  Sets the Start Event Input (STARTEI) bit to 0.

• bool ADC0_IsConversionDoneInterruptFlagSet (void)

  Checks the Result Ready Interrupt (RESRDY) flag status.

• void ADC0_ConversionDoneInterruptFlagClear (void)

  Clears the Result Ready Interrupt (RESRDY) flag.

• bool ADC0_IsThresholdInterruptFlagSet (void)

  Checks the Window Comparator Interrupt (WCMP) flag status.

• void ADC0_ThresholdInterruptFlagClear (void)

  Clears the Window Comparator Interrupt (WCMP) flag.

ADC0 Generated Driver API Header File

• void ADC0_Initialize (void)

  Initializes the registers based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI for the Analog-to-Digital Converter (ADC) operation.

• void ADC0_Deinitialize (void)

  Deinitializes the registers to Power-on Reset values.

• void ADC0_Enable (void)

  Sets the ADC Enable bit to 1.

• void ADC0_Disable (void)

  Sets the ADC Enable bit to 0.

• void ADC0_DifferentialChannelSelect (adc_posChannel_t posChannel, adc_negChannel_t negChannel)

  Sets the positive and negative channels to use for the ADC conversion.

• void ADC0_ConversionStart (void)

  Starts the ADC conversion on the selected channels.

• bool ADC0_IsConversionDone (void)

  Checks if the ongoing ADC conversion is complete.

• adc_result_t ADC0_ConversionResultGet (void)

  Retrieves the result of the latest conversion.

• void ADC0_ConversionDoneCallbackRegister (void(*callback)(void))

  Sets the callback function for the Result Ready Interrupt (RESRDY).

• adc_result_t ADC0_DifferentialChannelSelectAndConvert (adc_posChannel_t posChannel, adc_negChannel_t negChannel)

  Starts the conversion and retrieves the result of one conversion on the selected channels.

• uint8_t ADC0_ResolutionGet (void)

  Returns the resolution of the ADC module.

• void ADC0_ConversionStop (void)

  Stops the ongoing ADC conversion.

• void ADC0_SampleRepeatCountSet (adc_repeat_count_t repeatCount)

  Loads the Sample Length with the specified value.

• void ADC0_ComputationModeSet (adc_computation_mode_t computationMode)

  Sets the Computation mode.

• void ADC0_UpperThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator High Threshold (WINHT) register.

• void ADC0_LowerThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator Low Threshold (WINLT) register.

• void ADC0_ThresholdModeSet (adc_threshold_mode_t thresholdMode)

  Sets the Window Comparator mode.

• adc_accumulate_t ADC0_AccumulatedResultGet (void)

  Retrieves the value of the accumulated conversions.

• void ADC0_ThresholdCallbackRegister (void(*callback)(void))

  Sets the callback function for the Window Comparator Interrupt (WCMP).

• void ADC0_ContinuousConversionEnable (void)

  Sets the Free-Running (FREERUN) bit to 1.

• void ADC0_ContinuousConversionDisable (void)

  Sets the Free-Running (FREERUN) bit to 0.

• void ADC0_AutoTriggerEnable (void)

  Sets the Start Event Input (STARTEI) bit to 1.

• void ADC0_AutoTriggerDisable (void)

  Sets the Start Event Input (STARTEI) bit to 0.

• bool ADC0_IsConversionDoneInterruptFlagSet (void)

  Checks the Result Ready Interrupt (RESRDY) flag status.

• void ADC0_ConversionDoneInterruptFlagClear (void)

  Clears the Result Ready Interrupt (RESRDY) flag.

• bool ADC0_IsThresholdInterruptFlagSet (void)

  Checks the Window Comparator Interrupt (WCMP) flag status.

• void ADC0_ThresholdInterruptFlagClear (void)

  Clears the Window Comparator Interrupt (WCMP) flag.

• void ADC0_Tasks (void)

  Implements the Tasks routine for the polling implementation.

ADC0 Generated Driver API Header File

• void ADC0_Initialize (void)

  Initializes the registers based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI for the Analog-to-Digital Converter (ADC) operation.

• void ADC0_Deinitialize (void)

  Deinitializes the registers to Power-on Reset values.

• void ADC0_Enable (void)

  Sets the ADC Enable bit to 1.

• void ADC0_Disable (void)

  Sets the ADC Enable bit to 0.

• void ADC0_ChannelSelect (adc_channel_t channel)

  Sets the channel to use for the ADC conversion.

• void ADC0_ConversionStart (void)

  Starts the ADC conversion on the selected channels.

• void ADC0_ConversionDoneInterruptEnable (void)

  Sets the Result Ready Interrupt Enable (RESRDY) bit to 1.

• void ADC0_ConversionDoneInterruptDisable (void)

  Sets the Result Ready Interrupt Enable (RESRDY) bit to 0.

• bool ADC0_IsConversionDone (void)

  Checks if the ongoing ADC conversion is complete.

• adc_result_t ADC0_ConversionResultGet (void)

  Retrieves the result of the latest conversion.

• void ADC0_ConversionDoneCallbackRegister (void(*callback)(void))

  Sets the callback function for the Result Ready Interrupt (RESRDY).

• adc_result_t ADC0_ChannelSelectAndConvert (adc_channel_t channel)

  Starts the conversion and retrieves the result of one conversion on the selected channel.

• uint8_t ADC0_ResolutionGet (void)

  Returns the resolution of the ADC module.

• void ADC0_ConversionStop (void)

  Stops the ongoing ADC conversion.

• void ADC0_SampleRepeatCountSet (adc_repeat_count_t repeatCount)

  Loads the Sample Length with the specified value.

• void ADC0_ComputationModeSet (adc_computation_mode_t computationMode)

  Sets the Computation mode.

• void ADC0_UpperThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator High Threshold (WINHT) register.

• void ADC0_LowerThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator Low Threshold (WINLT) register.

• void ADC0_ThresholdModeSet (adc_threshold_mode_t thresholdMode)

  Sets the Window Comparator mode.

• void ADC0_ThresholdInterruptEnable (void)

  Sets the Window Comparator Interrupt Enable (WCMP) bit to 1.

• void ADC0_ThresholdInterruptDisable (void)

  Sets the Window Comparator Interrupt Enable (WCMP) bit to 0.

• adc_accumulate_t ADC0_AccumulatedResultGet (void)

  Retrieves the value of the accumulated conversions.

• void ADC0_ThresholdCallbackRegister (void(*callback)(void))

  Sets the callback function for the Window Comparator Interrupt (WCMP).

• void ADC0_ContinuousConversionEnable (void)

  Sets the Free-Running (FREERUN) bit to 1.

• void ADC0_ContinuousConversionDisable (void)

  Sets the Free-Running (FREERUN) bit to 0.

• void ADC0_AutoTriggerEnable (void)

  Sets the Start Event Input (STARTEI) bit to 1.

• void ADC0_AutoTriggerDisable (void)

  Sets the Start Event Input (STARTEI) bit to 0.

• bool ADC0_IsConversionDoneInterruptFlagSet (void)

  Checks the Result Ready Interrupt (RESRDY) flag status.

• void ADC0_ConversionDoneInterruptFlagClear (void)

  Clears the Result Ready Interrupt (RESRDY) flag.

• bool ADC0_IsThresholdInterruptFlagSet (void)

  Checks the Window Comparator Interrupt (WCMP) flag status.

• void ADC0_ThresholdInterruptFlagClear (void)

  Clears the Window Comparator Interrupt (WCMP) flag.

ADC0 Generated Driver API Header File

• void ADC0_Initialize (void)

  Initializes the registers based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI for the Analog-to-Digital Converter (ADC) operation.

• void ADC0_Deinitialize (void)

  Deinitializes the registers to Power-on Reset values.

• void ADC0_Enable (void)

  Sets the ADC Enable bit to 1.

• void ADC0_Disable (void)

  Sets the ADC Enable bit to 0.

• void ADC0_ChannelSelect (adc_channel_t channel)

  Sets the channel to use for the ADC conversion.

• void ADC0_ConversionStart (void)

  Starts the ADC conversion on the selected channels.

• bool ADC0_IsConversionDone (void)

  Checks if the ongoing ADC conversion is complete.

• adc_result_t ADC0_ConversionResultGet (void)

  Retrieves the result of the latest conversion.

• void ADC0_ConversionDoneCallbackRegister (void(*callback)(void))

  Sets the callback function for the Result Ready Interrupt (RESRDY).

• adc_result_t ADC0_ChannelSelectAndConvert (adc_channel_t channel)

  Starts the conversion and retrieves the result of one conversion on the selected channel.

• uint8_t ADC0_ResolutionGet (void)

  Returns the resolution of the ADC module.

• void ADC0_ConversionStop (void)

  Stops the ongoing ADC conversion.

• void ADC0_SampleRepeatCountSet (adc_repeat_count_t repeatCount)

  Loads the Sample Length with the specified value.

• void ADC0_ComputationModeSet (adc_computation_mode_t computationMode)

  Sets the Computation mode.

• void ADC0_UpperThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator High Threshold (WINHT) register.

• void ADC0_LowerThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator Low Threshold (WINLT) register.

• void ADC0_ThresholdModeSet (adc_threshold_mode_t thresholdMode)

  Sets the Window Comparator mode.

• adc_accumulate_t ADC0_AccumulatedResultGet (void)

  Retrieves the value of the accumulated conversions.

• void ADC0_ThresholdCallbackRegister (void(*callback)(void))

  Sets the callback function for the Window Comparator Interrupt (WCMP).

• void ADC0_ContinuousConversionEnable (void)

  Sets the Free-Running (FREERUN) bit to 1.

• void ADC0_ContinuousConversionDisable (void)

  Sets the Free-Running (FREERUN) bit to 0.

• void ADC0_AutoTriggerEnable (void)

  Sets the Start Event Input (STARTEI) bit to 1.

• void ADC0_AutoTriggerDisable (void)

  Sets the Start Event Input (STARTEI) bit to 0.

• bool ADC0_IsConversionDoneInterruptFlagSet (void)

  Checks the Result Ready Interrupt (RESRDY) flag status.

• void ADC0_ConversionDoneInterruptFlagClear (void)

  Clears the Result Ready Interrupt (RESRDY) flag.

• bool ADC0_IsThresholdInterruptFlagSet (void)

  Checks the Window Comparator Interrupt (WCMP) flag status.

• void ADC0_ThresholdInterruptFlagClear (void)

  Clears the Window Comparator Interrupt (WCMP) flag.

• void ADC0_Tasks (void)

  Implements the Tasks routine for the polling implementation.

ADC0 Generated Driver API Header File

• typedef int16_t adc_result_t

  ADC conversion result type.

• typedef int32_t adc_accumulate_t

  ADC conversion accumulator type.

• typedef int16_t adc_threshold_t

  ADC conversion threshold type.

• enum adc_posChannel_t { ADC0_POSCHANNEL_AIN0 = 0x0, ADC0_POSCHANNEL_AIN1 = 0x1, ADC0_POSCHANNEL_AIN2 = 0x2, ADC0_POSCHANNEL_AIN3 = 0x3, ADC0_POSCHANNEL_AIN4 = 0x4, ADC0_POSCHANNEL_AIN5 = 0x5, ADC0_POSCHANNEL_AIN6 = 0x6, ADC0_POSCHANNEL_AIN7 = 0x7, ADC0_POSCHANNEL_AIN8 = 0x8, ADC0_POSCHANNEL_AIN9 = 0x9, ADC0_POSCHANNEL_AIN10 = 0xa, ADC0_POSCHANNEL_AIN11 = 0xb, ADC0_POSCHANNEL_AIN16 = 0x10, ADC0_POSCHANNEL_AIN17 = 0x11, ADC0_POSCHANNEL_AIN18 = 0x12, ADC0_POSCHANNEL_AIN19 = 0x13, ADC0_POSCHANNEL_AIN20 = 0x14, ADC0_POSCHANNEL_AIN21 = 0x15, ADC0_POSCHANNEL_GND = 0x40, ADC0_POSCHANNEL_TEMPSENSE = 0x42, ADC0_POSCHANNEL_VDDDIV10 = 0x44, ADC0_POSCHANNEL_VDDIO2DIV10 = 0x45, ADC0_POSCHANNEL_DAC0 = 0x48, ADC0_POSCHANNEL_DACREF0 = 0x49, ADC0_POSCHANNEL_DACREF1 = 0x4a, ADC0_POSCHANNEL_DACREF2 = 0x4b }

  Enumeration defining all available positive analog channels for ADC conversion.

• enum adc_negChannel_t { ADC0_NEGCHANNEL_AIN0 = 0x0, ADC0_NEGCHANNEL_AIN1 = 0x1, ADC0_NEGCHANNEL_AIN2 = 0x2, ADC0_NEGCHANNEL_AIN3 = 0x3, ADC0_NEGCHANNEL_AIN4 = 0x4, ADC0_NEGCHANNEL_AIN5 = 0x5, ADC0_NEGCHANNEL_AIN6 = 0x6, ADC0_NEGCHANNEL_AIN7 = 0x7, ADC0_NEGCHANNEL_AIN8 = 0x8, ADC0_NEGCHANNEL_AIN9 = 0x9, ADC0_NEGCHANNEL_AIN10 = 0xa, ADC0_NEGCHANNEL_AIN11 = 0xb, ADC0_NEGCHANNEL_GND = 0x40, ADC0_NEGCHANNEL_DAC0 = 0x48 }

• Enumeration defining all available negative analog channels for ADC conversion.

• enum adc_computation_mode_t { ADC_BASIC = 0x00, ADC_SERIES_ACCUMULATE = 0x01 }

  Enumeration for the ADC computation modes.

• enum adc_repeat_count_t { ADC_NO_ACCUMULATION = 0x0, ADC_2_SAMPLES_ACCUMULATED = 0x1, ADC_4_SAMPLES_ACCUMULATED = 0x2, ADC_8_SAMPLES_ACCUMULATED = 0x3, ADC_16_SAMPLES_ACCUMULATED = 0x4, ADC_32_SAMPLES_ACCUMULATED = 0x5, ADC_64_SAMPLES_ACCUMULATED = 0x6, ADC_128_SAMPLES_ACCUMULATED = 0x7 }

  Enumeration for the ADC sample length values.

• enum adc_threshold_mode_t { ADC_NEVER_INTERRUPT = 0x0, ADC_BELOW_LOWER_THRESHOLD = 0x1, ADC_ABOVE_UPPER_THRESHOLD = 0x2, ADC_INSIDE_LOWER_AND_UPPER_THRESHOLD = 0x3, ADC_OUTSIDE_LOWER_AND_UPPER_THRESHOLD = 0x4 }

  Enumeration for the ADC window comparator modes.

ADC Type Definitions Header File

• typedef int16_t adc_result_t

• typedef int32_t adc_accumulate_t

• typedef int16_t adc_threshold_t

• enum adc_posChannel_t { ADC0_POSCHANNEL_AIN0 = 0x0, ADC0_POSCHANNEL_AIN1 = 0x1, ADC0_POSCHANNEL_AIN2 = 0x2, ADC0_POSCHANNEL_AIN3 = 0x3, ADC0_POSCHANNEL_AIN4 = 0x4, ADC0_POSCHANNEL_AIN5 = 0x5, ADC0_POSCHANNEL_AIN6 = 0x6, ADC0_POSCHANNEL_AIN7 = 0x7, ADC0_POSCHANNEL_AIN8 = 0x8, ADC0_POSCHANNEL_AIN9 = 0x9, ADC0_POSCHANNEL_AIN10 = 0xa, ADC0_POSCHANNEL_AIN11 = 0xb, ADC0_POSCHANNEL_AIN16 = 0x10, ADC0_POSCHANNEL_AIN17 = 0x11, ADC0_POSCHANNEL_AIN18 = 0x12, ADC0_POSCHANNEL_AIN19 = 0x13, ADC0_POSCHANNEL_AIN20 = 0x14, ADC0_POSCHANNEL_AIN21 = 0x15, ADC0_POSCHANNEL_GND = 0x40, ADC0_POSCHANNEL_TEMPSENSE = 0x42, ADC0_POSCHANNEL_VDDDIV10 = 0x44, ADC0_POSCHANNEL_VDDIO2DIV10 = 0x45, ADC0_POSCHANNEL_DAC0 = 0x48, ADC0_POSCHANNEL_DACREF0 = 0x49, ADC0_POSCHANNEL_DACREF1 = 0x4a, ADC0_POSCHANNEL_DACREF2 = 0x4b }

  Enumeration defining all available positive analog channels for ADC conversion.

• enum adc_negChannel_t { ADC0_NEGCHANNEL_AIN0 = 0x0, ADC0_NEGCHANNEL_AIN1 = 0x1, ADC0_NEGCHANNEL_AIN2 = 0x2, ADC0_NEGCHANNEL_AIN3 = 0x3, ADC0_NEGCHANNEL_AIN4 = 0x4, ADC0_NEGCHANNEL_AIN5 = 0x5, ADC0_NEGCHANNEL_AIN6 = 0x6, ADC0_NEGCHANNEL_AIN7 = 0x7, ADC0_NEGCHANNEL_AIN8 = 0x8, ADC0_NEGCHANNEL_AIN9 = 0x9, ADC0_NEGCHANNEL_AIN10 = 0xa, ADC0_NEGCHANNEL_AIN11 = 0xb, ADC0_NEGCHANNEL_GND = 0x40, ADC0_NEGCHANNEL_DAC0 = 0x48 }

• enum adc_computation_mode_t { ADC_BASIC = 0x00, ADC_SERIES_ACCUMULATE = 0x01 }

• enum adc_repeat_count_t { ADC_NO_ACCUMULATION = 0x0, ADC_2_SAMPLES_ACCUMULATED = 0x1, ADC_4_SAMPLES_ACCUMULATED = 0x2, ADC_8_SAMPLES_ACCUMULATED = 0x3, ADC_16_SAMPLES_ACCUMULATED = 0x4, ADC_32_SAMPLES_ACCUMULATED = 0x5, ADC_64_SAMPLES_ACCUMULATED = 0x6, ADC_128_SAMPLES_ACCUMULATED = 0x7 }

• enum adc_threshold_mode_t { ADC_NEVER_INTERRUPT = 0x0, ADC_BELOW_LOWER_THRESHOLD = 0x1, ADC_ABOVE_UPPER_THRESHOLD = 0x2, ADC_INSIDE_LOWER_AND_UPPER_THRESHOLD = 0x3, ADC_OUTSIDE_LOWER_AND_UPPER_THRESHOLD = 0x4 }

ADC Type Definitions Header File

• typedef int16_t adc_result_t

• typedef int32_t adc_accumulate_t

• typedef int16_t adc_threshold_t

• enum adc_channel_t { ADC0_CHANNEL_AIN0 = 0x0, ADC0_CHANNEL_AIN1 = 0x1, ADC0_CHANNEL_AIN2 = 0x2, ADC0_CHANNEL_AIN3 = 0x3, ADC0_CHANNEL_AIN4 = 0x4, ADC0_CHANNEL_AIN5 = 0x5, ADC0_CHANNEL_AIN6 = 0x6, ADC0_CHANNEL_AIN7 = 0x7, ADC0_CHANNEL_AIN8 = 0x8, ADC0_CHANNEL_AIN9 = 0x9, ADC0_CHANNEL_AIN10 = 0xa, ADC0_CHANNEL_AIN11 = 0xb, ADC0_CHANNEL_AIN16 = 0x10, ADC0_CHANNEL_AIN17 = 0x11, ADC0_CHANNEL_AIN18 = 0x12, ADC0_CHANNEL_AIN19 = 0x13, ADC0_CHANNEL_AIN20 = 0x14, ADC0_CHANNEL_AIN21 = 0x15, ADC0_CHANNEL_GND = 0x40, ADC0_CHANNEL_TEMPSENSE = 0x42, ADC0_CHANNEL_VDDDIV10 = 0x44, ADC0_CHANNEL_VDDIO2DIV10 = 0x45, ADC0_CHANNEL_DAC0 = 0x48, ADC0_CHANNEL_DACREF0 = 0x49, ADC0_CHANNEL_DACREF1 = 0x4a, ADC0_CHANNEL_DACREF2 = 0x4b }

  Enumeration defining all available analog channels for ADC conversion.

• enum adc_computation_mode_t { ADC_BASIC = 0x00, ADC_SERIES_ACCUMULATE = 0x01 }

• enum adc_repeat_count_t { ADC_NO_ACCUMULATION = 0x0, ADC_2_SAMPLES_ACCUMULATED = 0x1, ADC_4_SAMPLES_ACCUMULATED = 0x2, ADC_8_SAMPLES_ACCUMULATED = 0x3, ADC_16_SAMPLES_ACCUMULATED = 0x4, ADC_32_SAMPLES_ACCUMULATED = 0x5, ADC_64_SAMPLES_ACCUMULATED = 0x6, ADC_128_SAMPLES_ACCUMULATED = 0x7 }

• enum adc_threshold_mode_t { ADC_NEVER_INTERRUPT = 0x0, ADC_BELOW_LOWER_THRESHOLD = 0x1, ADC_ABOVE_UPPER_THRESHOLD = 0x2, ADC_INSIDE_LOWER_AND_UPPER_THRESHOLD = 0x3, ADC_OUTSIDE_LOWER_AND_UPPER_THRESHOLD = 0x4 }

ADC Type Definitions Header File

• typedef int16_t adc_result_t

• typedef int32_t adc_accumulate_t

• typedef int16_t adc_threshold_t

• enum adc_channel_t { ADC0_CHANNEL_AIN0 = 0x0, ADC0_CHANNEL_AIN1 = 0x1, ADC0_CHANNEL_AIN2 = 0x2, ADC0_CHANNEL_AIN3 = 0x3, ADC0_CHANNEL_AIN4 = 0x4, ADC0_CHANNEL_AIN5 = 0x5, ADC0_CHANNEL_AIN6 = 0x6, ADC0_CHANNEL_AIN7 = 0x7, ADC0_CHANNEL_AIN8 = 0x8, ADC0_CHANNEL_AIN9 = 0x9, ADC0_CHANNEL_AIN10 = 0xa, ADC0_CHANNEL_AIN11 = 0xb, ADC0_CHANNEL_AIN16 = 0x10, ADC0_CHANNEL_AIN17 = 0x11, ADC0_CHANNEL_AIN18 = 0x12, ADC0_CHANNEL_AIN19 = 0x13, ADC0_CHANNEL_AIN20 = 0x14, ADC0_CHANNEL_AIN21 = 0x15, ADC0_CHANNEL_GND = 0x40, ADC0_CHANNEL_TEMPSENSE = 0x42, ADC0_CHANNEL_VDDDIV10 = 0x44, ADC0_CHANNEL_VDDIO2DIV10 = 0x45, ADC0_CHANNEL_DAC0 = 0x48, ADC0_CHANNEL_DACREF0 = 0x49, ADC0_CHANNEL_DACREF1 = 0x4a, ADC0_CHANNEL_DACREF2 = 0x4b }

• enum adc_computation_mode_t { ADC_BASIC = 0x00, ADC_SERIES_ACCUMULATE = 0x01 }

• enum adc_repeat_count_t { ADC_NO_ACCUMULATION = 0x0, ADC_2_SAMPLES_ACCUMULATED = 0x1, ADC_4_SAMPLES_ACCUMULATED = 0x2, ADC_8_SAMPLES_ACCUMULATED = 0x3, ADC_16_SAMPLES_ACCUMULATED = 0x4, ADC_32_SAMPLES_ACCUMULATED = 0x5, ADC_64_SAMPLES_ACCUMULATED = 0x6, ADC_128_SAMPLES_ACCUMULATED = 0x7 }

• enum adc_threshold_mode_t { ADC_NEVER_INTERRUPT = 0x0, ADC_BELOW_LOWER_THRESHOLD = 0x1, ADC_ABOVE_UPPER_THRESHOLD = 0x2, ADC_INSIDE_LOWER_AND_UPPER_THRESHOLD = 0x3, ADC_OUTSIDE_LOWER_AND_UPPER_THRESHOLD = 0x4 }

ADC Type Definitions Header File

• void ADC0_Initialize (void)

  Initializes the registers based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI for the Analog-to-Digital Converter (ADC) operation.

• void ADC0_Deinitialize (void)

  Deinitializes the registers to Power-on Reset values.

• void ADC0_Enable (void)

  Sets the ADC Enable bit to 1.

• void ADC0_Disable (void)

  Sets the ADC Enable bit to 0.

• void ADC0_DifferentialChannelSelect (adc_posChannel_t posChannel, adc_negChannel_t negChannel)

  Sets the positive and negative channels to use for the ADC conversion.

• void ADC0_ConversionStart (void)

  Starts the ADC conversion on the selected channels.

• void ADC0_ConversionDoneInterruptEnable (void)

  Sets the Result Ready Interrupt Enable (RESRDY) bit to 1.

• void ADC0_ConversionDoneInterruptDisable (void)

  Sets the Result Ready Interrupt Enable (RESRDY) bit to 0.

• bool ADC0_IsConversionDone (void)

  Checks if the ongoing ADC conversion is complete.

• adc_result_t ADC0_ConversionResultGet (void)

  Retrieves the result of the latest conversion.

• void ADC0_ConversionDoneCallbackRegister (void(*callback)(void))

  Sets the callback function for the Result Ready Interrupt (RESRDY).

• adc_result_t ADC0_DifferentialChannelSelectAndConvert (adc_posChannel_t posChannel, adc_negChannel_t negChannel)

  Starts the conversion and retrieves the result of one conversion on the selected channels.

• uint8_t ADC0_ResolutionGet (void)

  Returns the resolution of the ADC module.

• void ADC0_ConversionStop (void)

  Stops the ongoing ADC conversion.

• void ADC0_SampleRepeatCountSet (adc_repeat_count_t repeatCount)

  Loads the Sample Length with the specified value.

• void ADC0_ComputationModeSet (adc_computation_mode_t computationMode)

  Sets the Computation mode.

• void ADC0_UpperThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator High Threshold (WINHT) register.

• void ADC0_LowerThresholdSet (adc_threshold_t lowerThreshold)

  Sets the value of the Window Comparator Low Threshold (WINLT) register.

• void ADC0_ThresholdModeSet (adc_threshold_mode_t thresholdMode)

  Sets the Window Comparator mode.

• void ADC0_ThresholdInterruptEnable (void)

  Sets the Window Comparator Interrupt Enable (WCMP) bit to 1.

• void ADC0_ThresholdInterruptDisable (void)

  Sets the Window Comparator Interrupt Enable (WCMP) bit to 0.

• adc_accumulate_t ADC0_AccumulatedResultGet (void)

  Retrieves the value of the accumulated conversions.

• void ADC0_ThresholdCallbackRegister (void(*callback)(void))

  Sets the callback function for the Window Comparator Interrupt (WCMP).

• void ADC0_ContinuousConversionEnable (void)

  Sets the Free-Running (FREERUN) bit to 1.

• void ADC0_ContinuousConversionDisable (void)

  Sets the Free-Running (FREERUN) bit to 0.

• void ADC0_AutoTriggerEnable (void)

  Sets the Start Event Input (STARTEI) bit to 1.

• void ADC0_AutoTriggerDisable (void)

  Sets the Start Event Input (STARTEI) bit to 0.

• bool ADC0_IsConversionDoneInterruptFlagSet (void)

  Checks the Result Ready Interrupt (RESRDY) flag status.

• void ADC0_ConversionDoneInterruptFlagClear (void)

  Clears the Result Ready Interrupt (RESRDY) flag.

• bool ADC0_IsThresholdInterruptFlagSet (void)

  Checks the Window Comparator Interrupt (WCMP) flag status.

• void ADC0_ThresholdInterruptFlagClear (void)

  Clears the Window Comparator Interrupt (WCMP) flag.

• ISR (ADC0_RESRDY_vect)

• ISR (ADC0_WCMP_vect)

• static void(* ADC0_ConversionDoneCallback )(void)

• static void(* ADC0_ThresholdCallback )(void)

This file contains the API implementations for the ADC0 driver.

ADC0 Generated Driver File

• void ADC0_Initialize (void)

  Initializes the registers based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI for the Analog-to-Digital Converter (ADC) operation.

• void ADC0_Deinitialize (void)

  Deinitializes the registers to Power-on Reset values.

• void ADC0_Enable (void)

  Sets the ADC Enable bit to 1.

• void ADC0_Disable (void)

  Sets the ADC Enable bit to 0.

• void ADC0_DifferentialChannelSelect (adc_posChannel_t posChannel, adc_negChannel_t negChannel)

  Sets the positive and negative channels to use for the ADC conversion.

• void ADC0_ConversionStart (void)

  Starts the ADC conversion on the selected channels.

• bool ADC0_IsConversionDone (void)

  Checks if the ongoing ADC conversion is complete.

• adc_result_t ADC0_ConversionResultGet (void)

  Retrieves the result of the latest conversion.

• void ADC0_ConversionDoneCallbackRegister (void(*callback)(void))

  Sets the callback function for the Result Ready Interrupt (RESRDY).

• adc_result_t ADC0_DifferentialChannelSelectAndConvert (adc_posChannel_t posChannel, adc_negChannel_t negChannel)

  Starts the conversion and retrieves the result of one conversion on the selected channels.

• uint8_t ADC0_ResolutionGet (void)

  Returns the resolution of the ADC module.

• void ADC0_ConversionStop (void)

  Stops the ongoing ADC conversion.

• void ADC0_SampleRepeatCountSet (adc_repeat_count_t repeatCount)

  Loads the Sample Length with the specified value.

• void ADC0_ComputationModeSet (adc_computation_mode_t computationMode)

  Sets the Computation mode.

• void ADC0_UpperThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator High Threshold (WINHT) register.

• void ADC0_LowerThresholdSet (adc_threshold_t lowerThreshold)

  Sets the value of the Window Comparator Low Threshold (WINLT) register.

• void ADC0_ThresholdModeSet (adc_threshold_mode_t thresholdMode)

  Sets the Window Comparator mode.

• adc_accumulate_t ADC0_AccumulatedResultGet (void)

  Retrieves the value of the accumulated conversions.

• void ADC0_ThresholdCallbackRegister (void(*callback)(void))

  Sets the callback function for the Window Comparator Interrupt (WCMP).

• void ADC0_ContinuousConversionEnable (void)

  Sets the Free-Running (FREERUN) bit to 1.

• void ADC0_ContinuousConversionDisable (void)

  Sets the Free-Running (FREERUN) bit to 0.

• void ADC0_AutoTriggerEnable (void)

  Sets the Start Event Input (STARTEI) bit to 1.

• void ADC0_AutoTriggerDisable (void)

  Sets the Start Event Input (STARTEI) bit to 0.

• bool ADC0_IsConversionDoneInterruptFlagSet (void)

  Checks the Result Ready Interrupt (RESRDY) flag status.

• void ADC0_ConversionDoneInterruptFlagClear (void)

  Clears the Result Ready Interrupt (RESRDY) flag.

• bool ADC0_IsThresholdInterruptFlagSet (void)

  Checks the Window Comparator Interrupt (WCMP) flag status.

• void ADC0_ThresholdInterruptFlagClear (void)

  Clears the Window Comparator Interrupt (WCMP) flag.

• void ADC0_Tasks (void)

  Implements the Tasks routine for the polling implementation.

• static void(* ADC0_ConversionDoneCallback )(void)

• static void(* ADC0_ThresholdCallback )(void)

This file contains the API implementations for the ADC0 driver.

ADC0 Generated Driver File

• void ADC0_Initialize (void)

  Initializes the registers based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI for the Analog-to-Digital Converter (ADC) operation.

• void ADC0_Deinitialize (void)

  Deinitializes the registers to Power-on Reset values.

• void ADC0_Enable (void)

  Sets the ADC Enable bit to 1.

• void ADC0_Disable (void)

  Sets the ADC Enable bit to 0.

• void ADC0_ChannelSelect (adc_channel_t channel)

  Sets the channel to use for the ADC conversion.

• void ADC0_ConversionStart (void)

  Starts the ADC conversion on the selected channels.

• void ADC0_ConversionDoneInterruptEnable (void)

  Sets the Result Ready Interrupt Enable (RESRDY) bit to 1.

• void ADC0_ConversionDoneInterruptDisable (void)

  Sets the Result Ready Interrupt Enable (RESRDY) bit to 0.

• bool ADC0_IsConversionDone (void)

  Checks if the ongoing ADC conversion is complete.

• adc_result_t ADC0_ConversionResultGet (void)

  Retrieves the result of the latest conversion.

• void ADC0_ConversionDoneCallbackRegister (void(*callback)(void))

  Sets the callback function for the Result Ready Interrupt (RESRDY).

• adc_result_t ADC0_ChannelSelectAndConvert (adc_channel_t channel)

  Starts the conversion and retrieves the result of one conversion on the selected channel.

• uint8_t ADC0_ResolutionGet (void)

  Returns the resolution of the ADC module.

• void ADC0_ConversionStop (void)

  Stops the ongoing ADC conversion.

• void ADC0_SampleRepeatCountSet (adc_repeat_count_t repeatCount)

  Loads the Sample Length with the specified value.

• void ADC0_ComputationModeSet (adc_computation_mode_t computationMode)

  Sets the Computation mode.

• void ADC0_UpperThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator High Threshold (WINHT) register.

• void ADC0_LowerThresholdSet (adc_threshold_t lowerThreshold)

  Sets the value of the Window Comparator Low Threshold (WINLT) register.

• void ADC0_ThresholdModeSet (adc_threshold_mode_t thresholdMode)

  Sets the Window Comparator mode.

• void ADC0_ThresholdInterruptEnable (void)

  Sets the Window Comparator Interrupt Enable (WCMP) bit to 1.

• void ADC0_ThresholdInterruptDisable (void)

  Sets the Window Comparator Interrupt Enable (WCMP) bit to 0.

• adc_accumulate_t ADC0_AccumulatedResultGet (void)

  Retrieves the value of the accumulated conversions.

• void ADC0_ThresholdCallbackRegister (void(*callback)(void))

  Sets the callback function for the Window Comparator Interrupt (WCMP).

• void ADC0_ContinuousConversionEnable (void)

  Sets the Free-Running (FREERUN) bit to 1.

• void ADC0_ContinuousConversionDisable (void)

  Sets the Free-Running (FREERUN) bit to 0.

• void ADC0_AutoTriggerEnable (void)

  Sets the Start Event Input (STARTEI) bit to 1.

• void ADC0_AutoTriggerDisable (void)

  Sets the Start Event Input (STARTEI) bit to 0.

• bool ADC0_IsConversionDoneInterruptFlagSet (void)

  Checks the Result Ready Interrupt (RESRDY) flag status.

• void ADC0_ConversionDoneInterruptFlagClear (void)

  Clears the Result Ready Interrupt (RESRDY) flag.

• bool ADC0_IsThresholdInterruptFlagSet (void)

  Checks the Window Comparator Interrupt (WCMP) flag status.

• void ADC0_ThresholdInterruptFlagClear (void)

  Clears the Window Comparator Interrupt (WCMP) flag.

• ISR (ADC0_RESRDY_vect)

• ISR (ADC0_WCMP_vect)

• static void(* ADC0_ConversionDoneCallback )(void)

• static void(* ADC0_ThresholdCallback )(void)

This file contains the API implementations for the ADC0 driver.

ADC0 Generated Driver File

• void ADC0_Initialize (void)

  Initializes the registers based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI for the Analog-to-Digital Converter (ADC) operation.

• void ADC0_Deinitialize (void)

  Deinitializes the registers to Power-on Reset values.

• void ADC0_Enable (void)

  Sets the ADC Enable bit to 1.

• void ADC0_Disable (void)

  Sets the ADC Enable bit to 0.

• void ADC0_ChannelSelect (adc_channel_t channel)

  Sets the channel to use for the ADC conversion.

• void ADC0_ConversionStart (void)

  Starts the ADC conversion on the selected channels.

• bool ADC0_IsConversionDone (void)

  Checks if the ongoing ADC conversion is complete.

• adc_result_t ADC0_ConversionResultGet (void)

  Retrieves the result of the latest conversion.

• void ADC0_ConversionDoneCallbackRegister (void(*callback)(void))

  Sets the callback function for the Result Ready Interrupt (RESRDY).

• adc_result_t ADC0_ChannelSelectAndConvert (adc_channel_t channel)

  Starts the conversion and retrieves the result of one conversion on the selected channel.

• uint8_t ADC0_ResolutionGet (void)

  Returns the resolution of the ADC module.

• void ADC0_ConversionStop (void)

  Stops the ongoing ADC conversion.

• void ADC0_SampleRepeatCountSet (adc_repeat_count_t repeatCount)

  Loads the Sample Length with the specified value.

• void ADC0_ComputationModeSet (adc_computation_mode_t computationMode)

  Sets the Computation mode.

• void ADC0_UpperThresholdSet (adc_threshold_t upperThreshold)

  Sets the value of the Window Comparator High Threshold (WINHT) register.

• void ADC0_LowerThresholdSet (adc_threshold_t lowerThreshold)

  Sets the value of the Window Comparator Low Threshold (WINLT) register.

• void ADC0_ThresholdModeSet (adc_threshold_mode_t thresholdMode)

  Sets the Window Comparator mode.

• adc_accumulate_t ADC0_AccumulatedResultGet (void)

  Retrieves the value of the accumulated conversions.

• void ADC0_ThresholdCallbackRegister (void(*callback)(void))

  Sets the callback function for the Window Comparator Interrupt (WCMP).

• void ADC0_ContinuousConversionEnable (void)

  Sets the Free-Running (FREERUN) bit to 1.

• void ADC0_ContinuousConversionDisable (void)

  Sets the Free-Running (FREERUN) bit to 0.

• void ADC0_AutoTriggerEnable (void)

  Sets the Start Event Input (STARTEI) bit to 1.

• void ADC0_AutoTriggerDisable (void)

  Sets the Start Event Input (STARTEI) bit to 0.

• bool ADC0_IsConversionDoneInterruptFlagSet (void)

  Checks the Result Ready Interrupt (RESRDY) flag status.

• void ADC0_ConversionDoneInterruptFlagClear (void)

  Clears the Result Ready Interrupt (RESRDY) flag.

• bool ADC0_IsThresholdInterruptFlagSet (void)

  Checks the Window Comparator Interrupt (WCMP) flag status.

• void ADC0_ThresholdInterruptFlagClear (void)

  Clears the Window Comparator Interrupt (WCMP) flag.

• void ADC0_Tasks (void)

  Implements the Tasks routine for the polling implementation.

• static void(* ADC0_ConversionDoneCallback )(void)

• static void(* ADC0_ThresholdCallback )(void)

This file contains the API implementations for the ADC0 driver.

ADC0 Generated Driver File