esphome::Component Class Reference

#include <component.h>

Inheritance diagram for esphome::Component:

Public Member Functions
virtual void	setup ()
	Where the component's initialization should happen. More...
virtual void	loop ()
	This method will be called repeatedly. More...
virtual void	dump_config ()
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 ()
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
virtual void	call_loop ()
virtual void	call_setup ()
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_timeout (uint32_t timeout, std::function< void()> &&f)
void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name. More...
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
uint32_t	component_state_ {0x0000}
	State of this component. More...
float	setup_priority_override_ {NAN}
const char *	component_source_ = nullptr

Detailed Description

Definition at line 64 of file component.h.

Member Function Documentation

call()

void esphome::Component::call

(

)

Definition at line 70 of file component.cpp.

call_loop()

void esphome::Component::call_loop ( )

protectedvirtual

Reimplemented in esphome::mqtt::MQTTComponent.

Definition at line 66 of file component.cpp.

call_setup()

void esphome::Component::call_setup ( )

protectedvirtual

Reimplemented in esphome::PollingComponent, esphome::time::RealTimeClock, esphome::light::AddressableLight, and esphome::mqtt::MQTTComponent.

Definition at line 68 of file component.cpp.

can_proceed()

bool esphome::Component::can_proceed ( )

virtual

Reimplemented in esphome::mqtt::MQTTClientComponent, esphome::wifi::WiFiComponent, esphome::ethernet::EthernetComponent, esphome::esp32_ble_server::BLEServer, esphome::midea::ApplianceBase< T >, and esphome::midea::ApplianceBase< dudanov::midea::ac::AirConditioner >.

Definition at line 123 of file component.cpp.

cancel_defer()

bool esphome::Component::cancel_defer ( const std::string &  name )

protected

Cancel a defer callback using the specified name, name must not be empty.

Definition at line 110 of file component.cpp.

cancel_interval()

bool esphome::Component::cancel_interval ( const std::string &  name )

protected

Cancel an interval function.

Parameters

name	The identifier for this interval function.

Returns

Whether an interval functions was deleted.

Definition at line 54 of file component.cpp.

cancel_timeout()

bool esphome::Component::cancel_timeout ( const std::string &  name )

protected

Cancel a timeout function.

Parameters

name	The identifier for this timeout function.

Returns

Whether a timeout functions was deleted.

Definition at line 62 of file component.cpp.

defer() [1/2]

void esphome::Component::defer ( const std::string &  name, std::function< void()> &&  f  )

protected

Defer a callback to the next loop() call.

If name is specified and a defer() object with the same name exists, the old one is first removed.

Parameters

name	The name of the defer function.
f	The callback.

Definition at line 113 of file component.cpp.

defer() [2/2]

void esphome::Component::defer ( std::function< void()> &&  f )

protected

Defer a callback to the next loop() call.

Definition at line 107 of file component.cpp.

dump_config()

void esphome::Component::dump_config ( )

virtual

Reimplemented in esphome::nextion::Nextion, esphome::waveshare_epaper::WaveshareEPaper2P13InDKE, esphome::mqtt::MQTTMessageTrigger, esphome::waveshare_epaper::WaveshareEPaper7P5InV2, esphome::remote_base::RemoteReceiverBinarySensorBase, esphome::waveshare_epaper::WaveshareEPaper7P5In, esphome::waveshare_epaper::WaveshareEPaper5P8In, esphome::tsl2591::TSL2591Component, esphome::fastled_base::FastLEDLightOutput, esphome::waveshare_epaper::WaveshareEPaper4P2InBV2, esphome::wifi::WiFiComponent, esphome::mqtt::MQTTClientComponent, esphome::esp32_ble_tracker::ESP32BLETracker, esphome::waveshare_epaper::WaveshareEPaper4P2In, esphome::waveshare_epaper::WaveshareEPaper2P9InB, esphome::waveshare_epaper::WaveshareEPaper2P7In, esphome::i2c::I2CComponent, esphome::st7789v::ST7789V, esphome::bme680::BME680Component, esphome::ble_presence::BLEPresenceDevice, esphome::fingerprint_grow::FingerprintGrowComponent, esphome::waveshare_epaper::WaveshareEPaperTypeA, esphome::ble_client::BLEClient, esphome::dfplayer::DFPlayer, esphome::havells_solar::HavellsSolar, esphome::bme280::BME280Component, esphome::cs5460a::CS5460AComponent, esphome::max31856::MAX31856Sensor, esphome::tuya::Tuya, esphome::esp32_camera::ESP32Camera, esphome::mpr121::MPR121Component, esphome::spi::SPIComponent, esphome::zyaura::ZyAuraSensor, esphome::dsmr::Dsmr, esphome::tsl2561::TSL2561Sensor, esphome::web_server::WebServer, esphome::bmp280::BMP280Component, esphome::wifi_info::MacAddressWifiInfo, esphome::uart::UARTComponent, esphome::inkplate6::Inkplate6, esphome::rotary_encoder::RotaryEncoderSensor, esphome::pulse_counter::PulseCounterSensor, esphome::ota::OTAComponent, esphome::canbus::Canbus, esphome::deep_sleep::DeepSleepComponent, esphome::xpt2046::XPT2046Component, esphome::bme680_bsec::BME680BSECComponent, esphome::sdm_meter::SDMMeter, esphome::wifi_info::BSSIDWiFiInfo, esphome::as3935::AS3935Component, esphome::ble_rssi::BLERSSISensor, esphome::ruuvitag::RuuviTag, esphome::thermostat::ThermostatClimate, esphome::ac_dimmer::AcDimmer, esphome::rf_bridge::RFBridgeComponent, esphome::sgp40::SGP40Component, esphome::logger::Logger, esphome::light::LightState, esphome::dht::DHT, esphome::sim800l::Sim800LComponent, esphome::pca9685::PCA9685Output, esphome::pcd8544::PCD8544, esphome::tcs34725::TCS34725Component, esphome::tlc59208f::TLC59208FOutput, esphome::sx1509::SX1509Component, esphome::hmc5883l::HMC5883LComponent, esphome::selec_meter::SelecMeter, esphome::st7735::ST7735, esphome::ade7953::ADE7953, esphome::ethernet::EthernetComponent, esphome::ads1115::ADS1115Component, esphome::ili9341::ILI9341Display, esphome::wifi_info::SSIDWiFiInfo, esphome::esp32_ble_beacon::ESP32BLEBeacon, esphome::esp32_ble_server::BLEServer, esphome::bh1750::BH1750Sensor, esphome::climate_ir::ClimateIR, esphome::esp32_touch::ESP32TouchComponent, esphome::max31865::MAX31865Sensor, esphome::mqtt::MQTTSensorComponent, esphome::servo::Servo, esphome::tx20::Tx20Component, esphome::template_::TemplateCover, esphome::mcp3008::MCP3008Sensor, esphome::pulse_width::PulseWidthSensor, esphome::lcd_gpio::GPIOLCDDisplay, esphome::pcf8574::PCF8574Component, esphome::pmsa003i::PMSA003IComponent, esphome::esp32_ble::ESP32BLE, esphome::qmc5883l::QMC5883LComponent, esphome::sgp30::SGP30Component, esphome::ble_scanner::BLEScanner, esphome::sun::SunTextSensor, esphome::http_request::HttpRequestComponent, esphome::max7219digit::MAX7219Component, esphome::mqtt::MQTTCoverComponent, esphome::gpio::GPIOSwitch, esphome::t6615::T6615Component, esphome::vl53l0x::VL53L0XSensor, esphome::anova::Anova, esphome::integration::IntegrationSensor, esphome::pid::PIDClimateSensor, esphome::power_supply::PowerSupply, esphome::sps30::SPS30Component, esphome::status_led::StatusLEDLightOutput, esphome::teleinfo::TeleInfo, esphome::adc::ADCSensor, esphome::airthings_wave_plus::AirthingsWavePlus, esphome::max7219::MAX7219Component, esphome::api::APIServer, esphome::atc_mithermometer::ATCMiThermometer, esphome::ccs811::CCS811Component, esphome::duty_cycle::DutyCycleSensor, esphome::hbridge::HBridgeFan, esphome::ledc::LEDCOutput, esphome::pvvx_mithermometer::PVVXMiThermometer, esphome::resistance::ResistanceSensor, esphome::st7920::ST7920, esphome::tlc5947::TLC5947, esphome::binary_sensor_map::BinarySensorMap, esphome::hm3301::HM3301Component, esphome::mqtt::MQTTNumberComponent, esphome::mqtt::MQTTSelectComponent, esphome::pn532::PN532, esphome::rc522_spi::RC522Spi, esphome::scd30::SCD30Component, esphome::uln2003::ULN2003, esphome::am43::Am43, esphome::am43::Am43Component, esphome::bang_bang::BangBangClimate, esphome::ble_client::BLESensor, esphome::tm1637::TM1637Display, esphome::total_daily_energy::TotalDailyEnergy, esphome::ttp229_bsf::TTP229BSFComponent, esphome::esp32_improv::ESP32ImprovComponent, esphome::esp8266_pwm::ESP8266PWM, esphome::hx711::HX711Sensor, esphome::mqtt::MQTTBinarySensorComponent, esphome::my9231::MY9231OutputComponent, esphome::pulse_meter::PulseMeterSensor, esphome::pzemac::PZEMAC, esphome::sm300d2::SM300D2Sensor, esphome::ttp229_lsf::TTP229LSFComponent, esphome::xiaomi_cgpr1::XiaomiCGPR1, esphome::xiaomi_mjyd02yla::XiaomiMJYD02YLA, esphome::hlw8012::HLW8012Component, esphome::pzemdc::PZEMDC, esphome::ultrasonic::UltrasonicSensorComponent, esphome::xiaomi_miscale2::XiaomiMiscale2, esphome::xiaomi_wx08zm::XiaomiWX08ZM, esphome::mqtt::MQTTJSONLightComponent, esphome::mqtt::MQTTTextSensor, esphome::pmsx003::PMSX003Component, esphome::pzem004t::PZEM004T, esphome::sm16716::SM16716, esphome::wifi_info::IPAddressWiFiInfo, esphome::xiaomi_miscale::XiaomiMiscale, esphome::xiaomi_mue4094rt::XiaomiMUE4094RT, esphome::dallas::DallasComponent, esphome::mcp3008::MCP3008, esphome::mqtt::MQTTSwitchComponent, esphome::sds011::SDS011Component, esphome::sht4x::SHT4XComponent, esphome::xiaomi_cgg1::XiaomiCGG1, esphome::as3935_spi::SPIAS3935Component, esphome::bmp085::BMP085Component, esphome::cse7766::CSE7766Component, esphome::esp32_dac::ESP32DAC, esphome::gpio::GPIOBinaryOutput, esphome::mhz19::MHZ19Component, esphome::modbus::Modbus, esphome::pid::PIDClimate, esphome::shtcx::SHTCXComponent, esphome::sm2135::SM2135, esphome::sun::SunSensor, esphome::xiaomi_cgd1::XiaomiCGD1, esphome::xiaomi_cgdk2::XiaomiCGDK2, esphome::xiaomi_gcls002::XiaomiGCLS002, esphome::xiaomi_hhccjcy01::XiaomiHHCCJCY01, esphome::xiaomi_hhccpot002::XiaomiHHCCPOT002, esphome::xiaomi_jqjcy01ym::XiaomiJQJCY01YM, esphome::xiaomi_lywsd02::XiaomiLYWSD02, esphome::xiaomi_lywsd03mmc::XiaomiLYWSD03MMC, esphome::xiaomi_lywsdcgq::XiaomiLYWSDCGQ, esphome::xiaomi_mhoc401::XiaomiMHOC401, esphome::b_parasite::BParasite, esphome::ble_client::BLEClientSwitch, esphome::inkbird_ibsth1_mini::InkbirdIBSTH1_MINI, esphome::max31855::MAX31855Sensor, esphome::mcp23s08::MCP23S08, esphome::mcp23s17::MCP23S17, esphome::rtttl::Rtttl, esphome::sntp::SNTPComponent, esphome::ssd1306_spi::SPISSD1306, esphome::ssd1322_spi::SPISSD1322, esphome::ssd1325_spi::SPISSD1325, esphome::ssd1327_spi::SPISSD1327, esphome::ssd1331_spi::SPISSD1331, esphome::ssd1351_spi::SPISSD1351, esphome::template_::TemplateTextSensor, esphome::tm1651::TM1651Display, esphome::captive_portal::CaptivePortal, esphome::custom::CustomBinarySensorConstructor, esphome::custom::CustomTextSensorConstructor, esphome::hdc1080::HDC1080Component, esphome::htu21d::HTU21DComponent, esphome::senseair::SenseAirComponent, esphome::sht3xd::SHT3XDComponent, esphome::slow_pwm::SlowPWMOutput, esphome::speed::SpeedFan, esphome::template_::TemplateNumber, esphome::template_::TemplateSelect, esphome::uart::UARTSwitch, esphome::a4988::A4988, esphome::binary::BinaryFan, esphome::ct_clamp::CTClampSensor, esphome::gpio::GPIOBinarySensor, esphome::hrxl_maxsonar_wr::HrxlMaxsonarWrComponent, esphome::max6675::MAX6675Sensor, esphome::mcp23008::MCP23008, esphome::mcp23017::MCP23017, esphome::ntc::NTC, esphome::output::OutputSwitch, esphome::pm1006::PM1006Component, esphome::pn532_spi::PN532Spi, esphome::rc522::RC522, esphome::sdp3x::SDP3XComponent, esphome::sx1509::SX1509FloatOutputChannel, esphome::atm90e32::ATM90E32Component, esphome::custom::CustomSensorConstructor, esphome::custom::CustomSwitchConstructor, esphome::endstop::EndstopCover, esphome::mcp4725::MCP4725, esphome::mqtt_subscribe::MQTTSubscribeSensor, esphome::mqtt_subscribe::MQTTSubscribeTextSensor, esphome::pipsolar::PipsolarSwitch, esphome::sn74hc595::SN74HC595Component, esphome::template_::TemplateSensor, esphome::template_::TemplateSwitch, esphome::tuya::TuyaFan, esphome::aht10::AHT10Component, esphome::apds9960::APDS9960, esphome::as3935_i2c::I2CAS3935Component, esphome::ds1307::DS1307Component, esphome::ezo::EZOSensor, esphome::homeassistant::HomeassistantBinarySensor, esphome::homeassistant::HomeassistantSensor, esphome::homeassistant::HomeassistantTextSensor, esphome::homeassistant::HomeassistantTime, esphome::lcd_pcf8574::PCF8574LCDDisplay, esphome::midea::AirConditioner, esphome::status::StatusBinarySensor, esphome::status_led::StatusLED, esphome::sts3x::STS3XComponent, esphome::template_::TemplateBinarySensor, esphome::time_based::TimeBasedCover, esphome::tmp102::TMP102Component, esphome::tof10120::TOF10120Sensor, esphome::wifi_signal::WiFiSignalSensor, esphome::am2320::AM2320Component, esphome::dht12::DHT12Component, esphome::esp32_hall::ESP32HallSensor, esphome::ina219::INA219Component, esphome::ina226::INA226Component, esphome::ina3221::INA3221Component, esphome::mcp9808::MCP9808Sensor, esphome::mpu6050::MPU6050Component, esphome::ms5611::MS5611Component, esphome::pipsolar::PipsolarTextSensor, esphome::ssd1306_i2c::I2CSSD1306, esphome::ssd1327_i2c::I2CSSD1327, esphome::tca9548a::TCA9548AComponent, esphome::tmp117::TMP117Component, esphome::tuya::TuyaBinarySensor, esphome::tuya::TuyaClimate, esphome::tuya::TuyaLight, esphome::tuya::TuyaSensor, esphome::tuya::TuyaSwitch, esphome::version::VersionTextSensor, esphome::debug::DebugComponent, esphome::pn532_i2c::PN532I2C, esphome::rc522_i2c::RC522I2C, esphome::teleinfo::TeleInfoSensor, esphome::uptime::UptimeSensor, esphome::restart::RestartSwitch, esphome::shutdown::ShutdownSwitch, and esphome::teleinfo::TeleInfoTextSensor.

Definition at line 144 of file component.cpp.

get_actual_setup_priority()

float esphome::Component::get_actual_setup_priority

(

)

const

Definition at line 145 of file component.cpp.

get_component_source()

const char * esphome::Component::get_component_source

(

)

const

Get the integration where this component was declared as a string.

Returns "<unknown>" if source not set

Definition at line 96 of file component.cpp.

get_component_state()

uint32_t esphome::Component::get_component_state

(

)

const

Definition at line 69 of file component.cpp.

get_loop_priority()

float esphome::Component::get_loop_priority ( ) const

virtual

priority of loop().

higher -> executed earlier

Defaults to 0.

Returns

The loop priority of this component

Reimplemented in esphome::wifi::WiFiComponent, esphome::deep_sleep::DeepSleepComponent, esphome::status_led::StatusLEDLightOutput, and esphome::status_led::StatusLED.

Definition at line 42 of file component.cpp.

get_setup_priority()

float esphome::Component::get_setup_priority ( ) const

virtual

priority of setup().

higher -> executed earlier

Defaults to 0.

Returns

The setup priority of this component

Reimplemented in esphome::nextion::Nextion, esphome::mqtt::MQTTMessageTrigger, esphome::sensor::HeartbeatFilter, esphome::WaitUntilAction< Ts >, esphome::sensor::DebounceFilter, esphome::tsl2591::TSL2591Component, esphome::fastled_base::FastLEDLightOutput, esphome::mqtt::MQTTClientComponent, esphome::wifi::WiFiComponent, esphome::spi::SPIComponent, esphome::script::ScriptWaitAction< Ts >, esphome::i2c::I2CComponent, esphome::st7789v::ST7789V, esphome::DelayAction< Ts >, esphome::bme680::BME680Component, esphome::LoopTrigger, esphome::binary_sensor::MultiClickTrigger, esphome::fan::FanState, esphome::ble_presence::BLEPresenceDevice, esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >, esphome::StartupTrigger, esphome::mqtt::MQTTComponent, esphome::binary_sensor::AutorepeatFilter, esphome::uart::UARTComponent, esphome::bme280::BME280Component, esphome::cs5460a::CS5460AComponent, esphome::max31856::MAX31856Sensor, esphome::esp32_camera::ESP32Camera, esphome::mpr121::MPR121Component, esphome::tuya::Tuya, esphome::zyaura::ZyAuraSensor, esphome::web_server::WebServer, esphome::tsl2561::TSL2561Sensor, esphome::bmp280::BMP280Component, esphome::rotary_encoder::RotaryEncoderSensor, esphome::ForCondition< Ts >, esphome::deep_sleep::DeepSleepComponent, esphome::inkplate6::Inkplate6, esphome::ota::OTAComponent, esphome::canbus::Canbus, esphome::pulse_counter::PulseCounterSensor, esphome::xpt2046::XPT2046Component, esphome::bme680_bsec::BME680BSECComponent, esphome::binary_sensor::DelayedOffFilter, esphome::as3935::AS3935Component, esphome::wifi_info::BSSIDWiFiInfo, esphome::ble_rssi::BLERSSISensor, esphome::logger::Logger, esphome::ruuvitag::RuuviTag, esphome::sensor::ValueRangeTrigger, esphome::sgp40::SGP40Component, esphome::dht::DHT, esphome::light::LightState, esphome::st7735::ST7735, esphome::binary_sensor::DelayedOnFilter, esphome::pca9685::PCA9685Output, esphome::tlc59208f::TLC59208FOutput, esphome::hbridge::HBridgeLightOutput, esphome::mcp23016::MCP23016, esphome::sx1509::SX1509Component, esphome::hmc5883l::HMC5883LComponent, esphome::ethernet::EthernetComponent, esphome::tcs34725::TCS34725Component, esphome::ads1115::ADS1115Component, esphome::number::ValueRangeTrigger, esphome::bh1750::BH1750Sensor, esphome::esp32_ble_beacon::ESP32BLEBeacon, esphome::esp32_ble_server::BLEServer, esphome::esp32_touch::ESP32TouchComponent, esphome::gps::GPS, esphome::max31865::MAX31865Sensor, esphome::midea::ApplianceBase< T >, esphome::pcd8544::PCD8544, esphome::servo::Servo, esphome::ssd1306_base::SSD1306, esphome::template_::TemplateCover, esphome::tx20::Tx20Component, esphome::midea::ApplianceBase< dudanov::midea::ac::AirConditioner >, esphome::wifi_info::SSIDWiFiInfo, esphome::binary_sensor_map::BinarySensorMap, esphome::mcp3008::MCP3008Sensor, esphome::pmsa003i::PMSA003IComponent, esphome::pulse_width::PulseWidthSensor, esphome::ssd1325_base::SSD1325, esphome::binary_sensor::DelayedOnOffFilter, esphome::max7219digit::MAX7219Component, esphome::esp32_ble::ESP32BLE, esphome::qmc5883l::QMC5883LComponent, esphome::sgp30::SGP30Component, esphome::web_server_base::WebServerBase, esphome::ble_scanner::BLEScanner, esphome::e131::E131Component, esphome::http_request::HttpRequestComponent, esphome::max7219::MAX7219Component, esphome::pcf8574::PCF8574Component, esphome::ssd1351_base::SSD1351, esphome::power_supply::PowerSupply, esphome::ssd1322_base::SSD1322, esphome::ssd1327_base::SSD1327, esphome::status_led::StatusLEDLightOutput, esphome::vl53l0x::VL53L0XSensor, esphome::adc::ADCSensor, esphome::anova::Anova, esphome::esp32_improv::ESP32ImprovComponent, esphome::globals::GlobalsComponent< T >, esphome::integration::IntegrationSensor, esphome::prometheus::PrometheusHandler, esphome::sps30::SPS30Component, esphome::tm1637::TM1637Display, esphome::ccs811::CCS811Component, esphome::ledc::LEDCOutput, esphome::pn532::PN532, esphome::tlc5947::TLC5947, esphome::atc_mithermometer::ATCMiThermometer, esphome::hbridge::HBridgeFan, esphome::pvvx_mithermometer::PVVXMiThermometer, esphome::resistance::ResistanceSensor, esphome::st7920::ST7920, esphome::time::CronTrigger, esphome::gpio::GPIOSwitch, esphome::hm3301::HM3301Component, esphome::mcp23xxx_base::MCP23XXXBase, esphome::scd30::SCD30Component, esphome::uln2003::ULN2003, esphome::ultrasonic::UltrasonicSensorComponent, esphome::am43::Am43, esphome::am43::Am43Component, esphome::ble_client::BLESensor, esphome::duty_cycle::DutyCycleSensor, esphome::esp8266_pwm::ESP8266PWM, esphome::my9231::MY9231OutputComponent, esphome::sntp::SNTPComponent, esphome::ssd1331_base::SSD1331, esphome::t6615::T6615Component, esphome::template_::TemplateSwitch, esphome::total_daily_energy::TotalDailyEnergy, esphome::ttp229_bsf::TTP229BSFComponent, esphome::api::APIServer, esphome::hx711::HX711Sensor, esphome::ttp229_lsf::TTP229LSFComponent, esphome::xiaomi_cgpr1::XiaomiCGPR1, esphome::xiaomi_mjyd02yla::XiaomiMJYD02YLA, esphome::hlw8012::HLW8012Component, esphome::ili9341::ILI9341Display, esphome::lcd_base::LCDDisplay, esphome::modbus::Modbus, esphome::sds011::SDS011Component, esphome::sm16716::SM16716, esphome::xiaomi_miscale2::XiaomiMiscale2, esphome::xiaomi_wx08zm::XiaomiWX08ZM, esphome::ble_client::BLEClientSwitch, esphome::captive_portal::CaptivePortal, esphome::pulse_meter::PulseMeterSensor, esphome::xiaomi_miscale::XiaomiMiscale, esphome::xiaomi_mue4094rt::XiaomiMUE4094RT, esphome::bmp085::BMP085Component, esphome::dallas::DallasComponent, esphome::esp32_dac::ESP32DAC, esphome::hdc1080::HDC1080Component, esphome::htu21d::HTU21DComponent, esphome::mcp3008::MCP3008, esphome::rdm6300::RDM6300Component, esphome::sm2135::SM2135, esphome::xiaomi_cgg1::XiaomiCGG1, esphome::gpio::GPIOBinaryOutput, esphome::pm1006::PM1006Component, esphome::pmsx003::PMSX003Component, esphome::shtcx::SHTCXComponent, esphome::xiaomi_cgd1::XiaomiCGD1, esphome::xiaomi_cgdk2::XiaomiCGDK2, esphome::xiaomi_gcls002::XiaomiGCLS002, esphome::xiaomi_hhccjcy01::XiaomiHHCCJCY01, esphome::xiaomi_hhccpot002::XiaomiHHCCPOT002, esphome::xiaomi_jqjcy01ym::XiaomiJQJCY01YM, esphome::xiaomi_lywsd02::XiaomiLYWSD02, esphome::xiaomi_lywsd03mmc::XiaomiLYWSD03MMC, esphome::xiaomi_lywsdcgq::XiaomiLYWSDCGQ, esphome::xiaomi_mhoc401::XiaomiMHOC401, esphome::b_parasite::BParasite, esphome::inkbird_ibsth1_mini::InkbirdIBSTH1_MINI, esphome::max31855::MAX31855Sensor, esphome::rc522::RC522, esphome::slow_pwm::SlowPWMOutput, esphome::wifi_info::IPAddressWiFiInfo, esphome::a4988::A4988, esphome::gpio::GPIOBinarySensor, esphome::sdp3x::SDP3XComponent, esphome::sht3xd::SHT3XDComponent, esphome::sht4x::SHT4XComponent, esphome::speed::SpeedFan, esphome::template_::TemplateNumber, esphome::template_::TemplateSelect, esphome::tmp102::TMP102Component, esphome::binary::BinaryFan, esphome::cse7766::CSE7766Component, esphome::ct_clamp::CTClampSensor, esphome::max6675::MAX6675Sensor, esphome::mpu6050::MPU6050Component, esphome::ntc::NTC, esphome::sx1509::SX1509FloatOutputChannel, esphome::template_::TemplateSensor, esphome::wifi_signal::WiFiSignalSensor, esphome::atm90e32::ATM90E32Component, esphome::endstop::EndstopCover, esphome::ezo::EZOSensor, esphome::homeassistant::HomeassistantTime, esphome::mqtt_subscribe::MQTTSubscribeSensor, esphome::mqtt_subscribe::MQTTSubscribeTextSensor, esphome::status::StatusBinarySensor, esphome::status_led::StatusLED, esphome::template_::TemplateBinarySensor, esphome::template_::TemplateTextSensor, esphome::waveshare_epaper::WaveshareEPaper, esphome::aht10::AHT10Component, esphome::apds9960::APDS9960, esphome::ds1307::DS1307Component, esphome::homeassistant::HomeassistantBinarySensor, esphome::homeassistant::HomeassistantSensor, esphome::homeassistant::HomeassistantTextSensor, esphome::ina3221::INA3221Component, esphome::mhz19::MHZ19Component, esphome::output::OutputSwitch, esphome::sts3x::STS3XComponent, esphome::time_based::TimeBasedCover, esphome::tof10120::TOF10120Sensor, esphome::am2320::AM2320Component, esphome::dht12::DHT12Component, esphome::ina219::INA219Component, esphome::ina226::INA226Component, esphome::mcp9808::MCP9808Sensor, esphome::ms5611::MS5611Component, esphome::sn74hc595::SN74HC595Component, esphome::tmp117::TMP117Component, esphome::tuya::TuyaFan, esphome::uptime::UptimeSensor, esphome::version::VersionTextSensor, esphome::senseair::SenseAirComponent, esphome::interval::IntervalTrigger, esphome::sm300d2::SM300D2Sensor, and esphome::debug::DebugComponent.

Definition at line 44 of file component.cpp.

has_overridden_loop()

bool esphome::Component::has_overridden_loop

(

)

const

Definition at line 152 of file component.cpp.

is_failed()

bool esphome::Component::is_failed

(

)

Definition at line 122 of file component.cpp.

loop()

void esphome::Component::loop ( )

virtual

This method will be called repeatedly.

Analogous to Arduino's loop(). setup() is guaranteed to be called before this. Defaults to doing nothing.

Reimplemented in esphome::nextion::Nextion, esphome::WaitUntilAction< Ts >, esphome::wifi::WiFiComponent, esphome::mqtt::MQTTClientComponent, esphome::esp32_ble_tracker::ESP32BLETracker, esphome::st7789v::ST7789V, esphome::script::ScriptWaitAction< Ts >, esphome::LoopTrigger, esphome::ble_client::BLEClient, esphome::cs5460a::CS5460AComponent, esphome::mpr121::MPR121Component, esphome::tuya::Tuya, esphome::esp32_camera::ESP32Camera, esphome::xpt2046::XPT2046Component, esphome::rotary_encoder::RotaryEncoderSensor, esphome::ota::OTAComponent, esphome::ForCondition< Ts >, esphome::canbus::Canbus, esphome::deep_sleep::DeepSleepComponent, esphome::bme680_bsec::BME680BSECComponent, esphome::as3935::AS3935Component, esphome::script::QueueingScript, esphome::dsmr::Dsmr, esphome::rf_bridge::RFBridgeComponent, esphome::light::LightState, esphome::wifi_info::BSSIDWiFiInfo, esphome::pca9685::PCA9685Output, esphome::tlc59208f::TLC59208FOutput, esphome::sx1509::SX1509Component, esphome::sim800l::Sim800LComponent, esphome::ethernet::EthernetComponent, esphome::gps::GPS, esphome::midea::ApplianceBase< T >, esphome::midea::ApplianceBase< dudanov::midea::ac::AirConditioner >, esphome::tx20::Tx20Component, esphome::esp32_touch::ESP32TouchComponent, esphome::esp32_ble_server::BLEServer, esphome::binary_sensor_map::BinarySensorMap, esphome::template_::TemplateCover, esphome::vl53l0x::VL53L0XSensor, esphome::e131::E131Component, esphome::esp32_ble::ESP32BLE, esphome::globals::GlobalsComponent< T >, esphome::tlc5947::TLC5947, esphome::pn532::PN532, esphome::airthings_wave_plus::AirthingsWavePlus, esphome::total_daily_energy::TotalDailyEnergy, esphome::wifi_info::SSIDWiFiInfo, esphome::dfplayer::DFPlayer, esphome::max7219digit::MAX7219Component, esphome::sntp::SNTPComponent, esphome::my9231::MY9231OutputComponent, esphome::t6615::T6615Component, esphome::sm16716::SM16716, esphome::time::CronTrigger, esphome::ttp229_bsf::TTP229BSFComponent, esphome::api::APIServer, esphome::hbridge::HBridgeFan, esphome::teleinfo::TeleInfo, esphome::ttp229_lsf::TTP229LSFComponent, esphome::anova::Anova, esphome::esp32_improv::ESP32ImprovComponent, esphome::sm2135::SM2135, esphome::uln2003::ULN2003, esphome::slow_pwm::SlowPWMOutput, esphome::template_::TemplateSwitch, esphome::am43::Am43Component, esphome::pulse_meter::PulseMeterSensor, esphome::rc522::RC522, esphome::rtttl::Rtttl, esphome::sds011::SDS011Component, esphome::ble_client::BLESensor, esphome::gpio::GPIOBinarySensor, esphome::status_led::StatusLEDLightOutput, esphome::ble_client::BLEClientSwitch, esphome::pmsx003::PMSX003Component, esphome::captive_portal::CaptivePortal, esphome::a4988::A4988, esphome::apds9960::APDS9960, esphome::modbus::Modbus, esphome::pm1006::PM1006Component, esphome::pzem004t::PZEM004T, esphome::servo::Servo, esphome::cse7766::CSE7766Component, esphome::rdm6300::RDM6300Component, esphome::speed::SpeedFan, esphome::binary::BinaryFan, esphome::ct_clamp::CTClampSensor, esphome::hrxl_maxsonar_wr::HrxlMaxsonarWrComponent, esphome::status_led::StatusLED, esphome::endstop::EndstopCover, esphome::ezo::EZOSensor, esphome::template_::TemplateBinarySensor, esphome::time_based::TimeBasedCover, esphome::uart::UARTSwitch, esphome::wifi_info::IPAddressWiFiInfo, esphome::status::StatusBinarySensor, and esphome::debug::DebugComponent.

Definition at line 48 of file component.cpp.

mark_failed()

void esphome::Component::mark_failed ( )

virtual

Mark this component as failed.

Any future timeouts/intervals/setup/loop will no longer be called.

This might be useful if a component wants to indicate that a connection to its peripheral failed. For example, i2c based components can check if the remote device is responding and otherwise mark the component as failed. Eventually this will also enable smart status LEDs.

Reimplemented in esphome::esp32_ble::ESP32BLE.

Definition at line 101 of file component.cpp.

on_safe_shutdown()

virtual void esphome::Component::on_safe_shutdown ( )

inlinevirtual

Reimplemented in esphome::ota::OTAComponent, and esphome::waveshare_epaper::WaveshareEPaper.

Definition at line 105 of file component.h.

on_shutdown()

virtual void esphome::Component::on_shutdown ( )

inlinevirtual

Reimplemented in esphome::mqtt::MQTTClientComponent, esphome::ShutdownTrigger, esphome::esp32_touch::ESP32TouchComponent, esphome::power_supply::PowerSupply, and esphome::api::APIServer.

Definition at line 104 of file component.h.

set_component_source()

void esphome::Component::set_component_source ( const char *  source )

inline

Set where this component was loaded from for some debug messages.

This is set by the ESPHome core, and should not be called manually.

Definition at line 143 of file component.h.

set_interval() [1/2]

void esphome::Component::set_interval ( const std::string &  name, uint32_t  interval, std::function< void()> &&  f  )

protected

Set an interval function with a unique name.

Empty name means no cancelling possible.

This will call f every interval ms. Can be cancelled via CancelInterval(). Similar to javascript's setInterval().

IMPORTANT: Do not rely on this having correct timing. This is only called from loop() and therefore can be significantly delay. If you need exact timing please use hardware timers.

Parameters

name	The identifier for this interval function.
interval	The interval in ms.
f	The function (or lambda) that should be called

See also

cancel_interval()

Definition at line 50 of file component.cpp.

set_interval() [2/2]

void esphome::Component::set_interval ( uint32_t  interval, std::function< void()> &&  f  )

protected

Definition at line 119 of file component.cpp.

set_setup_priority()

void esphome::Component::set_setup_priority

(

float

priority

)

Definition at line 150 of file component.cpp.

set_timeout() [1/2]

void esphome::Component::set_timeout ( uint32_t  timeout, std::function< void()> &&  f  )

protected

Definition at line 116 of file component.cpp.

set_timeout() [2/2]

void esphome::Component::set_timeout ( const std::string &  name, uint32_t  timeout, std::function< void()> &&  f  )

protected

Set a timeout function with a unique name.

Similar to javascript's setTimeout(). Empty name means no cancelling possible.

IMPORTANT: Do not rely on this having correct timing. This is only called from loop() and therefore can be significantly delay. If you need exact timing please use hardware timers.

Parameters

name	The identifier for this timeout function.
timeout	The timeout in ms.
f	The function (or lambda) that should be called

See also

cancel_timeout()

Definition at line 58 of file component.cpp.

setup()

void esphome::Component::setup ( )

virtual

Where the component's initialization should happen.

Analogous to Arduino's setup(). This method is guaranteed to only be called once. Defaults to doing nothing.

Reimplemented in esphome::nextion::Nextion, esphome::mqtt::MQTTMessageTrigger, esphome::sensor::HeartbeatFilter, esphome::tsl2591::TSL2591Component, esphome::fastled_base::FastLEDLightOutput, esphome::wifi::WiFiComponent, esphome::mqtt::MQTTClientComponent, esphome::esp32_ble_tracker::ESP32BLETracker, esphome::canbus::CanbusTrigger, esphome::i2c::I2CComponent, esphome::st7789v::ST7789V, esphome::bme680::BME680Component, esphome::fan::FanState, esphome::binary_sensor::MultiClickTrigger, esphome::StartupTrigger, esphome::fingerprint_grow::FingerprintGrowComponent, esphome::ble_client::BLEClient, esphome::bme280::BME280Component, esphome::neopixelbus::NeoPixelBusLightOutputBase< T_METHOD, T_COLOR_FEATURE >, esphome::cs5460a::CS5460AComponent, esphome::max31856::MAX31856Sensor, esphome::tuya::Tuya, esphome::inkplate6::Inkplate6, esphome::esp32_camera::ESP32Camera, esphome::mpr121::MPR121Component, esphome::spi::SPIComponent, esphome::zyaura::ZyAuraSensor, esphome::tsl2561::TSL2561Sensor, esphome::bmp280::BMP280Component, esphome::web_server::WebServer, esphome::wifi_info::MacAddressWifiInfo, esphome::pid::PIDSimulator, esphome::rotary_encoder::RotaryEncoderSensor, esphome::uart::UARTComponent, esphome::ota::OTAComponent, esphome::canbus::Canbus, esphome::pulse_counter::PulseCounterSensor, esphome::deep_sleep::DeepSleepComponent, esphome::xpt2046::XPT2046Component, esphome::bme680_bsec::BME680BSECComponent, esphome::as3935::AS3935Component, esphome::pcd8544::PCD8544, esphome::thermostat::ThermostatClimate, esphome::ac_dimmer::AcDimmer, esphome::sgp40::SGP40Component, esphome::light::LightState, esphome::dht::DHT, esphome::pca9685::PCA9685Output, esphome::sensor::ValueRangeTrigger, esphome::st7735::ST7735, esphome::tlc59208f::TLC59208FOutput, esphome::sx1509::SX1509Component, esphome::addressable_light::AddressableLightDisplay, esphome::hmc5883l::HMC5883LComponent, esphome::tcs34725::TCS34725Component, esphome::ili9341::ILI9341Display, esphome::number::ValueRangeTrigger, esphome::ethernet::EthernetComponent, esphome::midea::ApplianceBase< T >, esphome::midea::ApplianceBase< dudanov::midea::ac::AirConditioner >, esphome::ads1115::ADS1115Component, esphome::mcp23016::MCP23016, esphome::esp32_ble_beacon::ESP32BLEBeacon, esphome::bh1750::BH1750Sensor, esphome::climate_ir::ClimateIR, esphome::esp32_ble_server::BLEServer, esphome::esp32_touch::ESP32TouchComponent, esphome::max31865::MAX31865Sensor, esphome::tx20::Tx20Component, esphome::mqtt::MQTTSensorComponent, esphome::pulse_width::PulseWidthSensor, esphome::template_::TemplateCover, esphome::mcp3008::MCP3008Sensor, esphome::pmsa003i::PMSA003IComponent, esphome::qmc5883l::QMC5883LComponent, esphome::waveshare_epaper::WaveshareEPaper, esphome::e131::E131Component, esphome::esp32_ble::ESP32BLE, esphome::sgp30::SGP30Component, esphome::gpio::GPIOSwitch, esphome::whirlpool::WhirlpoolClimate, esphome::hbridge::HBridgeLightOutput, esphome::integration::IntegrationSensor, esphome::mqtt::MQTTFanComponent, esphome::power_supply::PowerSupply, esphome::toshiba::ToshibaClimate, esphome::vl53l0x::VL53L0XSensor, esphome::adc::ADCSensor, esphome::ade7953::ADE7953, esphome::airthings_wave_plus::AirthingsWavePlus, esphome::max7219digit::MAX7219Component, esphome::sps30::SPS30Component, esphome::status_led::StatusLEDLightOutput, esphome::teleinfo::TeleInfo, esphome::esp32_improv::ESP32ImprovComponent, esphome::ledc::LEDCOutput, esphome::max7219::MAX7219Component, esphome::prometheus::PrometheusHandler, esphome::st7920::ST7920, esphome::duty_cycle::DutyCycleSensor, esphome::hbridge::HBridgeFan, esphome::hm3301::HM3301Component, esphome::mqtt::MQTTNumberComponent, esphome::mqtt::MQTTSelectComponent, esphome::pid::PIDClimateSensor, esphome::servo::Servo, esphome::tlc5947::TLC5947, esphome::anova::Anova, esphome::bang_bang::BangBangClimate, esphome::pcf8574::PCF8574Component, esphome::pn532::PN532, esphome::rc522_spi::RC522Spi, esphome::scd30::SCD30Component, esphome::ssd1306_base::SSD1306, esphome::total_daily_energy::TotalDailyEnergy, esphome::ttp229_bsf::TTP229BSFComponent, esphome::uln2003::ULN2003, esphome::api::APIServer, esphome::ccs811::CCS811Component, esphome::esp8266_pwm::ESP8266PWM, esphome::hx711::HX711Sensor, esphome::lcd_base::LCDDisplay, esphome::my9231::MY9231OutputComponent, esphome::tm1637::TM1637Display, esphome::ttp229_lsf::TTP229LSFComponent, esphome::globals::GlobalsComponent< T >, esphome::hlw8012::HLW8012Component, esphome::mqtt::MQTTBinarySensorComponent, esphome::resistance::ResistanceSensor, esphome::ultrasonic::UltrasonicSensorComponent, esphome::am43::Am43, esphome::am43::Am43Component, esphome::demo::DemoFan, esphome::mqtt::MQTTClimateComponent, esphome::pulse_meter::PulseMeterSensor, esphome::ssd1325_base::SSD1325, esphome::dallas::DallasComponent, esphome::demo::DemoCover, esphome::mcp3008::MCP3008, esphome::mqtt::MQTTJSONLightComponent, esphome::mqtt::MQTTSwitchComponent, esphome::mqtt::MQTTTextSensor, esphome::sds011::SDS011Component, esphome::sht4x::SHT4XComponent, esphome::sm16716::SM16716, esphome::as3935_spi::SPIAS3935Component, esphome::bmp085::BMP085Component, esphome::demo::DemoClimate, esphome::demo::DemoNumber, esphome::esp32_dac::ESP32DAC, esphome::pid::PIDClimate, esphome::shtcx::SHTCXComponent, esphome::max31855::MAX31855Sensor, esphome::mcp23s08::MCP23S08, esphome::mcp23s17::MCP23S17, esphome::mhz19::MHZ19Component, esphome::mqtt::MQTTCoverComponent, esphome::sm2135::SM2135, esphome::sntp::SNTPComponent, esphome::ssd1351_base::SSD1351, esphome::tm1651::TM1651Display, esphome::captive_portal::CaptivePortal, esphome::hdc1080::HDC1080Component, esphome::htu21d::HTU21DComponent, esphome::sht3xd::SHT3XDComponent, esphome::slow_pwm::SlowPWMOutput, esphome::ssd1306_spi::SPISSD1306, esphome::ssd1322_base::SSD1322, esphome::ssd1322_spi::SPISSD1322, esphome::ssd1325_spi::SPISSD1325, esphome::ssd1327_base::SSD1327, esphome::ssd1327_spi::SPISSD1327, esphome::ssd1331_spi::SPISSD1331, esphome::ssd1351_spi::SPISSD1351, esphome::a4988::A4988, esphome::gpio::GPIOBinarySensor, esphome::max6675::MAX6675Sensor, esphome::mcp23008::MCP23008, esphome::mcp23017::MCP23017, esphome::modbus::Modbus, esphome::ntc::NTC, esphome::pm1006::PM1006Component, esphome::sdp3x::SDP3XComponent, esphome::speed::SpeedFan, esphome::sx1509::SX1509FloatOutputChannel, esphome::template_::TemplateNumber, esphome::template_::TemplateSelect, esphome::yashima::YashimaClimate, esphome::atm90e32::ATM90E32Component, esphome::binary::BinaryFan, esphome::gpio::GPIOBinaryOutput, esphome::mcp4725::MCP4725, esphome::mqtt_subscribe::MQTTSubscribeSensor, esphome::mqtt_subscribe::MQTTSubscribeTextSensor, esphome::output::OutputSwitch, esphome::pn532_spi::PN532Spi, esphome::rc522::RC522, esphome::template_::TemplateSwitch, esphome::apds9960::APDS9960, esphome::ct_clamp::CTClampSensor, esphome::endstop::EndstopCover, esphome::homeassistant::HomeassistantBinarySensor, esphome::homeassistant::HomeassistantSensor, esphome::homeassistant::HomeassistantTextSensor, esphome::lcd_pcf8574::PCF8574LCDDisplay, esphome::sn74hc595::SN74HC595Component, esphome::status::StatusBinarySensor, esphome::sts3x::STS3XComponent, esphome::tmp102::TMP102Component, esphome::tuya::TuyaFan, esphome::aht10::AHT10Component, esphome::am2320::AM2320Component, esphome::demo::DemoSwitch, esphome::dht12::DHT12Component, esphome::ds1307::DS1307Component, esphome::homeassistant::HomeassistantTime, esphome::ina219::INA219Component, esphome::ina226::INA226Component, esphome::ina3221::INA3221Component, esphome::lcd_gpio::GPIOLCDDisplay, esphome::mcp9808::MCP9808Sensor, esphome::mpu6050::MPU6050Component, esphome::ms5611::MS5611Component, esphome::ssd1306_i2c::I2CSSD1306, esphome::ssd1327_i2c::I2CSSD1327, esphome::ssd1331_base::SSD1331, esphome::tca9548a::TCA9548AComponent, esphome::time_based::TimeBasedCover, esphome::tmp117::TMP117Component, esphome::tof10120::TOF10120Sensor, esphome::tuya::TuyaBinarySensor, esphome::tuya::TuyaClimate, esphome::tuya::TuyaLight, esphome::tuya::TuyaSensor, esphome::tuya::TuyaSwitch, esphome::version::VersionTextSensor, and esphome::demo::DemoBinarySensor.

Definition at line 46 of file component.cpp.

status_clear_error()

void esphome::Component::status_clear_error

(

)

Definition at line 135 of file component.cpp.

status_clear_warning()

void esphome::Component::status_clear_warning

(

)

Definition at line 134 of file component.cpp.

status_has_error()

bool esphome::Component::status_has_error

(

)

Definition at line 125 of file component.cpp.

status_has_warning()

bool esphome::Component::status_has_warning

(

)

Definition at line 124 of file component.cpp.

status_momentary_error()

void esphome::Component::status_momentary_error	(	const std::string &	name,
		uint32_t	length = 5000
	)

Definition at line 140 of file component.cpp.

status_momentary_warning()

void esphome::Component::status_momentary_warning	(	const std::string &	name,
		uint32_t	length = 5000
	)

Definition at line 136 of file component.cpp.

status_set_error()

void esphome::Component::status_set_error

(

)

Definition at line 130 of file component.cpp.

status_set_warning()

void esphome::Component::status_set_warning

(

)

Definition at line 126 of file component.cpp.

Field Documentation

component_source_

const char* esphome::Component::component_source_ = nullptr

protected

Definition at line 221 of file component.h.

component_state_

uint32_t esphome::Component::component_state_ {0x0000}

protected

State of this component.

Definition at line 219 of file component.h.

setup_priority_override_

float esphome::Component::setup_priority_override_ {NAN}

protected

Definition at line 220 of file component.h.

---

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

• /opt/build/esphome/esphome/core/component.h
• /opt/build/esphome/esphome/core/component.cpp