ESPHome 2026.5.0-dev
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
esphome::web_server::ListEntitiesIterator Class Referencefinal

#include <list_entities.h>

Inheritance diagram for esphome::web_server::ListEntitiesIterator:
esphome::ComponentIterator

Public Member Functions

 ListEntitiesIterator (const WebServer *ws, esphome::web_server_idf::AsyncEventSource *es)
 
 ListEntitiesIterator (const WebServer *ws, DeferredUpdateEventSource *es)
 
bool on_binary_sensor (binary_sensor::BinarySensor *obj) override
 
bool on_cover (cover::Cover *obj) override
 
bool on_fan (fan::Fan *obj) override
 
bool on_light (light::LightState *obj) override
 
bool on_sensor (sensor::Sensor *obj) override
 
bool on_switch (switch_::Switch *obj) override
 
bool on_button (button::Button *obj) override
 
bool on_text_sensor (text_sensor::TextSensor *obj) override
 
bool on_climate (climate::Climate *obj) override
 
bool on_number (number::Number *obj) override
 
bool on_date (datetime::DateEntity *obj) override
 
bool on_time (datetime::TimeEntity *obj) override
 
bool on_datetime (datetime::DateTimeEntity *obj) override
 
bool on_text (text::Text *obj) override
 
bool on_select (select::Select *obj) override
 
bool on_lock (lock::Lock *obj) override
 
bool on_valve (valve::Valve *obj) override
 
bool on_media_player (media_player::MediaPlayer *obj) override
 
bool on_alarm_control_panel (alarm_control_panel::AlarmControlPanel *obj) override
 
bool on_water_heater (water_heater::WaterHeater *obj) override
 
bool on_infrared (infrared::Infrared *obj) override
 
bool on_event (event::Event *obj) override
 
bool on_update (update::UpdateEntity *obj) override
 
bool completed ()
 
- Public Member Functions inherited from esphome::ComponentIterator
void begin (bool include_internal=false)
 
void advance ()
 
bool completed () const
 
virtual bool on_begin ()
 
virtual bool on_service (api::UserServiceDescriptor *service)
 
virtual bool on_camera (camera::Camera *camera)
 
virtual bool on_end ()
 

Protected Attributes

const WebServer * web_server_
 
esphome::web_server_idf::AsyncEventSource * events_
 
DeferredUpdateEventSource * events_
 
- Protected Attributes inherited from esphome::ComponentIterator
uint16_t at_ {0}
 
IteratorState state_ {IteratorState::NONE}
 
bool include_internal_ {false}
 

Additional Inherited Members

- Protected Types inherited from esphome::ComponentIterator
enum class  IteratorState : uint8_t {
  NONE = 0 , BEGIN , ENTITY_TYPE_ , ENTITY_CONTROLLER_TYPE_ ,
  SERVICE , CAMERA , MAX
}
 
- Protected Member Functions inherited from esphome::ComponentIterator
template<typename Container >
void process_platform_item_ (const Container &items, bool(ComponentIterator::*on_item)(typename Container::value_type))
 
void advance_platform_ ()
 

Detailed Description

Definition at line 20 of file list_entities.h.

Constructor & Destructor Documentation

◆ ListEntitiesIterator() [1/2]

esphome::web_server::ListEntitiesIterator::ListEntitiesIterator ( const WebServer * ws,
esphome::web_server_idf::AsyncEventSource * es )

◆ ListEntitiesIterator() [2/2]

esphome::web_server::ListEntitiesIterator::ListEntitiesIterator ( const WebServer * ws,
DeferredUpdateEventSource * es )

Definition at line 14 of file list_entities.cpp.

Member Function Documentation

◆ completed()

bool esphome::web_server::ListEntitiesIterator::completed ( )
inline

Definition at line 96 of file list_entities.h.

◆ on_alarm_control_panel()

bool esphome::web_server::ListEntitiesIterator::on_alarm_control_panel ( alarm_control_panel::AlarmControlPanel * obj)
override

Definition at line 129 of file list_entities.cpp.

◆ on_binary_sensor()

bool esphome::web_server::ListEntitiesIterator::on_binary_sensor ( binary_sensor::BinarySensor * obj)
override

Definition at line 18 of file list_entities.cpp.

◆ on_button()

bool esphome::web_server::ListEntitiesIterator::on_button ( button::Button * obj)
override

Definition at line 54 of file list_entities.cpp.

◆ on_climate()

bool esphome::web_server::ListEntitiesIterator::on_climate ( climate::Climate * obj)
override

Definition at line 80 of file list_entities.cpp.

◆ on_cover()

bool esphome::web_server::ListEntitiesIterator::on_cover ( cover::Cover * obj)
override

Definition at line 24 of file list_entities.cpp.

◆ on_date()

bool esphome::web_server::ListEntitiesIterator::on_date ( datetime::DateEntity * obj)
override

Definition at line 94 of file list_entities.cpp.

◆ on_datetime()

bool esphome::web_server::ListEntitiesIterator::on_datetime ( datetime::DateTimeEntity * obj)
override

Definition at line 108 of file list_entities.cpp.

◆ on_event()

bool esphome::web_server::ListEntitiesIterator::on_event ( event::Event * obj)
override

Definition at line 150 of file list_entities.cpp.

◆ on_fan()

bool esphome::web_server::ListEntitiesIterator::on_fan ( fan::Fan * obj)
override

Definition at line 30 of file list_entities.cpp.

◆ on_infrared()

bool esphome::web_server::ListEntitiesIterator::on_infrared ( infrared::Infrared * obj)
override

Definition at line 143 of file list_entities.cpp.

◆ on_light()

bool esphome::web_server::ListEntitiesIterator::on_light ( light::LightState * obj)
override

Definition at line 36 of file list_entities.cpp.

◆ on_lock()

bool esphome::web_server::ListEntitiesIterator::on_lock ( lock::Lock * obj)
override

Definition at line 66 of file list_entities.cpp.

◆ on_media_player()

bool esphome::web_server::ListEntitiesIterator::on_media_player ( media_player::MediaPlayer * obj)
inlineoverride

Definition at line 79 of file list_entities.h.

◆ on_number()

bool esphome::web_server::ListEntitiesIterator::on_number ( number::Number * obj)
override

Definition at line 87 of file list_entities.cpp.

◆ on_select()

bool esphome::web_server::ListEntitiesIterator::on_select ( select::Select * obj)
override

Definition at line 122 of file list_entities.cpp.

◆ on_sensor()

bool esphome::web_server::ListEntitiesIterator::on_sensor ( sensor::Sensor * obj)
override

Definition at line 42 of file list_entities.cpp.

◆ on_switch()

bool esphome::web_server::ListEntitiesIterator::on_switch ( switch_::Switch * obj)
override

Definition at line 48 of file list_entities.cpp.

◆ on_text()

bool esphome::web_server::ListEntitiesIterator::on_text ( text::Text * obj)
override

Definition at line 115 of file list_entities.cpp.

◆ on_text_sensor()

bool esphome::web_server::ListEntitiesIterator::on_text_sensor ( text_sensor::TextSensor * obj)
override

Definition at line 60 of file list_entities.cpp.

◆ on_time()

bool esphome::web_server::ListEntitiesIterator::on_time ( datetime::TimeEntity * obj)
override

Definition at line 101 of file list_entities.cpp.

◆ on_update()

bool esphome::web_server::ListEntitiesIterator::on_update ( update::UpdateEntity * obj)
override

Definition at line 158 of file list_entities.cpp.

◆ on_valve()

bool esphome::web_server::ListEntitiesIterator::on_valve ( valve::Valve * obj)
override

Definition at line 73 of file list_entities.cpp.

◆ on_water_heater()

bool esphome::web_server::ListEntitiesIterator::on_water_heater ( water_heater::WaterHeater * obj)
override

Definition at line 136 of file list_entities.cpp.

Field Documentation

◆ events_ [1/2]

esphome::web_server_idf::AsyncEventSource* esphome::web_server::ListEntitiesIterator::events_
protected

Definition at line 101 of file list_entities.h.

◆ events_ [2/2]

DeferredUpdateEventSource* esphome::web_server::ListEntitiesIterator::events_
protected

Definition at line 103 of file list_entities.h.

◆ web_server_

const WebServer* esphome::web_server::ListEntitiesIterator::web_server_
protected

Definition at line 99 of file list_entities.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.12.0