esphome::api::ListEntitiesIterator Class Reference

#include <list_entities.h>

Inheritance diagram for esphome::api::ListEntitiesIterator:

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

Protected Attributes
APIConnection *	client_
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 18 of file list_entities.h.

Constructor & Destructor Documentation

ListEntitiesIterator()

esphome::api::ListEntitiesIterator::ListEntitiesIterator

(

APIConnection *

client

)

Definition at line 92 of file list_entities.cpp.

Member Function Documentation

on_alarm_control_panel()

bool esphome::api::ListEntitiesIterator::on_alarm_control_panel ( alarm_control_panel::AlarmControlPanel * entity )

override

on_binary_sensor()

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

override

on_button()

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

override

on_camera()

bool esphome::api::ListEntitiesIterator::on_camera ( camera::Camera * entity )

overridevirtual

Reimplemented from esphome::ComponentIterator.

on_climate()

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

override

on_cover()

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

override

on_date()

bool esphome::api::ListEntitiesIterator::on_date ( datetime::DateEntity * entity )

override

on_datetime()

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

override

on_end()

ListEntitiesCoverResponse ListEntitiesLightResponse ListEntitiesSwitchResponse ListEntitiesTextSensorResponse ListEntitiesValveResponse ListEntitiesClimateResponse ListEntitiesDateResponse ListEntitiesDateTimeResponse ListEntitiesSelectResponse ListEntitiesAlarmControlPanelResponse ListEntitiesInfraredResponse ListEntitiesUpdateResponse bool esphome::api::ListEntitiesIterator::on_end ( )

overridevirtual

Reimplemented from esphome::ComponentIterator.

Definition at line 90 of file list_entities.cpp.

on_event()

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

override

on_fan()

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

override

on_infrared()

bool esphome::api::ListEntitiesIterator::on_infrared ( infrared::Infrared * entity )

override

on_light()

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

override

on_lock()

bool esphome::api::ListEntitiesIterator::on_lock ( lock::Lock * entity )

override

on_media_player()

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

override

on_number()

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

override

on_select()

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

override

on_sensor()

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

override

on_service()

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

overridevirtual

Reimplemented from esphome::ComponentIterator.

Definition at line 95 of file list_entities.cpp.

on_switch()

bool esphome::api::ListEntitiesIterator::on_switch ( switch_::Switch * entity )

override

on_text()

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

override

on_text_sensor()

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

override

on_time()

bool esphome::api::ListEntitiesIterator::on_time ( datetime::TimeEntity * entity )

override

on_update()

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

override

on_valve()

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

override

on_water_heater()

bool esphome::api::ListEntitiesIterator::on_water_heater ( water_heater::WaterHeater * entity )

override

Field Documentation

client_

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

protected

Definition at line 99 of file list_entities.h.

---

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

• esphome/components/api/list_entities.h
• esphome/components/api/list_entities.cpp