#include <api_server.h>

Inheritance diagram for esphome::api::APIServer:

Data Structures
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

bool	check_password (const uint8_t *password_data, size_t password_len) const

void	set_password (const std::string &password)

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)

std::shared_ptr< 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	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, const std::string &error_message)

void	handle_action_response (uint32_t call_id, bool success, const std::string &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)

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)

bool	is_connected () const

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

void	get_home_assistant_state (std::string entity_id, optional< std::string > attribute, std::function< void(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 () const

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

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.

void	mark_failed (const char *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 (const char *message=nullptr)

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 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

Protected Member Functions
void	schedule_reboot_timeout_ ()

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)

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 (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

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

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

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

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

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

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

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

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

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

Trigger< std::string, std::string > *	client_connected_trigger_ = new Trigger<std::string, std::string>()

Trigger< std::string, std::string > *	client_disconnected_trigger_ = new Trigger<std::string, std::string>()

uint32_t	reboot_timeout_ {300000}

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

std::string	password_

std::vector< uint8_t >	shared_write_buffer_

std::vector< HomeAssistantStateSubscription >	state_subs_

std::vector< UserServiceDescriptor * >	user_services_

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

std::shared_ptr< APINoiseContext >	noise_ctx_ = std::make_shared<APINoiseContext>()

ESPPreferenceObject	noise_pref_

Protected Attributes inherited from esphome::Component
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 30 of file api_server.h.

Member Typedef Documentation

◆ ActionResponseCallback

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

Definition at line 118 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

◆ check_password()

bool esphome::api::APIServer::check_password	(	const uint8_t *	password_data,
		size_t	password_len ) const

Definition at line 240 of file api_server.cpp.

◆ clear_noise_psk()

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

Definition at line 507 of file api_server.cpp.

◆ dump_config()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 222 of file api_server.cpp.

◆ get_batch_delay()

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

inline

Definition at line 47 of file api_server.h.

◆ get_client_connected_trigger()

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

inline

Definition at line 174 of file api_server.h.

◆ get_client_disconnected_trigger()

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

inline

Definition at line 177 of file api_server.h.

◆ get_home_assistant_state()

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

Definition at line 444 of file api_server.cpp.

◆ get_noise_ctx()

std::shared_ptr< APINoiseContext > esphome::api::APIServer::get_noise_ctx ( )

inline

Definition at line 58 of file api_server.h.

◆ get_port()

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

Definition at line 459 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 52 of file api_server.h.

◆ get_state_subs()

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

Definition at line 454 of file api_server.cpp.

◆ get_user_services()

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

inline

Definition at line 170 of file api_server.h.

◆ handle_action_response() [1/2]

void esphome::api::APIServer::handle_action_response	(	uint32_t	call_id,
		bool	success,
		const std::string &	error_message )

Definition at line 405 of file api_server.cpp.

◆ handle_action_response() [2/2]

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

Definition at line 417 of file api_server.cpp.

◆ handle_disconnect()

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

Definition at line 271 of file api_server.cpp.

◆ initialize_user_services()

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

inline

Definition at line 128 of file api_server.h.

◆ is_connected()

bool esphome::api::APIServer::is_connected ( ) const

Definition at line 531 of file api_server.cpp.

◆ loop()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 142 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_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_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 533 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 363 of file api_server.cpp.

◆ on_valve_update()

void esphome::api::APIServer::on_valve_update ( valve::Valve * 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 372 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 401 of file api_server.cpp.

◆ register_user_service()

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

inline

Definition at line 133 of file api_server.h.

◆ request_time()

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

Definition at line 523 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 489 of file api_server.cpp.

◆ schedule_reboot_timeout_()

void esphome::api::APIServer::schedule_reboot_timeout_ ( )

protected

Definition at line 132 of file api_server.cpp.

◆ send_homeassistant_action()

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

Definition at line 395 of file api_server.cpp.

◆ set_batch_delay()

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

Definition at line 392 of file api_server.cpp.

◆ set_listen_backlog()

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

inline

Definition at line 48 of file api_server.h.

◆ set_max_connections()

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

inline

Definition at line 49 of file api_server.h.

◆ set_noise_psk()

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

inline

Definition at line 57 of file api_server.h.

◆ set_password()

void esphome::api::APIServer::set_password ( const std::string & password )

Definition at line 389 of file api_server.cpp.

◆ 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 461 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()

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

Definition at line 434 of file api_server.cpp.

◆ teardown()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 557 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 464 of file api_server.cpp.

Field Documentation

◆ action_response_callbacks_

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

protected

Definition at line 217 of file api_server.h.

◆ batch_delay_

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

protected

Definition at line 222 of file api_server.h.

◆ client_connected_trigger_

Trigger<std::string, std::string>* esphome::api::APIServer::client_connected_trigger_ = new Trigger<std::string, std::string>()

protected

Definition at line 191 of file api_server.h.

◆ client_disconnected_trigger_

Trigger<std::string, std::string>* esphome::api::APIServer::client_disconnected_trigger_ = new Trigger<std::string, std::string>()

protected

Definition at line 194 of file api_server.h.

◆ clients_

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

protected

Definition at line 201 of file api_server.h.

◆ listen_backlog_

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

protected

Definition at line 225 of file api_server.h.

◆ max_connections_

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

protected

Definition at line 226 of file api_server.h.

◆ noise_ctx_

std::shared_ptr<APINoiseContext> esphome::api::APIServer::noise_ctx_ = std::make_shared<APINoiseContext>()

protected

Definition at line 231 of file api_server.h.

◆ noise_pref_

ESPPreferenceObject esphome::api::APIServer::noise_pref_

protected

Definition at line 232 of file api_server.h.

◆ password_

std::string esphome::api::APIServer::password_

protected

Definition at line 203 of file api_server.h.

◆ port_

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

protected

Definition at line 221 of file api_server.h.

◆ reboot_timeout_

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

protected

Definition at line 198 of file api_server.h.

◆ shared_write_buffer_

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

protected

Definition at line 205 of file api_server.h.

◆ shutting_down_

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

protected

Definition at line 227 of file api_server.h.

◆ socket_

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

protected

Definition at line 189 of file api_server.h.

◆ state_subs_

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

protected

Definition at line 207 of file api_server.h.

◆ user_services_

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

protected

Definition at line 210 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

◆ check_password()

◆ clear_noise_psk()

◆ dump_config()

◆ get_batch_delay()

◆ get_client_connected_trigger()

◆ get_client_disconnected_trigger()

◆ get_home_assistant_state()

◆ 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_climate_update()

◆ on_cover_update()

◆ on_date_update()

◆ on_datetime_update()

◆ on_event()

◆ on_fan_update()

◆ on_light_update()

◆ on_lock_update()

◆ 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_zwave_proxy_request()

◆ register_action_response_callback()

◆ register_user_service()

◆ request_time()

◆ save_noise_psk()

◆ schedule_reboot_timeout_()

◆ send_homeassistant_action()

◆ set_batch_delay()

◆ set_listen_backlog()

◆ set_max_connections()

◆ set_noise_psk()

◆ set_password()

◆ set_port()

◆ set_reboot_timeout()

◆ setup()

◆ subscribe_home_assistant_state()

◆ teardown()

◆ update_noise_psk_()

Field Documentation

◆ action_response_callbacks_

◆ batch_delay_

◆ client_connected_trigger_

◆ client_disconnected_trigger_

◆ clients_

◆ listen_backlog_

◆ max_connections_

◆ noise_ctx_

◆ noise_pref_

◆ password_