ESPHome 2025.5.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
esphome::api::ListEntitiesIterator Class Reference

#include <list_entities.h>

Inheritance diagram for esphome::api::ListEntitiesIterator:
esphome::ComponentIterator

Public Member Functions

 ListEntitiesIterator (APIConnection *client)
 
bool on_binary_sensor (binary_sensor::BinarySensor *binary_sensor) override
 
bool on_cover (cover::Cover *cover) override
 
bool on_fan (fan::Fan *fan) override
 
bool on_light (light::LightState *light) override
 
bool on_sensor (sensor::Sensor *sensor) override
 
bool on_switch (switch_::Switch *a_switch) override
 
bool on_button (button::Button *button) override
 
bool on_text_sensor (text_sensor::TextSensor *text_sensor) override
 
bool on_service (UserServiceDescriptor *service) override
 
bool on_camera (esp32_camera::ESP32Camera *camera) override
 
bool on_climate (climate::Climate *climate) override
 
bool on_number (number::Number *number) override
 
bool on_date (datetime::DateEntity *date) override
 
bool on_time (datetime::TimeEntity *time) override
 
bool on_datetime (datetime::DateTimeEntity *datetime) override
 
bool on_text (text::Text *text) override
 
bool on_select (select::Select *select) override
 
bool on_lock (lock::Lock *a_lock) override
 
bool on_valve (valve::Valve *valve) override
 
bool on_media_player (media_player::MediaPlayer *media_player) override
 
bool on_alarm_control_panel (alarm_control_panel::AlarmControlPanel *a_alarm_control_panel) override
 
bool on_event (event::Event *event) override
 
bool on_update (update::UpdateEntity *update) override
 
bool on_end () override
 
bool completed ()
 
- Public Member Functions inherited from esphome::ComponentIterator
void begin (bool include_internal=false)
 
void advance ()
 
virtual bool on_begin ()
 

Protected Attributes

APIConnection * client_
 
- Protected Attributes inherited from esphome::ComponentIterator
enum esphome::ComponentIterator::IteratorState NONE
 
size_t at_ {0}
 
bool include_internal_ {false}
 

Additional Inherited Members

- Protected Types inherited from esphome::ComponentIterator
enum class  IteratorState {
  NONE = 0 , BEGIN , BINARY_SENSOR , COVER ,
  FAN , LIGHT , SENSOR , SWITCH ,
  BUTTON , TEXT_SENSOR , SERVICE , CAMERA ,
  CLIMATE , NUMBER , DATETIME_DATE , DATETIME_TIME ,
  DATETIME_DATETIME , TEXT , SELECT , LOCK ,
  VALVE , MEDIA_PLAYER , ALARM_CONTROL_PANEL , EVENT ,
  UPDATE , MAX
}
 

Detailed Description

Definition at line 12 of file list_entities.h.

Constructor & Destructor Documentation

◆ ListEntitiesIterator()

esphome::api::ListEntitiesIterator::ListEntitiesIterator ( APIConnection * client)

Definition at line 73 of file list_entities.cpp.

Member Function Documentation

◆ completed()

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

Definition at line 83 of file list_entities.h.

◆ on_alarm_control_panel()

bool esphome::api::ListEntitiesIterator::on_alarm_control_panel ( alarm_control_panel::AlarmControlPanel * a_alarm_control_panel)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 142 of file list_entities.cpp.

◆ on_binary_sensor()

bool esphome::api::ListEntitiesIterator::on_binary_sensor ( binary_sensor::BinarySensor * binary_sensor)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 12 of file list_entities.cpp.

◆ on_button()

bool esphome::api::ListEntitiesIterator::on_button ( button::Button * button)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 48 of file list_entities.cpp.

◆ on_camera()

bool esphome::api::ListEntitiesIterator::on_camera ( esp32_camera::ESP32Camera * camera)
overridevirtual

Reimplemented from esphome::ComponentIterator.

Definition at line 80 of file list_entities.cpp.

◆ on_climate()

bool esphome::api::ListEntitiesIterator::on_climate ( climate::Climate * climate)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 87 of file list_entities.cpp.

◆ on_cover()

bool esphome::api::ListEntitiesIterator::on_cover ( cover::Cover * cover)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 18 of file list_entities.cpp.

◆ on_date()

bool esphome::api::ListEntitiesIterator::on_date ( datetime::DateEntity * date)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 101 of file list_entities.cpp.

◆ on_datetime()

bool esphome::api::ListEntitiesIterator::on_datetime ( datetime::DateTimeEntity * datetime)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 115 of file list_entities.cpp.

◆ on_end()

bool esphome::api::ListEntitiesIterator::on_end ( )
overridevirtual

Reimplemented from esphome::ComponentIterator.

Definition at line 72 of file list_entities.cpp.

◆ on_event()

bool esphome::api::ListEntitiesIterator::on_event ( event::Event * event)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 148 of file list_entities.cpp.

◆ on_fan()

bool esphome::api::ListEntitiesIterator::on_fan ( fan::Fan * fan)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 24 of file list_entities.cpp.

◆ on_light()

bool esphome::api::ListEntitiesIterator::on_light ( light::LightState * light)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 30 of file list_entities.cpp.

◆ on_lock()

bool esphome::api::ListEntitiesIterator::on_lock ( lock::Lock * a_lock)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 60 of file list_entities.cpp.

◆ on_media_player()

bool esphome::api::ListEntitiesIterator::on_media_player ( media_player::MediaPlayer * media_player)
overridevirtual

Reimplemented from esphome::ComponentIterator.

Definition at line 136 of file list_entities.cpp.

◆ on_number()

bool esphome::api::ListEntitiesIterator::on_number ( number::Number * number)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 94 of file list_entities.cpp.

◆ on_select()

bool esphome::api::ListEntitiesIterator::on_select ( select::Select * select)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 129 of file list_entities.cpp.

◆ on_sensor()

bool esphome::api::ListEntitiesIterator::on_sensor ( sensor::Sensor * sensor)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 36 of file list_entities.cpp.

◆ on_service()

bool esphome::api::ListEntitiesIterator::on_service ( UserServiceDescriptor * service)
overridevirtual

Reimplemented from esphome::ComponentIterator.

Definition at line 74 of file list_entities.cpp.

◆ on_switch()

bool esphome::api::ListEntitiesIterator::on_switch ( switch_::Switch * a_switch)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 42 of file list_entities.cpp.

◆ on_text()

bool esphome::api::ListEntitiesIterator::on_text ( text::Text * text)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 122 of file list_entities.cpp.

◆ on_text_sensor()

bool esphome::api::ListEntitiesIterator::on_text_sensor ( text_sensor::TextSensor * text_sensor)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 54 of file list_entities.cpp.

◆ on_time()

bool esphome::api::ListEntitiesIterator::on_time ( datetime::TimeEntity * time)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 108 of file list_entities.cpp.

◆ on_update()

bool esphome::api::ListEntitiesIterator::on_update ( update::UpdateEntity * update)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 154 of file list_entities.cpp.

◆ on_valve()

bool esphome::api::ListEntitiesIterator::on_valve ( valve::Valve * valve)
overridevirtual

Implements esphome::ComponentIterator.

Definition at line 66 of file list_entities.cpp.

Field Documentation

◆ client_

APIConnection* esphome::api::ListEntitiesIterator::client_
protected

Definition at line 86 of file list_entities.h.

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