ESPHome  2024.7.2
Public Member Functions | Protected Attributes
esphome::adc::ADCSensor Class Reference

#include <adc_sensor.h>

Inheritance diagram for esphome::adc::ADCSensor:
esphome::sensor::Sensor esphome::PollingComponent esphome::voltage_sampler::VoltageSampler esphome::EntityBase esphome::EntityBase_DeviceClass esphome::EntityBase_UnitOfMeasurement esphome::Component

Public Member Functions

void set_attenuation (adc_atten_t attenuation)
 Set the attenuation for this pin. Only available on the ESP32. More...
void set_channel1 (adc1_channel_t channel)
void set_channel2 (adc2_channel_t channel)
void set_autorange (bool autorange)
void update () override
 Update ADC values. More...
void setup () override
 Setup ADC. More...
void dump_config () override
float get_setup_priority () const override
 HARDWARE_LATE setup priority More...
void set_pin (InternalGPIOPin *pin)
void set_output_raw (bool output_raw)
void set_sample_count (uint8_t sample_count)
float sample () override
std::string unique_id () override
void set_is_temperature ()
- Public Member Functions inherited from esphome::sensor::Sensor
 Sensor ()
int8_t get_accuracy_decimals ()
 Get the accuracy in decimals, using the manual override if set. More...
void set_accuracy_decimals (int8_t accuracy_decimals)
 Manually set the accuracy in decimals. More...
StateClass get_state_class ()
 Get the state class, using the manual override if set. More...
void set_state_class (StateClass state_class)
 Manually set the state class. More...
bool get_force_update () const
 Get whether force update mode is enabled. More...
void set_force_update (bool force_update)
 Set force update mode. More...
void add_filter (Filter *filter)
 Add a filter to the filter chain. Will be appended to the back. More...
void add_filters (const std::vector< Filter *> &filters)
 Add a list of vectors to the back of the filter chain. More...
void set_filters (const std::vector< Filter *> &filters)
 Clear the filters and replace them by filters. More...
void clear_filters ()
 Clear the entire filter chain. More...
float get_state () const
 Getter-syntax for .state. More...
float get_raw_state () const
 Getter-syntax for .raw_state. More...
void publish_state (float state)
 Publish a new state to the front-end. More...
void add_on_state_callback (std::function< void(float)> &&callback)
 Add a callback that will be called every time a filtered value arrives. More...
void add_on_raw_state_callback (std::function< void(float)> &&callback)
 Add a callback that will be called every time the sensor sends a raw value. More...
bool has_state () const
 Return whether this sensor has gotten a full state (that passed through all filters) yet. More...
void internal_send_state_to_frontend (float state)
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
void set_name (const char *name)
bool has_own_name () const
std::string get_object_id () const
void set_object_id (const char *object_id)
uint32_t get_object_id_hash ()
bool is_internal () const
void set_internal (bool internal)
bool is_disabled_by_default () const
void set_disabled_by_default (bool disabled_by_default)
EntityCategory get_entity_category () const
void set_entity_category (EntityCategory entity_category)
std::string get_icon () const
void set_icon (const char *icon)
- Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
void set_device_class (const char *device_class)
 Manually set the device class. More...
- Public Member Functions inherited from esphome::EntityBase_UnitOfMeasurement
std::string get_unit_of_measurement ()
 Get the unit of measurement, using the manual override if set. More...
void set_unit_of_measurement (const char *unit_of_measurement)
 Manually set the unit of measurement. More...
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
void call_setup () override
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
void start_poller ()
void stop_poller ()
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
float get_actual_setup_priority () const
void set_setup_priority (float priority)
virtual float get_loop_priority () const
 priority of loop(). More...
void call ()
virtual void on_shutdown ()
virtual void on_safe_shutdown ()
uint32_t get_component_state () const
virtual void mark_failed ()
 Mark this component as failed. More...
bool is_failed () const
bool is_ready () const
virtual bool can_proceed ()
bool status_has_warning () const
bool status_has_error () const
void status_set_warning (const char *message="unspecified")
void status_set_error (const char *message="unspecified")
void status_clear_warning ()
void status_clear_error ()
void status_momentary_warning (const std::string &name, uint32_t length=5000)
void status_momentary_error (const std::string &name, uint32_t length=5000)
bool has_overridden_loop () const
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...

Protected Attributes

bool output_raw_ {false}
uint8_t sample_count_ {1}
bool is_temperature_ {false}
adc_atten_t attenuation_ {ADC_ATTEN_DB_0}
adc1_channel_t channel1_ {ADC1_CHANNEL_MAX}
adc2_channel_t channel2_ {ADC2_CHANNEL_MAX}
bool autorange_ {false}
esp_adc_cal_characteristics_t cal_characteristics_ [SOC_ADC_ATTEN_NUM] = {}
- Protected Attributes inherited from esphome::sensor::Sensor
CallbackManager< void(float)> raw_callback_
 Storage for raw state callbacks. More...
CallbackManager< void(float)> callback_
 Storage for filtered state callbacks. More...
Filterfilter_list_ {nullptr}
 Store all active filters. More...
optional< int8_t > accuracy_decimals_
 Accuracy in decimals override. More...
optional< StateClassstate_class_ {STATE_CLASS_NONE}
 State class override. More...
bool force_update_ {false}
 Force update mode. More...
bool has_state_ {false}
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
const char * object_id_c_str_ {nullptr}
const char * icon_c_str_ {nullptr}
uint32_t object_id_hash_
bool has_own_name_ {false}
bool internal_ {false}
bool disabled_by_default_ {false}
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
- Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char * device_class_ {nullptr}
 Device class override. More...
- Protected Attributes inherited from esphome::EntityBase_UnitOfMeasurement
const char * unit_of_measurement_ {nullptr}
 Unit of measurement override. More...
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
float setup_priority_override_ {NAN}
const char * component_source_ {nullptr}

Additional Inherited Members

- Data Fields inherited from esphome::sensor::Sensor
float state
 This member variable stores the last state that has passed through all filters. More...
float raw_state
 This member variable stores the current raw state of the sensor, without any filters applied. More...
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
void calc_object_id_ ()
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
virtual void call_dump_config ()
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
void set_interval (uint32_t interval, std::function< void()> &&f)
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
void set_timeout (uint32_t timeout, std::function< void()> &&f)
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...

Detailed Description

Definition at line 32 of file adc_sensor.h.

Member Function Documentation

◆ dump_config()

void esphome::adc::ADCSensor::dump_config ( )

Reimplemented from esphome::Component.

◆ get_setup_priority()

float esphome::adc::ADCSensor::get_setup_priority ( ) const

HARDWARE_LATE setup priority

Reimplemented from esphome::Component.

◆ sample()

float esphome::adc::ADCSensor::sample ( )

◆ set_attenuation()

void esphome::adc::ADCSensor::set_attenuation ( adc_atten_t  attenuation)

Set the attenuation for this pin. Only available on the ESP32.

Definition at line 36 of file adc_sensor.h.

◆ set_autorange()

void esphome::adc::ADCSensor::set_autorange ( bool  autorange)

Definition at line 45 of file adc_sensor.h.

◆ set_channel1()

void esphome::adc::ADCSensor::set_channel1 ( adc1_channel_t  channel)

Definition at line 37 of file adc_sensor.h.

◆ set_channel2()

void esphome::adc::ADCSensor::set_channel2 ( adc2_channel_t  channel)

Definition at line 41 of file adc_sensor.h.

◆ set_is_temperature()

void esphome::adc::ADCSensor::set_is_temperature ( )

Definition at line 65 of file adc_sensor.h.

◆ set_output_raw()

void esphome::adc::ADCSensor::set_output_raw ( bool  output_raw)

Definition at line 56 of file adc_sensor.h.

◆ set_pin()

void esphome::adc::ADCSensor::set_pin ( InternalGPIOPin pin)

Definition at line 55 of file adc_sensor.h.

◆ set_sample_count()

void esphome::adc::ADCSensor::set_sample_count ( uint8_t  sample_count)

◆ setup()

void esphome::adc::ADCSensor::setup ( )

Setup ADC.

Reimplemented from esphome::Component.

◆ unique_id()

std::string esphome::adc::ADCSensor::unique_id ( )

Reimplemented from esphome::sensor::Sensor.

◆ update()

void esphome::adc::ADCSensor::update ( )

Update ADC values.

Implements esphome::PollingComponent.

Field Documentation

◆ attenuation_

adc_atten_t esphome::adc::ADCSensor::attenuation_ {ADC_ATTEN_DB_0}

Definition at line 78 of file adc_sensor.h.

◆ autorange_

bool esphome::adc::ADCSensor::autorange_ {false}

Definition at line 81 of file adc_sensor.h.

◆ cal_characteristics_

esp_adc_cal_characteristics_t esphome::adc::ADCSensor::cal_characteristics_ = {}

Definition at line 83 of file adc_sensor.h.

◆ channel1_

adc1_channel_t esphome::adc::ADCSensor::channel1_ {ADC1_CHANNEL_MAX}

Definition at line 79 of file adc_sensor.h.

◆ channel2_

adc2_channel_t esphome::adc::ADCSensor::channel2_ {ADC2_CHANNEL_MAX}

Definition at line 80 of file adc_sensor.h.

◆ is_temperature_

bool esphome::adc::ADCSensor::is_temperature_ {false}

Definition at line 74 of file adc_sensor.h.

◆ output_raw_

bool esphome::adc::ADCSensor::output_raw_ {false}

Definition at line 70 of file adc_sensor.h.

◆ pin_

InternalGPIOPin* esphome::adc::ADCSensor::pin_

Definition at line 69 of file adc_sensor.h.

◆ sample_count_

uint8_t esphome::adc::ADCSensor::sample_count_ {1}

Definition at line 71 of file adc_sensor.h.

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