ESPHome  2024.11.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::dallas_temp::DallasTemperatureSensor Class Reference

#include <dallas_temp.h>

Inheritance diagram for esphome::dallas_temp::DallasTemperatureSensor:
esphome::PollingComponent esphome::sensor::Sensor esphome::one_wire::OneWireDevice esphome::Component esphome::EntityBase esphome::EntityBase_DeviceClass esphome::EntityBase_UnitOfMeasurement

Public Member Functions

void setup () override
 
void update () override
 
void dump_config () override
 
void set_resolution (uint8_t resolution)
 Set the resolution for this sensor. 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...
 
virtual float get_setup_priority () const
 priority of setup(). 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...
 
- 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...
 
virtual std::string unique_id ()
 Override this method to set the unique ID of this sensor. 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::one_wire::OneWireDevice
void set_address (uint64_t address)
 store the address of the device More...
 
void set_one_wire_bus (OneWireBus *bus)
 store the pointer to the OneWireBus to use More...
 
const std::string & get_address_name ()
 Helper to create (and cache) the name for this sensor. For example "0xfe0000031f1eaf29". More...
 
std::string unique_id ()
 

Protected Member Functions

uint16_t millis_to_wait_for_conversion_ () const
 Get the number of milliseconds we have to wait for the conversion phase. More...
 
bool read_scratch_pad_ ()
 
void read_scratch_pad_int_ ()
 
bool check_scratch_pad_ ()
 
float get_temp_c_ ()
 
- 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...
 
- 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::one_wire::OneWireDevice
bool check_address_ ()
 find an address if necessary should be called from setup More...
 
bool send_command_ (uint8_t cmd)
 send command on the bus More...
 

Protected Attributes

uint8_t resolution_
 
uint8_t scratch_pad_ [9] = {0}
 
- 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}
 
- 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::one_wire::OneWireDevice
uint64_t address_ {0}
 
OneWireBusbus_ {nullptr}
 pointer to OneWireBus instance More...
 
std::string address_name_
 

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

Detailed Description

Definition at line 10 of file dallas_temp.h.

Member Function Documentation

◆ check_scratch_pad_()

bool esphome::dallas_temp::DallasTemperatureSensor::check_scratch_pad_ ( )
protected

Definition at line 129 of file dallas_temp.cpp.

◆ dump_config()

void esphome::dallas_temp::DallasTemperatureSensor::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 28 of file dallas_temp.cpp.

◆ get_temp_c_()

float esphome::dallas_temp::DallasTemperatureSensor::get_temp_c_ ( )
protected

Definition at line 145 of file dallas_temp.cpp.

◆ millis_to_wait_for_conversion_()

uint16_t esphome::dallas_temp::DallasTemperatureSensor::millis_to_wait_for_conversion_ ( ) const
protected

Get the number of milliseconds we have to wait for the conversion phase.

Definition at line 15 of file dallas_temp.cpp.

◆ read_scratch_pad_()

bool esphome::dallas_temp::DallasTemperatureSensor::read_scratch_pad_ ( )
protected

Definition at line 65 of file dallas_temp.cpp.

◆ read_scratch_pad_int_()

void IRAM_ATTR esphome::dallas_temp::DallasTemperatureSensor::read_scratch_pad_int_ ( )
protected

Definition at line 59 of file dallas_temp.cpp.

◆ set_resolution()

void esphome::dallas_temp::DallasTemperatureSensor::set_resolution ( uint8_t  resolution)
inline

Set the resolution for this sensor.

Definition at line 17 of file dallas_temp.h.

◆ setup()

void esphome::dallas_temp::DallasTemperatureSensor::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 80 of file dallas_temp.cpp.

◆ update()

void esphome::dallas_temp::DallasTemperatureSensor::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 39 of file dallas_temp.cpp.

Field Documentation

◆ resolution_

uint8_t esphome::dallas_temp::DallasTemperatureSensor::resolution_
protected

Definition at line 20 of file dallas_temp.h.

◆ scratch_pad_

uint8_t esphome::dallas_temp::DallasTemperatureSensor::scratch_pad_[9] = {0}
protected

Definition at line 21 of file dallas_temp.h.


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