#include <api_server.h>

Inheritance diagram for esphome::api::APIServer:

Data Structures
struct	ActiveActionCall

struct	HomeAssistantStateSubscription

struct	PendingActionResponse

Public Types
using	ActionResponseCallback = std::function<void(const class ActionResponse &)>

Public Member Functions
	APIServer ()

void	setup () override

uint16_t	get_port () const

float	get_setup_priority () const override

void	loop () override

void	dump_config () override

void	on_shutdown () override

bool	teardown () override

void	on_log (uint8_t level, const char tag, const char message, size_t message_len) override

void	on_camera_image (const std::shared_ptr< camera::CameraImage > &image) override

void	set_port (uint16_t port)

void	set_reboot_timeout (uint32_t reboot_timeout)

void	set_batch_delay (uint16_t batch_delay)

uint16_t	get_batch_delay () const

void	set_listen_backlog (uint8_t listen_backlog)

void	set_max_connections (uint8_t max_connections)

std::vector< uint8_t > &	get_shared_buffer_ref ()

bool	save_noise_psk (psk_t psk, bool make_active=true)

bool	clear_noise_psk (bool make_active=true)

void	set_noise_psk (psk_t psk)

APINoiseContext &	get_noise_ctx ()

void	handle_disconnect (APIConnection *conn)

void	on_binary_sensor_update (binary_sensor::BinarySensor *obj) override

void	on_cover_update (cover::Cover *obj) override

void	on_fan_update (fan::Fan *obj) override

void	on_light_update (light::LightState *obj) override

void	on_sensor_update (sensor::Sensor *obj) override

void	on_switch_update (switch_::Switch *obj) override

void	on_text_sensor_update (text_sensor::TextSensor *obj) override

void	on_climate_update (climate::Climate *obj) override

void	on_number_update (number::Number *obj) override

void	on_date_update (datetime::DateEntity *obj) override

void	on_time_update (datetime::TimeEntity *obj) override

void	on_datetime_update (datetime::DateTimeEntity *obj) override

void	on_text_update (text::Text *obj) override

void	on_select_update (select::Select *obj) override

void	on_lock_update (lock::Lock *obj) override

void	on_valve_update (valve::Valve *obj) override

void	on_media_player_update (media_player::MediaPlayer *obj) override

void	on_water_heater_update (water_heater::WaterHeater *obj) override

void	send_homeassistant_action (const HomeassistantActionRequest &call)

void	register_action_response_callback (uint32_t call_id, ActionResponseCallback callback)

void	handle_action_response (uint32_t call_id, bool success, StringRef error_message)

void	handle_action_response (uint32_t call_id, bool success, StringRef error_message, const uint8_t *response_data, size_t response_data_len)

void	initialize_user_services (std::initializer_list< UserServiceDescriptor * > services)

void	register_user_service (UserServiceDescriptor *descriptor)

uint32_t	register_active_action_call (uint32_t client_call_id, APIConnection *conn)

void	unregister_active_action_call (uint32_t action_call_id)

void	unregister_active_action_calls_for_connection (APIConnection *conn)

void	send_action_response (uint32_t action_call_id, bool success, StringRef error_message)

void	send_action_response (uint32_t action_call_id, bool success, StringRef error_message, const uint8_t *response_data, size_t response_data_len)

void	request_time ()

void	on_alarm_control_panel_update (alarm_control_panel::AlarmControlPanel *obj) override

void	on_event (event::Event *obj) override

void	on_update (update::UpdateEntity *obj) override

void	on_zwave_proxy_request (const esphome::api::ProtoMessage &msg)

void	send_infrared_rf_receive_event (uint32_t device_id, uint32_t key, const std::vector< int32_t > *timings)

bool	is_connected (bool state_subscription_only=false) const

void	subscribe_home_assistant_state (const char entity_id, const char attribute, std::function< void(StringRef)> f)

void	get_home_assistant_state (const char entity_id, const char attribute, std::function< void(StringRef)> f)

void	subscribe_home_assistant_state (std::string entity_id, optional< std::string > attribute, std::function< void(StringRef)> f)

void	get_home_assistant_state (std::string entity_id, optional< std::string > attribute, std::function< void(StringRef)> f)

void	subscribe_home_assistant_state (std::string entity_id, optional< std::string > attribute, std::function< void(const std::string &)> f)

void	get_home_assistant_state (std::string entity_id, optional< std::string > attribute, std::function< void(const std::string &)> f)

const std::vector< HomeAssistantStateSubscription > &	get_state_subs () const

const std::vector< UserServiceDescriptor * > &	get_user_services () const

Trigger< std::string, std::string > *	get_client_connected_trigger ()

Trigger< std::string, std::string > *	get_client_disconnected_trigger ()

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_safe_shutdown ()

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

virtual void	mark_failed ()
	Mark this component as failed.

	ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error ()

	ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

void	set_component_source (const LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Public Member Functions inherited from esphome::Controller
Public Member Functions inherited from esphome::logger::LogListener
Public Member Functions inherited from esphome::camera::CameraListener
virtual void	on_stream_start ()

virtual void	on_stream_stop ()

Protected Member Functions
void	__attribute__ ((noinline)) accept_new_connections_()

void	__attribute__ ((noinline)) remove_client_(size_t client_index)

bool	update_noise_psk_ (const SavedNoisePsk &new_psk, const LogString save_log_msg, const LogString fail_log_msg, const psk_t &active_psk, bool make_active)

void	add_state_subscription_ (const char entity_id, const char attribute, std::function< void(StringRef)> f, bool once)

void	add_state_subscription_ (std::string entity_id, optional< std::string > attribute, std::function< void(StringRef)> f, bool once)

void	add_state_subscription_ (std::string entity_id, optional< std::string > attribute, std::function< void(const std::string &)> f, bool once)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

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

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id

	ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time

ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)

	ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

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

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (uint32_t id)

Protected Attributes
std::unique_ptr< socket::Socket >	socket_ = nullptr

Trigger< std::string, std::string >	client_connected_trigger_

Trigger< std::string, std::string >	client_disconnected_trigger_

uint32_t	reboot_timeout_ {300000}

uint32_t	last_connected_ {0}

std::vector< std::unique_ptr< APIConnection > >	clients_

std::vector< uint8_t >	shared_write_buffer_

std::vector< HomeAssistantStateSubscription >	state_subs_

std::vector< UserServiceDescriptor * >	user_services_

std::vector< ActiveActionCall >	active_action_calls_

uint32_t	next_action_call_id_ {1}

std::vector< PendingActionResponse >	action_response_callbacks_

uint16_t	port_ {6053}

uint16_t	batch_delay_ {100}

uint8_t	listen_backlog_ {4}

uint8_t	max_connections_ {8}

bool	shutting_down_ = false

APINoiseContext	noise_ctx_

ESPPreferenceObject	noise_pref_

Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi	set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo	cancel_interval )(const char *name)
	Cancel an interval function.

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t	initial_wait_time

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t	max_attempts

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint32_t	initial_wait_time

uint32_t uint8_t	max_attempts

uint32_t uint8_t std::function< RetryResult(uint8_t)> &&	f

uint32_t uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

uint8_t	max_attempts

uint8_t std::function< RetryResult(uint8_t)> &&	f

uint8_t std::function< RetryResult(uint8_t)> float	backoff_increase_factor = 1.0f)

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi	set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo	cancel_timeout )(const char *name)
	Cancel a timeout function.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi	defer )(const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo	cancel_defer )(const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Detailed Description

Definition at line 38 of file api_server.h.

Member Typedef Documentation

◆ ActionResponseCallback

using esphome::api::APIServer::ActionResponseCallback = std::function<void(const class ActionResponse &)>

Definition at line 141 of file api_server.h.

Constructor & Destructor Documentation

◆ APIServer()

esphome::api::APIServer::APIServer ( )

Definition at line 31 of file api_server.cpp.

Member Function Documentation

◆ attribute() [1/2]

void esphome::api::APIServer::__attribute__ ( (noinline) )

protected

◆ attribute() [2/2]

void esphome::api::APIServer::__attribute__ ( (noinline) )

protected

◆ add_state_subscription_() [1/3]

void esphome::api::APIServer::add_state_subscription_	(	const char *	entity_id,
		const char *	attribute,
		std::function< void(StringRef)>	f,
		bool	once )

protected

Definition at line 436 of file api_server.cpp.

◆ add_state_subscription_() [2/3]

void esphome::api::APIServer::add_state_subscription_	(	std::string	entity_id,
		optional< std::string >	attribute,
		std::function< void(const std::string &)>	f,
		bool	once )

protected

Definition at line 487 of file api_server.cpp.

◆ add_state_subscription_() [3/3]

void esphome::api::APIServer::add_state_subscription_	(	std::string	entity_id,
		optional< std::string >	attribute,
		std::function< void(StringRef)>	f,
		bool	once )

protected

Definition at line 445 of file api_server.cpp.

◆ clear_noise_psk()

bool esphome::api::APIServer::clear_noise_psk ( bool make_active = true )

Definition at line 559 of file api_server.cpp.

◆ dump_config()

void esphome::api::APIServer::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 236 of file api_server.cpp.

◆ get_batch_delay()

uint16_t esphome::api::APIServer::get_batch_delay ( ) const

inline

Definition at line 67 of file api_server.h.

◆ get_client_connected_trigger()

Trigger< std::string, std::string > * esphome::api::APIServer::get_client_connected_trigger ( )

inline

Definition at line 230 of file api_server.h.

◆ get_client_disconnected_trigger()

Trigger< std::string, std::string > * esphome::api::APIServer::get_client_disconnected_trigger ( )

inline

Definition at line 233 of file api_server.h.

◆ get_home_assistant_state() [1/3]

void esphome::api::APIServer::get_home_assistant_state	(	const char *	entity_id,
		const char *	attribute,
		std::function< void(StringRef)>	f )

Definition at line 470 of file api_server.cpp.

◆ get_home_assistant_state() [2/3]

void esphome::api::APIServer::get_home_assistant_state	(	std::string	entity_id,
		optional< std::string >	attribute,
		std::function< void(const std::string &)>	f )

Definition at line 501 of file api_server.cpp.

◆ get_home_assistant_state() [3/3]

void esphome::api::APIServer::get_home_assistant_state	(	std::string	entity_id,
		optional< std::string >	attribute,
		std::function< void(StringRef)>	f )

Definition at line 481 of file api_server.cpp.

◆ get_noise_ctx()

APINoiseContext & esphome::api::APIServer::get_noise_ctx ( )

inline

Definition at line 78 of file api_server.h.

◆ get_port()

uint16_t esphome::api::APIServer::get_port ( ) const

Definition at line 511 of file api_server.cpp.

◆ get_setup_priority()

float esphome::api::APIServer::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

◆ get_shared_buffer_ref()

std::vector< uint8_t > & esphome::api::APIServer::get_shared_buffer_ref ( )

inline

Definition at line 72 of file api_server.h.

◆ get_state_subs()

const std::vector< APIServer::HomeAssistantStateSubscription > & esphome::api::APIServer::get_state_subs ( ) const

Definition at line 506 of file api_server.cpp.

◆ get_user_services()

const std::vector< UserServiceDescriptor * > & esphome::api::APIServer::get_user_services ( ) const

inline

Definition at line 226 of file api_server.h.

◆ handle_action_response() [1/2]

void esphome::api::APIServer::handle_action_response	(	uint32_t	call_id,
		bool	success,
		StringRef	error_message )

Definition at line 406 of file api_server.cpp.

◆ handle_action_response() [2/2]

void esphome::api::APIServer::handle_action_response	(	uint32_t	call_id,
		bool	success,
		StringRef	error_message,
		const uint8_t *	response_data,
		size_t	response_data_len )

Definition at line 418 of file api_server.cpp.

◆ handle_disconnect()

void esphome::api::APIServer::handle_disconnect ( APIConnection * conn )

Definition at line 253 of file api_server.cpp.

◆ initialize_user_services()

void esphome::api::APIServer::initialize_user_services ( std::initializer_list< UserServiceDescriptor * > services )

inline

Definition at line 151 of file api_server.h.

◆ is_connected()

bool esphome::api::APIServer::is_connected ( bool state_subscription_only = false ) const

Definition at line 585 of file api_server.cpp.

◆ loop()

void esphome::api::APIServer::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 117 of file api_server.cpp.

◆ on_alarm_control_panel_update()

void esphome::api::APIServer::on_alarm_control_panel_update ( alarm_control_panel::AlarmControlPanel * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_binary_sensor_update()

void esphome::api::APIServer::on_binary_sensor_update ( binary_sensor::BinarySensor * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_camera_image()

void esphome::api::APIServer::on_camera_image ( const std::shared_ptr< camera::CameraImage > & image )

overridevirtual

Reimplemented from esphome::camera::CameraListener.

Definition at line 614 of file api_server.cpp.

◆ on_climate_update()

void esphome::api::APIServer::on_climate_update ( climate::Climate * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_cover_update()

void esphome::api::APIServer::on_cover_update ( cover::Cover * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_date_update()

void esphome::api::APIServer::on_date_update ( datetime::DateEntity * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_datetime_update()

void esphome::api::APIServer::on_datetime_update ( datetime::DateTimeEntity * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_event()

void esphome::api::APIServer::on_event ( event::Event * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_fan_update()

void esphome::api::APIServer::on_fan_update ( fan::Fan * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_light_update()

void esphome::api::APIServer::on_light_update ( light::LightState * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_lock_update()

void esphome::api::APIServer::on_lock_update ( lock::Lock * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_log()

void esphome::api::APIServer::on_log	(	uint8_t	level,
		const char *	tag,
		const char *	message,
		size_t	message_len )

overridevirtual

Implements esphome::logger::LogListener.

Definition at line 599 of file api_server.cpp.

◆ on_media_player_update()

void esphome::api::APIServer::on_media_player_update ( media_player::MediaPlayer * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_number_update()

void esphome::api::APIServer::on_number_update ( number::Number * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_select_update()

void esphome::api::APIServer::on_select_update ( select::Select * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_sensor_update()

void esphome::api::APIServer::on_sensor_update ( sensor::Sensor * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_shutdown()

void esphome::api::APIServer::on_shutdown ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 622 of file api_server.cpp.

◆ on_switch_update()

void esphome::api::APIServer::on_switch_update ( switch_::Switch * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_text_sensor_update()

void esphome::api::APIServer::on_text_sensor_update ( text_sensor::TextSensor * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_text_update()

void esphome::api::APIServer::on_text_update ( text::Text * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_time_update()

void esphome::api::APIServer::on_time_update ( datetime::TimeEntity * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_update()

void esphome::api::APIServer::on_update ( update::UpdateEntity * obj )

overridevirtual

Reimplemented from esphome::Controller.

Definition at line 351 of file api_server.cpp.

◆ on_valve_update()

void esphome::api::APIServer::on_valve_update ( valve::Valve * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_water_heater_update()

void esphome::api::APIServer::on_water_heater_update ( water_heater::WaterHeater * obj )

overridevirtual

Reimplemented from esphome::Controller.

◆ on_zwave_proxy_request()

void esphome::api::APIServer::on_zwave_proxy_request ( const esphome::api::ProtoMessage & msg )

Definition at line 362 of file api_server.cpp.

◆ register_action_response_callback()

void esphome::api::APIServer::register_action_response_callback	(	uint32_t	call_id,
		ActionResponseCallback	callback )

Definition at line 402 of file api_server.cpp.

◆ register_active_action_call()

uint32_t esphome::api::APIServer::register_active_action_call	(	uint32_t	client_call_id,
		APIConnection *	conn )

Definition at line 663 of file api_server.cpp.

◆ register_user_service()

void esphome::api::APIServer::register_user_service ( UserServiceDescriptor * descriptor )

inline

Definition at line 156 of file api_server.h.

◆ request_time()

void esphome::api::APIServer::request_time ( )

Definition at line 575 of file api_server.cpp.

◆ save_noise_psk()

bool esphome::api::APIServer::save_noise_psk	(	psk_t	psk,
		bool	make_active = true )

Definition at line 541 of file api_server.cpp.

◆ send_action_response() [1/2]

void esphome::api::APIServer::send_action_response	(	uint32_t	action_call_id,
		bool	success,
		StringRef	error_message )

Definition at line 711 of file api_server.cpp.

◆ send_action_response() [2/2]

void esphome::api::APIServer::send_action_response	(	uint32_t	action_call_id,
		bool	success,
		StringRef	error_message,
		const uint8_t *	response_data,
		size_t	response_data_len )

Definition at line 721 of file api_server.cpp.

◆ send_homeassistant_action()

void esphome::api::APIServer::send_homeassistant_action ( const HomeassistantActionRequest & call )

Definition at line 396 of file api_server.cpp.

◆ send_infrared_rf_receive_event()

void esphome::api::APIServer::send_infrared_rf_receive_event	(	uint32_t	device_id,
		uint32_t	key,
		const std::vector< int32_t > *	timings )

Definition at line 371 of file api_server.cpp.

◆ set_batch_delay()

void esphome::api::APIServer::set_batch_delay ( uint16_t batch_delay )

Definition at line 393 of file api_server.cpp.

◆ set_listen_backlog()

void esphome::api::APIServer::set_listen_backlog ( uint8_t listen_backlog )

inline

Definition at line 68 of file api_server.h.

◆ set_max_connections()

void esphome::api::APIServer::set_max_connections ( uint8_t max_connections )

inline

Definition at line 69 of file api_server.h.

◆ set_noise_psk()

void esphome::api::APIServer::set_noise_psk ( psk_t psk )

inline

Definition at line 77 of file api_server.h.

◆ set_port()

void esphome::api::APIServer::set_port ( uint16_t port )

◆ set_reboot_timeout()

void esphome::api::APIServer::set_reboot_timeout ( uint32_t reboot_timeout )

Definition at line 513 of file api_server.cpp.

◆ setup()

void esphome::api::APIServer::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 37 of file api_server.cpp.

◆ subscribe_home_assistant_state() [1/3]

void esphome::api::APIServer::subscribe_home_assistant_state	(	const char *	entity_id,
		const char *	attribute,
		std::function< void(StringRef)>	f )

Definition at line 465 of file api_server.cpp.

◆ subscribe_home_assistant_state() [2/3]

void esphome::api::APIServer::subscribe_home_assistant_state	(	std::string	entity_id,
		optional< std::string >	attribute,
		std::function< void(const std::string &)>	f )

Definition at line 496 of file api_server.cpp.

◆ subscribe_home_assistant_state() [3/3]

void esphome::api::APIServer::subscribe_home_assistant_state	(	std::string	entity_id,
		optional< std::string >	attribute,
		std::function< void(StringRef)>	f )

Definition at line 476 of file api_server.cpp.

◆ teardown()

bool esphome::api::APIServer::teardown ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 645 of file api_server.cpp.

◆ unregister_active_action_call()

void esphome::api::APIServer::unregister_active_action_call ( uint32_t action_call_id )

Definition at line 681 of file api_server.cpp.

◆ unregister_active_action_calls_for_connection()

void esphome::api::APIServer::unregister_active_action_calls_for_connection ( APIConnection * conn )

Definition at line 695 of file api_server.cpp.

◆ update_noise_psk_()

bool esphome::api::APIServer::update_noise_psk_	(	const SavedNoisePsk &	new_psk,
		const LogString *	save_log_msg,
		const LogString *	fail_log_msg,
		const psk_t &	active_psk,
		bool	make_active )

protected

Definition at line 516 of file api_server.cpp.

Field Documentation

◆ action_response_callbacks_

std::vector<PendingActionResponse> esphome::api::APIServer::action_response_callbacks_

protected

Definition at line 294 of file api_server.h.

◆ active_action_calls_

std::vector<ActiveActionCall> esphome::api::APIServer::active_action_calls_

protected

Definition at line 285 of file api_server.h.

◆ batch_delay_

uint16_t esphome::api::APIServer::batch_delay_ {100}

protected

Definition at line 299 of file api_server.h.

◆ client_connected_trigger_

Trigger<std::string, std::string> esphome::api::APIServer::client_connected_trigger_

protected

Definition at line 259 of file api_server.h.

◆ client_disconnected_trigger_

Trigger<std::string, std::string> esphome::api::APIServer::client_disconnected_trigger_

protected

Definition at line 262 of file api_server.h.

◆ clients_

std::vector<std::unique_ptr<APIConnection> > esphome::api::APIServer::clients_

protected

Definition at line 270 of file api_server.h.

◆ last_connected_

uint32_t esphome::api::APIServer::last_connected_ {0}

protected

Definition at line 267 of file api_server.h.

◆ listen_backlog_

uint8_t esphome::api::APIServer::listen_backlog_ {4}

protected

Definition at line 302 of file api_server.h.

◆ max_connections_

uint8_t esphome::api::APIServer::max_connections_ {8}

protected

Definition at line 303 of file api_server.h.

◆ next_action_call_id_

uint32_t esphome::api::APIServer::next_action_call_id_ {1}

protected

Definition at line 286 of file api_server.h.

◆ noise_ctx_

APINoiseContext esphome::api::APIServer::noise_ctx_

protected

Definition at line 308 of file api_server.h.

◆ noise_pref_

ESPPreferenceObject esphome::api::APIServer::noise_pref_

protected

Definition at line 309 of file api_server.h.

◆ port_

uint16_t esphome::api::APIServer::port_ {6053}

protected

Definition at line 298 of file api_server.h.

◆ reboot_timeout_

uint32_t esphome::api::APIServer::reboot_timeout_ {300000}

protected

Definition at line 266 of file api_server.h.

◆ shared_write_buffer_

std::vector<uint8_t> esphome::api::APIServer::shared_write_buffer_

protected

Definition at line 271 of file api_server.h.

◆ shutting_down_

bool esphome::api::APIServer::shutting_down_ = false

protected

Definition at line 304 of file api_server.h.

◆ socket_

std::unique_ptr<socket::Socket> esphome::api::APIServer::socket_ = nullptr

protected

Definition at line 257 of file api_server.h.

◆ state_subs_

std::vector<HomeAssistantStateSubscription> esphome::api::APIServer::state_subs_

protected

Definition at line 273 of file api_server.h.

◆ user_services_

std::vector<UserServiceDescriptor *> esphome::api::APIServer::user_services_

protected

Definition at line 276 of file api_server.h.

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

esphome/components/api/api_server.h
esphome/components/api/api_server.cpp

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ActionResponseCallback

Constructor & Destructor Documentation

◆ APIServer()

Member Function Documentation

◆ __attribute__() [1/2]

◆ __attribute__() [2/2]

◆ add_state_subscription_() [1/3]

◆ add_state_subscription_() [2/3]

◆ add_state_subscription_() [3/3]

◆ clear_noise_psk()

◆ dump_config()

◆ get_batch_delay()

◆ get_client_connected_trigger()

◆ get_client_disconnected_trigger()

◆ get_home_assistant_state() [1/3]

◆ get_home_assistant_state() [2/3]

◆ get_home_assistant_state() [3/3]

◆ get_noise_ctx()

◆ get_port()

◆ get_setup_priority()

◆ get_shared_buffer_ref()

◆ get_state_subs()

◆ get_user_services()

◆ handle_action_response() [1/2]

◆ handle_action_response() [2/2]

◆ handle_disconnect()

◆ initialize_user_services()

◆ is_connected()

◆ loop()

◆ on_alarm_control_panel_update()

◆ on_binary_sensor_update()

◆ on_camera_image()

◆ on_climate_update()

◆ on_cover_update()

◆ on_date_update()

◆ on_datetime_update()

◆ on_event()

◆ on_fan_update()

◆ on_light_update()

◆ on_lock_update()

◆ on_log()

◆ on_media_player_update()

◆ on_number_update()

◆ on_select_update()

◆ on_sensor_update()

◆ on_shutdown()

◆ on_switch_update()

◆ on_text_sensor_update()

◆ on_text_update()

◆ on_time_update()

◆ on_update()

◆ on_valve_update()

◆ on_water_heater_update()

◆ on_zwave_proxy_request()

◆ register_action_response_callback()

◆ register_active_action_call()

◆ register_user_service()

◆ request_time()

◆ save_noise_psk()

◆ send_action_response() [1/2]

◆ send_action_response() [2/2]

◆ send_homeassistant_action()

◆ send_infrared_rf_receive_event()

◆ set_batch_delay()

◆ set_listen_backlog()

◆ set_max_connections()

◆ set_noise_psk()

◆ set_port()

◆ set_reboot_timeout()

◆ setup()

◆ subscribe_home_assistant_state() [1/3]

◆ subscribe_home_assistant_state() [2/3]

◆ subscribe_home_assistant_state() [3/3]

◆ attribute() [1/2]

◆ attribute() [2/2]