idfxx::adc::input::config Struct Reference

Configuration for a one-shot analog input. More...

Public Member Functions
constexpr bool	operator== (const config &) const noexcept=default
	Compares two configurations for equality.

Public Attributes
idfxx::gpio	pin = gpio::nc()
	ADC-capable GPIO (required).
enum attenuation	attenuation = attenuation::db_12
	Input range selection.
divider_ratio	divider {}
	External voltage-divider ratio between the source and the pin.

Detailed Description

Configuration for a one-shot analog input.

Definition at line 99 of file adc.hpp.

Member Function Documentation

operator==()

constexpr bool idfxx::adc::input::config::operator== ( const config &  ) const

constexprdefaultnoexcept

Compares two configurations for equality.

Member Data Documentation

attenuation

enum attenuation idfxx::adc::input::config::attenuation = attenuation::db_12

Input range selection.

Definition at line 101 of file adc.hpp.

divider

divider_ratio idfxx::adc::input::config::divider {}

External voltage-divider ratio between the source and the pin.

read_voltage scales by it to report the source voltage; read_raw is unaffected.

Definition at line 105 of file adc.hpp.

pin

idfxx::gpio idfxx::adc::input::config::pin = gpio::nc()

ADC-capable GPIO (required).

Definition at line 100 of file adc.hpp.

---

The documentation for this struct was generated from the following file:

• idfxx_adc/include/idfxx/adc.hpp