ESPHome  2024.5.5
Public Member Functions | Protected Attributes
esphome::emc2101::EMC2101Sensor Class Reference

This class exposes the EMC2101 sensors. More...

#include <emc2101_sensor.h>

Inheritance diagram for esphome::emc2101::EMC2101Sensor:
esphome::PollingComponent esphome::Component

Public Member Functions

 EMC2101Sensor (Emc2101Component *parent)
 
void dump_config () override
 Used by ESPHome framework. More...
 
void update () override
 Used by ESPHome framework. More...
 
float get_setup_priority () const override
 Used by ESPHome framework. More...
 
void set_internal_temperature_sensor (sensor::Sensor *sensor)
 Used by ESPHome framework. More...
 
void set_external_temperature_sensor (sensor::Sensor *sensor)
 Used by ESPHome framework. More...
 
void set_speed_sensor (sensor::Sensor *sensor)
 Used by ESPHome framework. More...
 
void set_duty_cycle_sensor (sensor::Sensor *sensor)
 Used by ESPHome framework. 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 setup ()
 Where the component's initialization should happen. More...
 
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 ()
 
bool is_ready ()
 
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

Emc2101Componentparent_
 
sensor::Sensorinternal_temperature_sensor_ {nullptr}
 
sensor::Sensorexternal_temperature_sensor_ {nullptr}
 
sensor::Sensorspeed_sensor_ {nullptr}
 
sensor::Sensorduty_cycle_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}
 

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

This class exposes the EMC2101 sensors.

Definition at line 11 of file emc2101_sensor.h.

Constructor & Destructor Documentation

◆ EMC2101Sensor()

esphome::emc2101::EMC2101Sensor::EMC2101Sensor ( Emc2101Component parent)
inline

Definition at line 13 of file emc2101_sensor.h.

Member Function Documentation

◆ dump_config()

void esphome::emc2101::EMC2101Sensor::dump_config ( )
overridevirtual

Used by ESPHome framework.

Reimplemented from esphome::Component.

Definition at line 12 of file emc2101_sensor.cpp.

◆ get_setup_priority()

float esphome::emc2101::EMC2101Sensor::get_setup_priority ( ) const
overridevirtual

Used by ESPHome framework.

Reimplemented from esphome::Component.

Definition at line 10 of file emc2101_sensor.cpp.

◆ set_duty_cycle_sensor()

void esphome::emc2101::EMC2101Sensor::set_duty_cycle_sensor ( sensor::Sensor sensor)
inline

Used by ESPHome framework.

Definition at line 28 of file emc2101_sensor.h.

◆ set_external_temperature_sensor()

void esphome::emc2101::EMC2101Sensor::set_external_temperature_sensor ( sensor::Sensor sensor)
inline

Used by ESPHome framework.

Definition at line 24 of file emc2101_sensor.h.

◆ set_internal_temperature_sensor()

void esphome::emc2101::EMC2101Sensor::set_internal_temperature_sensor ( sensor::Sensor sensor)
inline

Used by ESPHome framework.

Definition at line 22 of file emc2101_sensor.h.

◆ set_speed_sensor()

void esphome::emc2101::EMC2101Sensor::set_speed_sensor ( sensor::Sensor sensor)
inline

Used by ESPHome framework.

Definition at line 26 of file emc2101_sensor.h.

◆ update()

void esphome::emc2101::EMC2101Sensor::update ( )
overridevirtual

Used by ESPHome framework.

Implements esphome::PollingComponent.

Definition at line 20 of file emc2101_sensor.cpp.

Field Documentation

◆ duty_cycle_sensor_

sensor::Sensor* esphome::emc2101::EMC2101Sensor::duty_cycle_sensor_ {nullptr}
protected

Definition at line 35 of file emc2101_sensor.h.

◆ external_temperature_sensor_

sensor::Sensor* esphome::emc2101::EMC2101Sensor::external_temperature_sensor_ {nullptr}
protected

Definition at line 33 of file emc2101_sensor.h.

◆ internal_temperature_sensor_

sensor::Sensor* esphome::emc2101::EMC2101Sensor::internal_temperature_sensor_ {nullptr}
protected

Definition at line 32 of file emc2101_sensor.h.

◆ parent_

Emc2101Component* esphome::emc2101::EMC2101Sensor::parent_
protected

Definition at line 31 of file emc2101_sensor.h.

◆ speed_sensor_

sensor::Sensor* esphome::emc2101::EMC2101Sensor::speed_sensor_ {nullptr}
protected

Definition at line 34 of file emc2101_sensor.h.


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