modm API documentation
modm::platform::AdcInterrupt Class Reference

#include <modm/platform/adc/adc_interrupt.hpp>

Inheritance diagram for modm::platform::AdcInterrupt:
modm::platform::Adc modm::AdcInterrupt modm::Adc modm::Adc modm::PeripheralDriver modm::PeripheralDriver

Static Public Member Functions

static void attachInterruptHandler (Handler handler)
 
- Static Public Member Functions inherited from modm::platform::Adc
template<class... Signals>
static void connect ()
 
template<class SystemClock , frequency_t frequency = kHz(100), percent_t tolerance = pct(10)>
static void initialize ()
 
static void disable ()
 
static void startConversion ()
 
static bool isConversionFinished ()
 
static uint16_t getValue ()
 
static uint16_t readChannel (Channel channel)
 
static bool setChannel (Channel channel)
 
static uint8_t getChannel ()
 
static void enableFreeRunningMode ()
 
static void diableFreeRunningMode ()
 
static void setLeftAdjustResult ()
 
static void setRightAdjustResult ()
 
static void setReference (Reference reference)
 
static void enableInterrupt ()
 Enables the ADC Conversion Complete Interrupt.
 
static void disableInterrupt ()
 Disables the ADC Conversion Complete Interrupt.
 
static bool getInterruptFlag ()
 
static InterruptFlag_t getInterruptFlags ()
 
static void acknowledgeInterruptFlag ()
 Clears the interrupt flag.
 
static void acknowledgeInterruptFlags (const InterruptFlag_t flags)
 Clears the interrupt flag if flags is set to InterruptFlag::All
 
static void enableAutoTrigger ()
 
static void disableAutoTrigger ()
 disable auto triggering of the ADC
 
static void setAutoTriggerSource (uint8_t source)
 
- Static Public Member Functions inherited from modm::Adc
template<class... Signals>
static void connect ()
 
template<class SystemClock , frequency_t frequency = 200_kHz, percent_t tolerance = 10_pct>
static void initialize ()
 
static void disable ()
 
static void startConversion ()
 
static bool isConversionFinished ()
 
static uint16_t getValue ()
 
static uint16_t readChannel (Channel channel)
 
static bool setChannel (Channel channel)
 
static uint8_t getChannel ()
 
static void enableFreeRunningMode ()
 
static void disableFreeRunningMode ()
 
static void setLeftAdjustResult ()
 Change the presentation of the ADC conversion result to left adjusted.
 
static void setRightAdjustResult ()
 Change the presentation of the ADC conversion result to right adjusted.
 
- Static Public Member Functions inherited from modm::PeripheralDriver
static void initialize ()
 initializes the peripheral, must be called before use.
 
static void configurePurpose ()
 configures a peripheral for a specific purpose
 
static void setParameter ()
 sets a parameter
 
static void getParameter ()
 returns a parameter
 
static bool getInterruptFlag ()
 Read an interrupt flag.
 
static void acknowledgeInterruptFlag ()
 
template<baudrate_t available, baudrate_t requested, percent_t tolerance>
static void assertBaudrateInTolerance ()
 
- Static Public Member Functions inherited from modm::AdcInterrupt
static void attachInterruptHandler (Handler handler)
 

Static Public Attributes

static Handler handler
 
- Static Public Attributes inherited from modm::platform::Adc
static constexpr uint8_t Resolution = 10
 
- Static Public Attributes inherited from modm::Adc
static constexpr uint8_t Resolution
 describes the maximum resolution in bits
 

Additional Inherited Members

- Public Typedefs inherited from modm::platform::Adc
typedef uint8_t Channel
 
- Public Typedefs inherited from modm::Adc
typedef uint8_t Channel
 this type may also be an enum or enum class
 
- Public Types inherited from modm::platform::Adc
enum  Reference : uint8_t {
  InternalVcc = 0, ExternalRef = (1 << REFS0), Internal1V1 = (1 << REFS1), Internal2V56 = (1 << REFS2) | (1 << REFS1),
  Internal2V56WithCap = (1 << REFS2) | (1 << REFS1) | (1 << REFS0)
}
 
enum  InterruptFlag : uint8_t { All = (1<<ADIF) }
 
- Public Member Functions inherited from modm::platform::Adc
 MODM_FLAGS8 (InterruptFlag)
 
- Protected Typedefs inherited from modm::AdcInterrupt
typedef void (* Handler) ()
 

Detailed Description

Author
Niklas Hauser

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