ESPHome  2022.6.2
Public Member Functions | Protected Attributes
esphome::dallas::DallasComponent Class Reference

#include <dallas_component.h>

Inheritance diagram for esphome::dallas::DallasComponent:
esphome::PollingComponent esphome::Component

Public Member Functions

void set_pin (InternalGPIOPin *pin)
 
void register_sensor (DallasTemperatureSensor *sensor)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void update () override
 
- 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 Attributes

friend DallasTemperatureSensor
 
InternalGPIOPinpin_
 
ESPOneWireone_wire_
 
std::vector< DallasTemperatureSensor * > sensors_
 
std::vector< uint64_t > found_sensors_
 
- 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

- 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...
 

Detailed Description

Definition at line 12 of file dallas_component.h.

Member Function Documentation

◆ dump_config()

void esphome::dallas::DallasComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 74 of file dallas_component.cpp.

◆ get_setup_priority()

float esphome::dallas::DallasComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 19 of file dallas_component.h.

◆ register_sensor()

void esphome::dallas::DallasComponent::register_sensor ( DallasTemperatureSensor sensor)

Definition at line 102 of file dallas_component.cpp.

◆ set_pin()

void esphome::dallas::DallasComponent::set_pin ( InternalGPIOPin pin)
inline

Definition at line 14 of file dallas_component.h.

◆ setup()

void esphome::dallas::DallasComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 31 of file dallas_component.cpp.

◆ update()

void esphome::dallas::DallasComponent::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 103 of file dallas_component.cpp.

Field Documentation

◆ DallasTemperatureSensor

friend esphome::dallas::DallasComponent::DallasTemperatureSensor
protected

Definition at line 24 of file dallas_component.h.

◆ found_sensors_

std::vector<uint64_t> esphome::dallas::DallasComponent::found_sensors_
protected

Definition at line 29 of file dallas_component.h.

◆ one_wire_

ESPOneWire* esphome::dallas::DallasComponent::one_wire_
protected

Definition at line 27 of file dallas_component.h.

◆ pin_

InternalGPIOPin* esphome::dallas::DallasComponent::pin_
protected

Definition at line 26 of file dallas_component.h.

◆ sensors_

std::vector<DallasTemperatureSensor *> esphome::dallas::DallasComponent::sensors_
protected

Definition at line 28 of file dallas_component.h.


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