ESPHome  2022.6.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::dht::DHT Class Reference

Component for reading temperature/humidity measurements from DHT11/DHT22 sensors. More...

#include <dht.h>

Inheritance diagram for esphome::dht::DHT:
esphome::PollingComponent esphome::Component

Public Member Functions

void set_dht_model (DHTModel model)
 Manually select the DHT model. More...
 
void set_pin (InternalGPIOPin *pin)
 
void set_model (DHTModel model)
 
void set_temperature_sensor (sensor::Sensor *temperature_sensor)
 
void set_humidity_sensor (sensor::Sensor *humidity_sensor)
 
void setup () override
 Set up the pins and check connection. More...
 
void dump_config () override
 
void update () override
 Update sensor values and push them to the frontend. More...
 
float get_setup_priority () const override
 HARDWARE_LATE setup priority. 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...
 
- 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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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 Member Functions

bool read_sensor_ (float *temperature, float *humidity, bool report_errors)
 
- 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()> &&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()> &&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...
 

Protected Attributes

InternalGPIOPinpin_
 
DHTModel model_ {DHT_MODEL_AUTO_DETECT}
 
bool is_auto_detect_ {false}
 
sensor::Sensortemperature_sensor_ {nullptr}
 
sensor::Sensorhumidity_sensor_ {nullptr}
 
- 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
 

Detailed Description

Component for reading temperature/humidity measurements from DHT11/DHT22 sensors.

Definition at line 21 of file dht.h.

Member Function Documentation

◆ dump_config()

void esphome::dht::DHT::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file dht.cpp.

◆ get_setup_priority()

float esphome::dht::DHT::get_setup_priority ( ) const
overridevirtual

HARDWARE_LATE setup priority.

Reimplemented from esphome::Component.

Definition at line 69 of file dht.cpp.

◆ read_sensor_()

bool HOT IRAM_ATTR esphome::dht::DHT::read_sensor_ ( float *  temperature,
float *  humidity,
bool  report_errors 
)
protected

Definition at line 74 of file dht.cpp.

◆ set_dht_model()

void esphome::dht::DHT::set_dht_model ( DHTModel  model)

Manually select the DHT model.

Valid values are:

  • DHT_MODEL_AUTO_DETECT (default)
  • DHT_MODEL_DHT11
  • DHT_MODEL_DHT22
  • DHT_MODEL_AM2302
  • DHT_MODEL_RHT03
  • DHT_MODEL_SI7021
  • DHT_MODEL_DHT22_TYPE2
Parameters
modelThe DHT model.

Definition at line 70 of file dht.cpp.

◆ set_humidity_sensor()

void esphome::dht::DHT::set_humidity_sensor ( sensor::Sensor humidity_sensor)
inline

Definition at line 42 of file dht.h.

◆ set_model()

void esphome::dht::DHT::set_model ( DHTModel  model)
inline

Definition at line 40 of file dht.h.

◆ set_pin()

void esphome::dht::DHT::set_pin ( InternalGPIOPin pin)
inline

Definition at line 39 of file dht.h.

◆ set_temperature_sensor()

void esphome::dht::DHT::set_temperature_sensor ( sensor::Sensor temperature_sensor)
inline

Definition at line 41 of file dht.h.

◆ setup()

void esphome::dht::DHT::setup ( )
overridevirtual

Set up the pins and check connection.

Reimplemented from esphome::Component.

Definition at line 10 of file dht.cpp.

◆ update()

void esphome::dht::DHT::update ( )
overridevirtual

Update sensor values and push them to the frontend.

Implements esphome::PollingComponent.

Definition at line 33 of file dht.cpp.

Field Documentation

◆ humidity_sensor_

sensor::Sensor* esphome::dht::DHT::humidity_sensor_ {nullptr}
protected

Definition at line 59 of file dht.h.

◆ is_auto_detect_

bool esphome::dht::DHT::is_auto_detect_ {false}
protected

Definition at line 57 of file dht.h.

◆ model_

DHTModel esphome::dht::DHT::model_ {DHT_MODEL_AUTO_DETECT}
protected

Definition at line 56 of file dht.h.

◆ pin_

InternalGPIOPin* esphome::dht::DHT::pin_
protected

Definition at line 55 of file dht.h.

◆ temperature_sensor_

sensor::Sensor* esphome::dht::DHT::temperature_sensor_ {nullptr}
protected

Definition at line 58 of file dht.h.


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