7#ifdef USE_API_PLAINTEXT
10#ifdef USE_API_USER_DEFINED_ACTIONS
29#ifdef USE_PROVISIONING
36#ifdef USE_HOMEASSISTANT_TIME
39#ifdef USE_BLUETOOTH_PROXY
45#ifdef USE_VOICE_ASSISTANT
51#if defined(USE_SENDSPIN) && defined(USE_ESP_IDF)
54#ifdef USE_WATER_HEATER
60#ifdef USE_RADIO_FREQUENCY
70static constexpr uint8_t MAX_MESSAGES_PER_LOOP = 10;
71static constexpr uint8_t MAX_PING_RETRIES = 60;
72static constexpr uint16_t PING_RETRY_INTERVAL = 1000;
73static constexpr uint32_t KEEPALIVE_DISCONNECT_TIMEOUT = (KEEPALIVE_TIMEOUT_MS * 5) / 2;
82static constexpr uint32_t HANDSHAKE_TIMEOUT_MS = 60000;
87static_assert(MAC_ADDRESS_PRETTY_BUFFER_SIZE - 1 == 17,
88 "Update max_data_length for mac_address/bluetooth_mac_address in api.proto");
90static_assert(
sizeof(ESPHOME_VERSION) - 1 <= 32,
"Update max_data_length for esphome_version in api.proto");
91static_assert(ESPHOME_DEVICE_NAME_MAX_LEN <= 31,
"Update max_data_length for name in api.proto");
92static_assert(ESPHOME_FRIENDLY_NAME_MAX_LEN <= 120,
"Update max_data_length for friendly_name in api.proto");
94static const char *
const TAG =
"api.connection";
96#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_WARN
98 esp_log_printf_(ESPHOME_LOG_LEVEL_WARN, tag, line, ESPHOME_LOG_FORMAT(
"%s dropped, TCP buffer full"),
103static const int CAMERA_STOP_STREAM = 5000;
109#define ENTITY_COMMAND_MAKE_CALL(entity_type, entity_var, getter_name) \
110 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key, msg.device_id); \
111 if ((entity_var) == nullptr) \
113 auto call = (entity_var)->make_call();
117#define ENTITY_COMMAND_GET(entity_type, entity_var, getter_name) \
118 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key, msg.device_id); \
119 if ((entity_var) == nullptr) \
124#define ENTITY_COMMAND_LOOKUP(entity_type, entity_var, getter_name) \
125 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key, msg.device_id)
130#define ENTITY_COMMAND_MAKE_CALL(entity_type, entity_var, getter_name) \
131 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key); \
132 if ((entity_var) == nullptr) \
134 auto call = (entity_var)->make_call();
138#define ENTITY_COMMAND_GET(entity_type, entity_var, getter_name) \
139 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key); \
140 if ((entity_var) == nullptr) \
145#define ENTITY_COMMAND_LOOKUP(entity_type, entity_var, getter_name) \
146 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key)
151#if defined(USE_API_PLAINTEXT) && defined(USE_API_NOISE)
153 if (noise_ctx.has_psk()) {
154 this->helper_ = std::unique_ptr<APIFrameHelper>{new APINoiseFrameHelper(std::move(sock), noise_ctx)};
158#elif defined(USE_API_PLAINTEXT)
159 this->helper_ = std::unique_ptr<APIPlaintextFrameHelper>{
new APIPlaintextFrameHelper(std::move(sock))};
160#elif defined(USE_API_NOISE)
162 std::unique_ptr<APINoiseFrameHelper>{
new APINoiseFrameHelper(std::move(sock), parent->get_noise_ctx())};
164#error "No frame helper defined"
168void APIConnection::start() {
171 APIError err = this->helper_->init();
172 if (err != APIError::OK) {
173 this->fatal_error_with_log_(LOG_STR(
"Helper init failed"), err);
177 char peername[socket::SOCKADDR_STR_LEN];
178 this->helper_->set_client_name(this->helper_->get_peername_to(peername), strlen(peername));
181APIConnection::~APIConnection() {
182 this->destroy_active_iterator_();
183#ifdef USE_BLUETOOTH_PROXY
188#ifdef USE_VOICE_ASSISTANT
193#ifdef USE_ZWAVE_PROXY
198#ifdef USE_SERIAL_PROXY
200 if (proxy->get_api_connection() ==
this) {
201 proxy->serial_proxy_request(
this, enums::SERIAL_PROXY_REQUEST_TYPE_UNSUBSCRIBE);
207 for (
auto *infrared :
App.get_infrareds()) {
208 infrared->on_api_connection_closed(
this);
211#ifdef USE_RADIO_FREQUENCY
212 for (
auto *radio_frequency :
App.get_radio_frequencies()) {
213 radio_frequency->on_api_connection_closed(
this);
218#if defined(USE_API_NOISE) && defined(USE_API_PLAINTEXT)
219void APIConnection::upgrade_helper_to_noise_() {
229 auto *noise =
new APINoiseFrameHelper(plaintext->release_socket_for_switch(), this->parent_->get_noise_ctx());
231 const char *name = plaintext->get_client_name();
232 noise->set_client_name(name, strlen(name));
233 this->helper_.reset(noise);
234 APIError err = noise->init_from_handoff(header, header_len);
235 if (err != APIError::OK) {
236 this->fatal_error_with_log_(LOG_STR(
"Noise handoff failed"), err);
241void APIConnection::destroy_active_iterator_() {
242 switch (this->active_iterator_) {
243 case ActiveIterator::LIST_ENTITIES:
244 this->iterator_storage_.list_entities.~ListEntitiesIterator();
246 case ActiveIterator::INITIAL_STATE:
247 this->iterator_storage_.initial_state.~InitialStateIterator();
249 case ActiveIterator::NONE:
252 this->active_iterator_ = ActiveIterator::NONE;
256 this->destroy_active_iterator_();
257 this->active_iterator_ =
type;
258 if (
type == ActiveIterator::LIST_ENTITIES) {
260 this->iterator_storage_.list_entities.
begin();
263 this->iterator_storage_.initial_state.
begin();
267void APIConnection::loop() {
268 if (this->flags_.next_close) {
271 this->flags_.remove =
true;
275 APIError err = this->helper_->loop();
276 if (err != APIError::OK) {
277 this->fatal_error_with_log_(LOG_STR(
"Socket operation failed"), err);
288 if (this->helper_->is_socket_ready() || this->flags_.may_have_remaining_data) {
289 this->flags_.may_have_remaining_data =
false;
291 uint8_t message_count = 0;
292 for (; message_count < MAX_MESSAGES_PER_LOOP; message_count++) {
294 err = this->helper_->read_packet(&
buffer);
295 if (err == APIError::WOULD_BLOCK) {
298 }
else if (err != APIError::OK) {
299#if defined(USE_API_NOISE) && defined(USE_API_PLAINTEXT)
303 if (err == APIError::PROTOCOL_SWITCH_TO_NOISE) {
304 this->upgrade_helper_to_noise_();
308 this->fatal_error_with_log_(LOG_STR(
"Reading failed"), err);
314 if (this->is_authenticated()) {
315 this->last_traffic_ = now;
319 if (this->flags_.remove)
325 if (message_count == MAX_MESSAGES_PER_LOOP) {
326 this->flags_.may_have_remaining_data =
true;
331 if (this->flags_.batch_scheduled && now - this->deferred_batch_.batch_start_time >= this->get_batch_delay_ms_()) {
332 this->process_batch_();
335 if (this->active_iterator_ != ActiveIterator::NONE) {
336 this->process_active_iterator_();
342 if (!this->is_authenticated() && now - this->last_traffic_ > HANDSHAKE_TIMEOUT_MS) {
343 this->on_fatal_error();
344 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"handshake timeout; disconnecting"));
351 if (now - this->last_traffic_ > KEEPALIVE_TIMEOUT_MS) {
352 this->check_keepalive_(now);
355#ifdef USE_API_HOMEASSISTANT_STATES
356 if (state_subs_at_ >= 0) {
357 this->process_state_subscriptions_();
364 this->try_send_camera_image_();
368void APIConnection::check_keepalive_(
uint32_t now) {
370 if (this->flags_.sent_ping) {
372 if (now - this->last_traffic_ > KEEPALIVE_DISCONNECT_TIMEOUT) {
374 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"is unresponsive; disconnecting"));
376 }
else if (!this->flags_.remove) {
378 ESP_LOGVV(TAG,
"Sending keepalive PING");
380 this->flags_.sent_ping = this->send_message(req);
381 if (this->flags_.sent_ping) {
383 this->helper_->release_overflow_buffer();
387 ESP_LOGW(TAG,
"Buffer full, ping queued");
388 this->schedule_message_front_(
nullptr, PingRequest::MESSAGE_TYPE, PingRequest::ESTIMATED_SIZE);
389 this->flags_.sent_ping =
true;
394void APIConnection::process_active_iterator_() {
396 if (this->active_iterator_ == ActiveIterator::LIST_ENTITIES) {
397 if (this->iterator_storage_.list_entities.completed()) {
398 this->destroy_active_iterator_();
399 if (this->flags_.state_subscription) {
400 this->begin_iterator_(ActiveIterator::INITIAL_STATE);
402 this->finalize_iterator_sync_();
405 this->process_iterator_batch_(this->iterator_storage_.list_entities);
408 if (this->iterator_storage_.initial_state.completed()) {
409 this->destroy_active_iterator_();
410 this->finalize_iterator_sync_();
412 this->process_iterator_batch_(this->iterator_storage_.initial_state);
417void APIConnection::finalize_iterator_sync_() {
421 if (!this->deferred_batch_.empty()) {
422 this->process_batch_();
425 this->flags_.should_try_send_immediately =
true;
427 this->deferred_batch_.release_buffer();
428 this->helper_->release_buffers();
434 size_t batch_size = this->deferred_batch_.size();
435 if (batch_size < MAX_INITIAL_BATCH_SIZE)
436 iterator.
try_advance(MAX_INITIAL_BATCH_SIZE - batch_size);
440 if (this->deferred_batch_.size() >= MAX_INITIAL_BATCH_SIZE) {
441 this->process_batch_();
445bool APIConnection::send_disconnect_response_() {
449 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"disconnected"));
450 this->flags_.next_close =
true;
452 return this->send_message(resp);
454void APIConnection::on_disconnect_response() {
457 this->flags_.remove =
true;
467 return encode_to_buffer(size_fn(&msg), encode_fn, &msg, conn, remaining_size);
481#ifdef USE_ENTITY_ICON
482 char icon_buf[MAX_ICON_LENGTH];
490 return encode_to_buffer_slow(size_fn(&msg), encode_fn, &msg, conn, remaining_size);
498 char dc_buf[MAX_DEVICE_CLASS_LENGTH];
500 return fill_and_encode_entity_info(entity, msg, size_fn, encode_fn, conn, remaining_size);
503#ifdef USE_BINARY_SENSOR
505 return this->send_message_smart_(binary_sensor, BinarySensorStateResponse::MESSAGE_TYPE,
506 BinarySensorStateResponse::ESTIMATED_SIZE);
512 resp.
state = binary_sensor->state;
514 return fill_and_encode_entity_state(binary_sensor, resp, conn, remaining_size);
521 return fill_and_encode_entity_info_with_device_class(binary_sensor, msg, msg.
device_class, conn, remaining_size);
527 return this->send_message_smart_(cover, CoverStateResponse::MESSAGE_TYPE, CoverStateResponse::ESTIMATED_SIZE);
532 auto traits = cover->get_traits();
534 if (traits.get_supports_tilt())
535 msg.
tilt = cover->tilt;
537 return fill_and_encode_entity_state(cover, msg, conn, remaining_size);
542 auto traits = cover->get_traits();
547 return fill_and_encode_entity_info_with_device_class(cover, msg, msg.
device_class, conn, remaining_size);
554 call.set_tilt(msg.
tilt);
556 call.set_command_stop();
563 return this->send_message_smart_(fan, FanStateResponse::MESSAGE_TYPE, FanStateResponse::ESTIMATED_SIZE);
566 auto *fan =
static_cast<fan::Fan *
>(entity);
568 auto traits = fan->get_traits();
569 msg.
state = fan->state;
570 if (traits.supports_oscillation())
572 if (traits.supports_speed()) {
575 if (traits.supports_direction())
577 if (traits.supports_preset_modes() && fan->has_preset_mode())
579 return fill_and_encode_entity_state(fan, msg, conn, remaining_size);
582 auto *fan =
static_cast<fan::Fan *
>(entity);
584 auto traits = fan->get_traits();
590 return fill_and_encode_entity_info(fan, msg, conn, remaining_size);
593 ENTITY_COMMAND_MAKE_CALL(
fan::Fan, fan, fan)
595 call.set_state(msg.
state);
612 return this->send_message_smart_(light, LightStateResponse::MESSAGE_TYPE, LightStateResponse::ESTIMATED_SIZE);
617 auto values = light->get_reported_values();
618 auto color_mode = values.get_color_mode();
619 resp.
state = values.is_on();
623 resp.
red = values.get_red();
624 resp.
green = values.get_green();
625 resp.
blue = values.get_blue();
626 resp.
white = values.get_white();
630 if (light->supports_effects()) {
631 resp.
effect = light->get_effect_name();
633 return fill_and_encode_entity_state(light, resp, conn, remaining_size);
638 auto traits = light->get_traits();
639 auto supported_modes = traits.get_supported_color_modes();
648 if (light->supports_effects()) {
649 auto &light_effects = light->get_effects();
650 effects_list.
init(light_effects.size() + 1);
652 for (
auto *effect : light_effects) {
654 effects_list.
push_back(effect->get_name().c_str());
658 return fill_and_encode_entity_info(light, msg, conn, remaining_size);
663 call.set_state(msg.
state);
671 call.set_red(msg.
red);
672 call.set_green(msg.
green);
673 call.set_blue(msg.
blue);
676 call.set_white(msg.
white);
695 return this->send_message_smart_(sensor, SensorStateResponse::MESSAGE_TYPE, SensorStateResponse::ESTIMATED_SIZE);
701 resp.
state = sensor->state;
703 return fill_and_encode_entity_state(sensor, resp, conn, remaining_size);
713 return fill_and_encode_entity_info_with_device_class(sensor, msg, msg.
device_class, conn, remaining_size);
719 return this->send_message_smart_(a_switch, SwitchStateResponse::MESSAGE_TYPE, SwitchStateResponse::ESTIMATED_SIZE);
725 resp.
state = a_switch->state;
727 return fill_and_encode_entity_state(a_switch, resp, conn, remaining_size);
734 return fill_and_encode_entity_info_with_device_class(a_switch, msg, msg.
device_class, conn, remaining_size);
738 a_switch->control(msg.
state);
742#ifdef USE_TEXT_SENSOR
744 return this->send_message_smart_(text_sensor, TextSensorStateResponse::MESSAGE_TYPE,
745 TextSensorStateResponse::ESTIMATED_SIZE);
753 return fill_and_encode_entity_state(text_sensor, resp, conn, remaining_size);
758 return fill_and_encode_entity_info_with_device_class(text_sensor, msg, msg.
device_class, conn, remaining_size);
764 return this->send_message_smart_(climate, ClimateStateResponse::MESSAGE_TYPE, ClimateStateResponse::ESTIMATED_SIZE);
769 auto traits = climate->get_traits();
782 if (traits.get_supports_fan_modes() && climate->fan_mode.has_value())
784 if (!traits.get_supported_custom_fan_modes().empty() && climate->has_custom_fan_mode()) {
787 if (traits.get_supports_presets() && climate->preset.has_value()) {
790 if (!traits.get_supported_custom_presets().empty() && climate->has_custom_preset()) {
793 if (traits.get_supports_swing_modes())
799 return fill_and_encode_entity_state(climate, resp, conn, remaining_size);
804 auto traits = climate->get_traits();
827 return fill_and_encode_entity_info(climate, msg, conn, remaining_size);
857 return this->send_message_smart_(number, NumberStateResponse::MESSAGE_TYPE, NumberStateResponse::ESTIMATED_SIZE);
863 resp.
state = number->state;
865 return fill_and_encode_entity_state(number, resp, conn, remaining_size);
873 msg.
min_value = number->traits.get_min_value();
874 msg.
max_value = number->traits.get_max_value();
875 msg.
step = number->traits.get_step();
876 return fill_and_encode_entity_info_with_device_class(number, msg, msg.
device_class, conn, remaining_size);
880 call.set_value(msg.
state);
885#ifdef USE_DATETIME_DATE
887 return this->send_message_smart_(date, DateStateResponse::MESSAGE_TYPE, DateStateResponse::ESTIMATED_SIZE);
893 resp.
year = date->year;
894 resp.
month = date->month;
895 resp.
day = date->day;
896 return fill_and_encode_entity_state(date, resp, conn, remaining_size);
901 return fill_and_encode_entity_info(date, msg, conn, remaining_size);
910#ifdef USE_DATETIME_TIME
912 return this->send_message_smart_(time, TimeStateResponse::MESSAGE_TYPE, TimeStateResponse::ESTIMATED_SIZE);
918 resp.
hour = time->hour;
919 resp.
minute = time->minute;
920 resp.
second = time->second;
921 return fill_and_encode_entity_state(time, resp, conn, remaining_size);
926 return fill_and_encode_entity_info(time, msg, conn, remaining_size);
935#ifdef USE_DATETIME_DATETIME
937 return this->send_message_smart_(datetime, DateTimeStateResponse::MESSAGE_TYPE,
938 DateTimeStateResponse::ESTIMATED_SIZE);
944 if (datetime->has_state()) {
948 return fill_and_encode_entity_state(datetime, resp, conn, remaining_size);
953 return fill_and_encode_entity_info(datetime, msg, conn, remaining_size);
964 return this->send_message_smart_(text, TextStateResponse::MESSAGE_TYPE, TextStateResponse::ESTIMATED_SIZE);
968 auto *text =
static_cast<text::Text *
>(entity);
972 return fill_and_encode_entity_state(text, resp, conn, remaining_size);
976 auto *text =
static_cast<text::Text *
>(entity);
979 msg.
min_length = text->traits.get_min_length();
980 msg.
max_length = text->traits.get_max_length();
981 msg.
pattern = text->traits.get_pattern_ref();
982 return fill_and_encode_entity_info(text, msg, conn, remaining_size);
985 ENTITY_COMMAND_MAKE_CALL(
text::Text, text, text)
993 return this->send_message_smart_(select, SelectStateResponse::MESSAGE_TYPE, SelectStateResponse::ESTIMATED_SIZE);
999 resp.
state = select->current_option();
1001 return fill_and_encode_entity_state(select, resp, conn, remaining_size);
1007 const auto &opts = select->traits.get_options();
1008 const std::span<const char *const>
options(opts.data(), opts.size());
1010 return fill_and_encode_entity_info(select, msg, conn, remaining_size);
1023 return fill_and_encode_entity_info_with_device_class(button, msg, msg.
device_class, conn, remaining_size);
1033 return this->send_message_smart_(a_lock, LockStateResponse::MESSAGE_TYPE, LockStateResponse::ESTIMATED_SIZE);
1037 auto *a_lock =
static_cast<lock::Lock *
>(entity);
1040 return fill_and_encode_entity_state(a_lock, resp, conn, remaining_size);
1044 auto *a_lock =
static_cast<lock::Lock *
>(entity);
1049 return fill_and_encode_entity_info(a_lock, msg, conn, remaining_size);
1055 case enums::LOCK_UNLOCK:
1058 case enums::LOCK_LOCK:
1061 case enums::LOCK_OPEN:
1070 return this->send_message_smart_(valve, ValveStateResponse::MESSAGE_TYPE, ValveStateResponse::ESTIMATED_SIZE);
1077 return fill_and_encode_entity_state(valve, resp, conn, remaining_size);
1082 auto traits = valve->get_traits();
1086 return fill_and_encode_entity_info_with_device_class(valve, msg, msg.
device_class, conn, remaining_size);
1093 call.set_command_stop();
1098#ifdef USE_MEDIA_PLAYER
1100 return this->send_message_smart_(media_player, MediaPlayerStateResponse::MESSAGE_TYPE,
1101 MediaPlayerStateResponse::ESTIMATED_SIZE);
1108 : media_player->state;
1110 resp.
volume = media_player->volume;
1111 resp.
muted = media_player->is_muted();
1112 return fill_and_encode_entity_state(media_player, resp, conn, remaining_size);
1117 auto traits = media_player->get_traits();
1119 for (
auto &supported_format : traits.get_supported_formats()) {
1122 media_format.format =
StringRef(supported_format.format);
1123 media_format.sample_rate = supported_format.sample_rate;
1124 media_format.num_channels = supported_format.num_channels;
1126 media_format.sample_bytes = supported_format.sample_bytes;
1128 return fill_and_encode_entity_info(media_player, msg, conn, remaining_size);
1136 call.set_volume(msg.
volume);
1149void APIConnection::try_send_camera_image_() {
1150 if (!this->image_reader_)
1155 while (this->image_reader_->available()) {
1156 if (!this->helper_->can_write_without_blocking())
1159 uint32_t to_send = std::min((
size_t) MAX_BATCH_PACKET_SIZE, this->image_reader_->available());
1160 bool done = this->image_reader_->available() == to_send;
1163 msg.
key = cam->get_object_id_hash();
1164 msg.
set_data(this->image_reader_->peek_data_buffer(), to_send);
1170 if (!this->send_message(msg)) {
1173 this->image_reader_->consume_data(to_send);
1175 this->image_reader_->return_image();
1180void APIConnection::set_camera_state(std::shared_ptr<camera::CameraImage> image) {
1181 if (!this->flags_.state_subscription)
1183 if (this->image_reader_ && this->image_reader_->available())
1187 if (!this->image_reader_) {
1193 this->image_reader_->set_image(std::move(image));
1195 this->try_send_camera_image_();
1200 return fill_and_encode_entity_info(camera, msg, conn, remaining_size);
1211 App.
scheduler.set_timeout(this->parent_,
"api_camera_stop_stream", CAMERA_STOP_STREAM,
1217#ifdef USE_HOMEASSISTANT_TIME
1221#if defined(USE_HOMEASSISTANT_TIMEZONE) && defined(USE_TIME_TIMEZONE)
1232 tz.
dst_start.
day =
static_cast<uint16_t
>(pt.dst_start.day);
1235 tz.
dst_start.
week =
static_cast<uint8_t
>(pt.dst_start.week);
1238 tz.
dst_end.
day =
static_cast<uint16_t
>(pt.dst_end.day);
1240 tz.
dst_end.
month =
static_cast<uint8_t
>(pt.dst_end.month);
1241 tz.
dst_end.
week =
static_cast<uint8_t
>(pt.dst_end.week);
1250#ifdef USE_BLUETOOTH_PROXY
1251void APIConnection::on_subscribe_bluetooth_le_advertisements_request(
1255void APIConnection::on_unsubscribe_bluetooth_le_advertisements_request() {
1258#ifdef USE_BLUETOOTH_PROXY_CONNECTIONS
1282bool APIConnection::send_subscribe_bluetooth_connections_free_response_() {
1286void APIConnection::on_subscribe_bluetooth_connections_free_request() {
1287 if (!this->send_subscribe_bluetooth_connections_free_response_()) {
1288 this->on_fatal_error();
1299 msg.
mode == enums::BluetoothScannerMode::BLUETOOTH_SCANNER_MODE_ACTIVE);
1303#ifdef USE_VOICE_ASSISTANT
1304bool APIConnection::check_voice_assistant_api_connection_()
const {
1315 if (!this->check_voice_assistant_api_connection_()) {
1323 if (msg.
port == 0) {
1329 this->helper_->getpeername((
struct sockaddr *) &storage, &
len);
1334 if (this->check_voice_assistant_api_connection_()) {
1339 if (this->check_voice_assistant_api_connection_()) {
1344 if (this->check_voice_assistant_api_connection_()) {
1350 if (this->check_voice_assistant_api_connection_()) {
1355bool APIConnection::send_voice_assistant_get_configuration_response_(
1358 if (!this->check_voice_assistant_api_connection_()) {
1360 const std::vector<std::string> empty_wake_words;
1362 return this->send_message(resp);
1366 for (
auto &wake_word : config.available_wake_words) {
1369 resp_wake_word.id =
StringRef(wake_word.id);
1370 resp_wake_word.wake_word =
StringRef(wake_word.wake_word);
1371 for (
const auto &lang : wake_word.trained_languages) {
1372 resp_wake_word.trained_languages.push_back(lang);
1378 return this->send_message(resp);
1381 if (!this->send_voice_assistant_get_configuration_response_(msg)) {
1382 this->on_fatal_error();
1387 if (this->check_voice_assistant_api_connection_()) {
1393#ifdef USE_ZWAVE_PROXY
1402 if (!this->send_message(resp)) {
1403 API_LOG_MSG_DROPPED(TAG,
"Z-Wave proxy response");
1408#if defined(USE_SENDSPIN) && defined(USE_ESP_IDF)
1409bool APIConnection::send_sendspin_pairing_token_response_() {
1414 if (!this->parent_->get_noise_ctx().has_psk()) {
1415 resp.
status = enums::SENDSPIN_PAIRING_TOKEN_STATUS_ENCRYPTION_REQUIRED;
1416 return this->send_message(resp);
1419 if (token.has_value()) {
1420 resp.
status = enums::SENDSPIN_PAIRING_TOKEN_STATUS_OK;
1423 resp.
status = enums::SENDSPIN_PAIRING_TOKEN_STATUS_FAILED;
1425 resp.
status = enums::SENDSPIN_PAIRING_TOKEN_STATUS_DISABLED;
1427 resp.
status = enums::SENDSPIN_PAIRING_TOKEN_STATUS_NOT_READY;
1430 resp.
status = enums::SENDSPIN_PAIRING_TOKEN_STATUS_ENCRYPTION_REQUIRED;
1432 return this->send_message(resp);
1435void APIConnection::on_sendspin_pairing_token_request() {
1436 if (!this->send_sendspin_pairing_token_response_()) {
1437 this->on_fatal_error();
1442#ifdef USE_ALARM_CONTROL_PANEL
1444 return this->send_message_smart_(a_alarm_control_panel, AlarmControlPanelStateResponse::MESSAGE_TYPE,
1445 AlarmControlPanelStateResponse::ESTIMATED_SIZE);
1452 return fill_and_encode_entity_state(a_alarm_control_panel, resp, conn, remaining_size);
1459 msg.
requires_code = a_alarm_control_panel->get_requires_code();
1461 return fill_and_encode_entity_info(a_alarm_control_panel, msg, conn, remaining_size);
1466 case enums::ALARM_CONTROL_PANEL_DISARM:
1469 case enums::ALARM_CONTROL_PANEL_ARM_AWAY:
1472 case enums::ALARM_CONTROL_PANEL_ARM_HOME:
1475 case enums::ALARM_CONTROL_PANEL_ARM_NIGHT:
1478 case enums::ALARM_CONTROL_PANEL_ARM_VACATION:
1479 call.arm_vacation();
1481 case enums::ALARM_CONTROL_PANEL_ARM_CUSTOM_BYPASS:
1482 call.arm_custom_bypass();
1484 case enums::ALARM_CONTROL_PANEL_TRIGGER:
1493#ifdef USE_WATER_HEATER
1495 return this->send_message_smart_(water_heater, WaterHeaterStateResponse::MESSAGE_TYPE,
1496 WaterHeaterStateResponse::ESTIMATED_SIZE);
1507 resp.
state = wh->get_state();
1509 return fill_and_encode_entity_state(wh, resp, conn, remaining_size);
1514 auto traits = wh->get_traits();
1521 return fill_and_encode_entity_info(wh, msg, conn, remaining_size);
1526 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_MODE)
1528 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE)
1530 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE_LOW)
1532 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE_HIGH)
1534 if ((msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_AWAY_STATE) ||
1535 (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_STATE)) {
1538 if ((msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_ON_STATE) ||
1539 (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_STATE)) {
1550 this->send_message_smart_(event, EventResponse::MESSAGE_TYPE, EventResponse::ESTIMATED_SIZE,
1557 return fill_and_encode_entity_state(event, resp, conn, remaining_size);
1564 return fill_and_encode_entity_info_with_device_class(event, msg, msg.
device_class, conn, remaining_size);
1571 const bool want_reply = this->client_supports_api_version(1, 18);
1576 if (infrared !=
nullptr) {
1577 auto call = infrared->make_call();
1581 call.set_api_connection(want_reply ?
this :
nullptr);
1586#ifdef USE_RADIO_FREQUENCY
1588 if (radio_frequency !=
nullptr) {
1589 auto call = radio_frequency->make_call();
1594 call.set_api_connection(want_reply ?
this :
nullptr);
1599 ESP_LOGW(TAG,
"IR/RF transmit for unknown key %" PRIu32, msg.
key);
1607 if (!this->send_infrared_rf_transmit_complete(device_id, msg.
key,
false)) {
1608 API_LOG_MSG_DROPPED(TAG,
"IR/RF reply");
1613bool APIConnection::send_infrared_rf_transmit_complete([[maybe_unused]]
uint32_t device_id,
uint32_t key,
1620 resp.success = success;
1621 return this->send_message(resp);
1627 if (!this->send_message(msg)) {
1630 ESP_LOGV(TAG,
"IR/RF event dropped, TCP buffer full");
1636#ifdef USE_SERIAL_PROXY
1640 return enums::SERIAL_PROXY_STATUS_OK;
1642 return enums::SERIAL_PROXY_STATUS_ASSUMED_SUCCESS;
1644 return enums::SERIAL_PROXY_STATUS_PORT_IN_USE;
1646 return enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT;
1648 return enums::SERIAL_PROXY_STATUS_TIMEOUT;
1650 return enums::SERIAL_PROXY_STATUS_NOT_SUPPORTED;
1652 return enums::SERIAL_PROXY_STATUS_ERROR;
1654 return enums::SERIAL_PROXY_STATUS_ERROR;
1657static void send_serial_proxy_ack(APIConnection *conn,
uint32_t instance, enums::SerialProxyRequestType
type,
1658 enums::SerialProxyStatus
status) {
1659 SerialProxyRequestResponse resp{};
1660 resp.instance = instance;
1663 if (!conn->send_message(resp)) {
1664 API_LOG_MSG_DROPPED(TAG,
"Serial proxy response");
1670 if (msg.
instance >= proxies.size()) {
1671 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range (max %" PRIu32
")", msg.
instance,
1672 static_cast<uint32_t>(proxies.size()));
1673 send_serial_proxy_ack(
this, msg.
instance, enums::SERIAL_PROXY_REQUEST_TYPE_CONFIGURE,
1674 enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT);
1679 send_serial_proxy_ack(
this, msg.
instance, enums::SERIAL_PROXY_REQUEST_TYPE_CONFIGURE,
1680 serial_proxy_result_to_status(result));
1685 if (msg.
instance >= proxies.size()) {
1686 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1694 if (msg.
instance >= proxies.size()) {
1695 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1696 send_serial_proxy_ack(
this, msg.
instance, enums::SERIAL_PROXY_REQUEST_TYPE_SET_MODEM_PINS,
1697 enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT);
1701 send_serial_proxy_ack(
this, msg.
instance, enums::SERIAL_PROXY_REQUEST_TYPE_SET_MODEM_PINS,
1702 serial_proxy_result_to_status(result));
1709 if (msg.
instance >= proxies.size()) {
1710 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1713 if (!this->client_supports_api_version(1, 16)) {
1716 resp.status = enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT;
1718 resp.line_states = proxies[msg.
instance]->get_modem_pins();
1720 if (!this->send_message(resp)) {
1721 API_LOG_MSG_DROPPED(TAG,
"Serial proxy response");
1725void APIConnection::on_subscribe_serial_proxy_identity_request() {
1726#ifdef USE_SERIAL_PROXY_USB_IDENTITY
1728 this->flags_.serial_proxy_identity_subscription =
true;
1731 proxy->send_identity(
this);
1736 if (!this->send_message(msg)) {
1737 API_LOG_MSG_DROPPED(TAG,
"Serial proxy identity");
1743 if (msg.
instance >= proxies.size()) {
1744 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1745 send_serial_proxy_ack(
this, msg.
instance, msg.
type, enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT);
1748 auto *proxy = proxies[msg.
instance];
1751 case enums::SERIAL_PROXY_REQUEST_TYPE_SUBSCRIBE:
1752 case enums::SERIAL_PROXY_REQUEST_TYPE_UNSUBSCRIBE:
1753 status = serial_proxy_result_to_status(proxy->serial_proxy_request(
this, msg.
type));
1755 case enums::SERIAL_PROXY_REQUEST_TYPE_FLUSH:
1756 status = serial_proxy_result_to_status(proxy->flush_port(
this));
1758 case enums::SERIAL_PROXY_REQUEST_TYPE_CONFIGURE:
1759 case enums::SERIAL_PROXY_REQUEST_TYPE_SET_MODEM_PINS:
1760 case enums::SERIAL_PROXY_REQUEST_TYPE_SET_MODE:
1762 ESP_LOGW(TAG,
"Response-only serial proxy request type: %" PRIu32,
static_cast<uint32_t>(msg.
type));
1763 status = enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT;
1766 ESP_LOGW(TAG,
"Unknown serial proxy request type: %" PRIu32,
static_cast<uint32_t>(msg.
type));
1767 status = enums::SERIAL_PROXY_STATUS_NOT_SUPPORTED;
1775 if (msg.
instance >= proxies.size()) {
1776 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1777 send_serial_proxy_ack(
this, msg.
instance, enums::SERIAL_PROXY_REQUEST_TYPE_SET_MODE,
1778 enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT);
1782 send_serial_proxy_ack(
this, msg.
instance, enums::SERIAL_PROXY_REQUEST_TYPE_SET_MODE,
1783 serial_proxy_result_to_status(result));
1787 if (!this->send_message(msg)) {
1788 ESP_LOGV(TAG,
"Serial proxy data dropped, TCP buffer full");
1799 return fill_and_encode_entity_info(infrared, msg, conn, remaining_size);
1803#ifdef USE_RADIO_FREQUENCY
1809 msg.
frequency_min = rf->get_traits().get_frequency_min_hz();
1810 msg.
frequency_max = rf->get_traits().get_frequency_max_hz();
1812 return fill_and_encode_entity_info(rf, msg, conn, remaining_size);
1818 return this->send_message_smart_(update, UpdateStateResponse::MESSAGE_TYPE, UpdateStateResponse::ESTIMATED_SIZE);
1824 if (update->has_state()) {
1826 if (update->update_info.has_progress) {
1828 resp.
progress = update->update_info.progress;
1836 return fill_and_encode_entity_state(update, resp, conn, remaining_size);
1841 return fill_and_encode_entity_info_with_device_class(update, msg, msg.
device_class, conn, remaining_size);
1847 case enums::UPDATE_COMMAND_UPDATE:
1850 case enums::UPDATE_COMMAND_CHECK:
1853 case enums::UPDATE_COMMAND_NONE:
1854 ESP_LOGE(TAG,
"UPDATE_COMMAND_NONE not handled; confirm command is correct");
1857 ESP_LOGW(TAG,
"Unknown update command: %" PRIu32, msg.
command);
1863bool APIConnection::try_send_log_message(
int level,
const char *tag,
const char *line,
size_t message_len) {
1866 msg.
set_message(
reinterpret_cast<const uint8_t *
>(line), message_len);
1867 return this->send_message(msg);
1870void APIConnection::complete_authentication_() {
1872 if (this->flags_.connection_state ==
static_cast<uint8_t
>(ConnectionState::AUTHENTICATED)) {
1876 this->flags_.connection_state =
static_cast<uint8_t
>(ConnectionState::AUTHENTICATED);
1879 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"connected"));
1880#ifdef USE_API_CLIENT_CONNECTED_TRIGGER
1882 char peername[socket::SOCKADDR_STR_LEN];
1883 this->parent_->get_client_connected_trigger()->trigger(std::string(this->helper_->get_client_name()),
1884 std::string(this->helper_->get_peername_to(peername)));
1887#ifdef USE_HOMEASSISTANT_TIME
1889 this->send_time_request();
1892#ifdef USE_ZWAVE_PROXY
1902 this->client_api_version_major_ =
1903 static_cast<uint8_t
>(std::min<uint32_t>(msg.
api_version_major, std::numeric_limits<uint8_t>::max()));
1904 this->client_api_version_minor_ =
1905 static_cast<uint8_t
>(std::min<uint32_t>(msg.
api_version_minor, std::numeric_limits<uint8_t>::max()));
1906 char peername[socket::SOCKADDR_STR_LEN];
1907 ESP_LOGV(TAG,
"Hello from client: '%s' | %s | API Version %u.%u", this->helper_->get_client_name(),
1908 this->helper_->get_peername_to(peername), this->client_api_version_major_, this->client_api_version_minor_);
1917#ifdef USE_PROVISIONING
1922 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"Provisioning closed; rejecting connection"));
1923 if (!this->send_message(resp)) {
1924 API_LOG_MSG_DROPPED(TAG,
"Hello response");
1927 req.
reason = enums::DISCONNECT_REASON_PROVISIONING_CLOSED;
1928 return this->send_message(req);
1933 this->complete_authentication_();
1935#ifdef USE_API_OUTGOING_CONNECTION
1939 if (this->parent_->get_noise_ctx().has_psk()) {
1940 this->flags_.outgoing_connection_target =
true;
1941 this->parent_->on_outgoing_target_client(
this);
1943 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"Dial-back target refused; no key active"));
1948 return this->send_message(resp);
1951bool APIConnection::send_ping_response_() {
1953 return this->send_message(resp);
1956bool APIConnection::send_device_info_response_() {
1963 char mac_address[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1964 uint8_t mac[MAC_ADDRESS_SIZE];
1977#if defined(USE_ESP8266) || defined(USE_ESP32)
1978#define ESPHOME_MANUFACTURER "Espressif"
1979#elif defined(USE_RP2)
1980#define ESPHOME_MANUFACTURER "Raspberry Pi"
1981#elif defined(USE_BK72XX)
1982#define ESPHOME_MANUFACTURER "Beken"
1983#elif defined(USE_LN882X)
1984#define ESPHOME_MANUFACTURER "Lightning"
1985#elif defined(USE_NRF52)
1986#define ESPHOME_MANUFACTURER "Nordic Semiconductor"
1987#elif defined(USE_RTL87XX)
1988#define ESPHOME_MANUFACTURER "Realtek"
1989#elif defined(USE_HOST)
1990#define ESPHOME_MANUFACTURER "Host"
1995 static const char MANUFACTURER_PROGMEM[]
PROGMEM = ESPHOME_MANUFACTURER;
1996 char manufacturer_buf[
sizeof(MANUFACTURER_PROGMEM)];
1997 memcpy_P(manufacturer_buf, MANUFACTURER_PROGMEM,
sizeof(MANUFACTURER_PROGMEM));
2003 static_assert(
sizeof(ESPHOME_MANUFACTURER) - 1 <= 20,
"Update max_data_length for manufacturer in api.proto");
2004#undef ESPHOME_MANUFACTURER
2007 static const char MODEL_PROGMEM[]
PROGMEM = ESPHOME_BOARD;
2008 char model_buf[
sizeof(MODEL_PROGMEM)];
2009 memcpy_P(model_buf, MODEL_PROGMEM,
sizeof(MODEL_PROGMEM));
2015#ifdef USE_DEEP_SLEEP
2018#ifdef ESPHOME_PROJECT_NAME
2020 static const char PROJECT_NAME_PROGMEM[]
PROGMEM = ESPHOME_PROJECT_NAME;
2021 static const char PROJECT_VERSION_PROGMEM[]
PROGMEM = ESPHOME_PROJECT_VERSION;
2022 char project_name_buf[
sizeof(PROJECT_NAME_PROGMEM)];
2023 char project_version_buf[
sizeof(PROJECT_VERSION_PROGMEM)];
2024 memcpy_P(project_name_buf, PROJECT_NAME_PROGMEM,
sizeof(PROJECT_NAME_PROGMEM));
2025 memcpy_P(project_version_buf, PROJECT_VERSION_PROGMEM,
sizeof(PROJECT_VERSION_PROGMEM));
2038#ifdef USE_BLUETOOTH_PROXY
2040 char bluetooth_mac[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
2044#ifdef USE_VOICE_ASSISTANT
2047#ifdef USE_ZWAVE_PROXY
2051#ifdef USE_SERIAL_PROXY
2052 size_t serial_proxy_index = 0;
2054 if (serial_proxy_index >= SERIAL_PROXY_COUNT)
2057 info.name =
StringRef(proxy->get_name());
2058 info.port_type = proxy->get_port_type();
2059 info.configured_line_states = proxy->get_configured_modem_pins();
2064#ifndef USE_API_NOISE_PSK_FROM_YAML
2070#ifdef USE_API_OUTGOING_CONNECTION
2075 size_t device_index = 0;
2077 if (device_index >= ESPHOME_DEVICE_COUNT)
2079 auto &device_info = resp.
devices[device_index++];
2080 device_info.device_id = device->get_device_id();
2081 device_info.name =
StringRef(device->get_name());
2082 device_info.area_id = device->get_area_id();
2086 size_t area_index = 0;
2088 if (area_index >= ESPHOME_AREA_COUNT)
2090 auto &area_info = resp.
areas[area_index++];
2091 area_info.area_id = area->get_area_id();
2092 area_info.name =
StringRef(area->get_name());
2096 return this->send_message(resp);
2098bool APIConnection::send_device_capabilities_response_() {
2102#ifdef USE_BLUETOOTH_PROXY
2104 char bluetooth_mac[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
2108#ifdef USE_VOICE_ASSISTANT
2111#ifdef USE_ZWAVE_PROXY
2115#ifdef USE_SERIAL_PROXY
2116 size_t serial_proxy_index = 0;
2118 if (serial_proxy_index >= SERIAL_PROXY_COUNT)
2121 info.name =
StringRef(proxy->get_name());
2122 info.port_type = proxy->get_port_type();
2123 info.configured_line_states = proxy->get_configured_modem_pins();
2126#ifdef USE_API_WIZARD
2129#if defined(USE_SENDSPIN) && defined(USE_ESP_IDF)
2133 return this->send_message(resp);
2136 if (!this->send_hello_response_(msg)) {
2137 this->on_fatal_error();
2142 if (!this->send_disconnect_response_()) {
2143 this->on_fatal_error();
2146void APIConnection::on_ping_request() {
2147 if (!this->send_ping_response_()) {
2148 this->on_fatal_error();
2151void APIConnection::on_device_info_request() {
2152 if (!this->send_device_info_response_()) {
2153 this->on_fatal_error();
2156void APIConnection::on_device_capabilities_request() {
2157 if (!this->send_device_capabilities_response_()) {
2158 this->on_fatal_error();
2162#ifdef USE_API_HOMEASSISTANT_STATES
2178 for (
auto &it : this->parent_->get_state_subs()) {
2189 it.callback(msg.
state);
2193#ifdef USE_API_USER_DEFINED_ACTIONS
2201 if (!arg.string_.empty()) {
2202 const_cast<char *
>(arg.string_.c_str())[arg.string_.size()] =
'\0';
2206#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES
2211 action_call_id = this->parent_->register_active_action_call(msg.
call_id,
this);
2214 for (
auto *service : this->parent_->get_user_services()) {
2215 if (service->execute_service(msg, action_call_id)) {
2220 for (
auto *service : this->parent_->get_user_services()) {
2221 if (service->execute_service(msg)) {
2227 ESP_LOGV(TAG,
"Could not find service");
2233#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES
2234void APIConnection::send_execute_service_response(
uint32_t call_id,
bool success,
StringRef error_message) {
2239 if (!this->send_message(resp)) {
2240 API_LOG_MSG_DROPPED(TAG,
"Action response");
2243#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES_JSON
2244void APIConnection::send_execute_service_response(
uint32_t call_id,
bool success,
StringRef error_message,
2245 const uint8_t *response_data,
size_t response_data_len) {
2252 if (!this->send_message(resp)) {
2253 API_LOG_MSG_DROPPED(TAG,
"Action response");
2260#ifdef USE_API_HOMEASSISTANT_SERVICES
2262 if (!this->flags_.service_call_subscription)
2264 if (!this->send_message(call)) {
2265 API_LOG_MSG_DROPPED(TAG,
"Action request");
2271#ifdef USE_HOMEASSISTANT_TIME
2272void APIConnection::send_time_request() {
2274 if (!this->send_message(req)) {
2275 API_LOG_MSG_DROPPED(TAG,
"Time request");
2280#ifdef USE_API_HOMEASSISTANT_ACTION_RESPONSES
2282#ifdef USE_API_HOMEASSISTANT_ACTION_RESPONSES_JSON
2297#ifdef USE_API_NOISE_PSK_FROM_YAML
2299 ESP_LOGW(TAG,
"Key set in YAML");
2301#ifdef USE_PROVISIONING
2305 ESP_LOGW(TAG,
"Provisioning closed; rejecting key set");
2306 return this->send_message(resp);
2312 if (this->parent_->clear_noise_psk(
true)) {
2315 ESP_LOGW(TAG,
"Failed to clear encryption key");
2318 ESP_LOGW(TAG,
"Invalid encryption key length");
2322 ESP_LOGW(TAG,
"Rejecting all-zero encryption key");
2323 }
else if (!this->parent_->save_noise_psk(psk,
true)) {
2324 ESP_LOGW(TAG,
"Failed to save encryption key");
2327#ifdef USE_API_PLAINTEXT
2328 if (this->helper_->frame_footer_size() == 0) {
2331 ESP_LOGW(TAG,
"Key received over plaintext; deprecated, will be removed in 2027.2.0");
2337 return this->send_message(resp);
2340 if (!this->send_noise_encryption_set_key_response_(msg)) {
2341 this->on_fatal_error();
2345#ifdef USE_API_HOMEASSISTANT_STATES
2346void APIConnection::on_subscribe_home_assistant_states_request() {
2347#ifdef USE_API_WIZARD_LINKED_INPUTS
2349 this->flags_.home_assistant_states =
true;
2354bool APIConnection::try_to_clear_buffer_slow_(
bool log_out_of_space) {
2356 APIError err = this->helper_->loop();
2357 if (err != APIError::OK) {
2358 this->fatal_error_with_log_(LOG_STR(
"Socket operation failed"), err);
2361 if (this->helper_->can_write_without_blocking())
2363 if (log_out_of_space) {
2367 ESP_LOGVV(TAG,
"Cannot send message because of TCP buffer space");
2373#ifdef HAS_PROTO_MESSAGE_DUMP
2375 if (message_type != SubscribeLogsResponse::MESSAGE_TYPE
2377 && message_type != CameraImageResponse::MESSAGE_TYPE
2380 auto *proto_msg =
static_cast<const ProtoMessage *
>(msg);
2382 this->log_send_message_(proto_msg->message_name(), proto_msg->dump_to(dump_buf));
2385 if (!this->prepare_first_message_buffer(
payload_size)) [[unlikely]] {
2386 this->fatal_out_of_memory_();
2389 auto &shared_buf = this->parent_->get_shared_buffer_ref();
2390 size_t write_start = shared_buf.size();
2391#ifdef ESPHOME_DEBUG_API
2392 assert(shared_buf.capacity() >= write_start +
payload_size);
2396 uint8_t *
end = encode_fn(msg, shared_buf.data() + write_start PROTO_ENCODE_DEBUG_INIT(&shared_buf));
2397#ifdef ESPHOME_DEBUG_API
2409 return encode_to_buffer(calculated_size, encode_fn, msg, conn, remaining_size);
2412 const bool is_log_message = (message_type == SubscribeLogsResponse::MESSAGE_TYPE);
2414 if (!this->try_to_clear_buffer(!is_log_message)) {
2419 this->helper_->set_nodelay_for_message(is_log_message);
2421 APIError err = this->helper_->write_protobuf_packet(message_type,
buffer);
2422 if (err == APIError::WOULD_BLOCK)
2424 if (err != APIError::OK) {
2425 this->fatal_error_with_log_(LOG_STR(
"Packet write failed"), err);
2431void APIConnection::on_no_setup_connection() {
2432 this->on_fatal_error();
2433 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"no connection setup"));
2435void APIConnection::fatal_out_of_memory_() {
2436 this->fatal_error_with_log_(LOG_STR(
"Out of memory"), APIError::OUT_OF_MEMORY);
2438void APIConnection::on_fatal_error() {
2441 this->flags_.remove =
true;
2444bool APIConnection::schedule_message_front_(
EntityBase *entity, uint16_t message_type, uint8_t estimated_size) {
2445 this->deferred_batch_.add_item_front(entity, message_type, estimated_size);
2446 return this->schedule_batch_();
2449bool APIConnection::send_message_smart_(
EntityBase *entity, uint16_t message_type, uint8_t estimated_size,
2450 uint8_t aux_data_index) {
2451 if (this->should_send_immediately_(message_type) && this->helper_->can_write_without_blocking()) {
2455 if (!this->prepare_first_message_buffer(estimated_size)) [[unlikely]] {
2456 this->fatal_out_of_memory_();
2460 if (this->dispatch_message_(item, MAX_BATCH_PACKET_SIZE,
true) &&
2461 this->send_buffer(
ProtoWriteBuffer{&this->parent_->get_shared_buffer_ref()}, message_type)) {
2462#ifdef HAS_PROTO_MESSAGE_DUMP
2463 this->log_batch_item_(item);
2469 if (this->flags_.remove) [[unlikely]]
2472 return this->schedule_message_(entity, message_type, estimated_size, aux_data_index);
2475bool APIConnection::schedule_batch_() {
2476 if (!this->flags_.batch_scheduled) {
2477 this->flags_.batch_scheduled =
true;
2483void APIConnection::process_batch_() {
2484 if (this->deferred_batch_.empty()) {
2485 this->flags_.batch_scheduled =
false;
2494 this->helper_->set_nodelay_for_message(
false);
2497 if (!this->try_to_clear_buffer(
true)) {
2503 auto &shared_buf = this->parent_->get_shared_buffer_ref();
2504 size_t num_items = this->deferred_batch_.size();
2507 const uint8_t header_padding = this->helper_->frame_header_padding();
2508 const uint8_t footer_size = this->helper_->frame_footer_size();
2511 uint32_t total_estimated_size = num_items * (header_padding + footer_size);
2512 for (
size_t i = 0; i < num_items; i++) {
2513 total_estimated_size += this->deferred_batch_[i].estimated_size;
2516 if (total_estimated_size > MAX_BATCH_PACKET_SIZE) {
2517 total_estimated_size = MAX_BATCH_PACKET_SIZE;
2520 if (!this->prepare_first_message_buffer(header_padding, total_estimated_size)) [[unlikely]] {
2521 this->fatal_out_of_memory_();
2522 this->clear_batch_();
2527 if (num_items == 1) {
2528 const auto &item = this->deferred_batch_[0];
2530 uint16_t
payload_size = this->dispatch_message_(item, std::numeric_limits<uint16_t>::max(),
true);
2533#ifdef HAS_PROTO_MESSAGE_DUMP
2535 this->log_batch_item_(item);
2537 this->clear_batch_();
2541 if (!this->flags_.remove) {
2542 ESP_LOGW(TAG,
"Message too large to send: type=%u", item.message_type);
2544 this->clear_batch_();
2550 this->process_batch_multi_(shared_buf, num_items, header_padding, footer_size);
2555void APIConnection::process_batch_multi_(
APIBuffer &shared_buf,
size_t num_items, uint8_t header_padding,
2556 uint8_t footer_size) {
2558 static_assert(std::is_trivially_destructible<MessageInfo>::value,
2559 "MessageInfo must remain trivially destructible with this placement-new approach");
2561 const size_t messages_to_process = std::min(num_items, MAX_MESSAGES_PER_BATCH);
2566 size_t items_processed = 0;
2567 uint16_t remaining_size = std::numeric_limits<uint16_t>::max();
2574 for (
size_t i = 0; i < messages_to_process; i++) {
2575 const auto &item = this->deferred_batch_[i];
2578 uint16_t
payload_size = this->dispatch_message_(item, remaining_size, i == 0);
2587 uint16_t proto_payload_size =
payload_size - this->batch_header_size_ - footer_size;
2592 new (&message_info[items_processed++])
2593 MessageInfo(item.message_type, current_offset, proto_payload_size, this->batch_header_size_);
2595 if (items_processed == 1) {
2596 remaining_size = MAX_BATCH_PACKET_SIZE;
2601 current_offset = shared_buf.
size() + footer_size;
2604 if (items_processed > 0) {
2606 if (footer_size > 0 && !shared_buf.
resize(shared_buf.
size() + footer_size)) [[unlikely]] {
2607 this->fatal_out_of_memory_();
2608 this->clear_batch_();
2614 std::span<const MessageInfo>(message_info, items_processed));
2615 if (err != APIError::OK && err != APIError::WOULD_BLOCK) {
2616 this->fatal_error_with_log_(LOG_STR(
"Batch write failed"), err);
2619#ifdef HAS_PROTO_MESSAGE_DUMP
2622 for (
size_t i = 0; i < items_processed; i++) {
2623 const auto &item = this->deferred_batch_[i];
2624 this->log_batch_item_(item);
2629 if (items_processed < this->deferred_batch_.size()) {
2630 this->deferred_batch_.remove_front(items_processed);
2631 this->schedule_batch_();
2637 this->clear_batch_();
2644 this->flags_.batch_first_message = batch_first;
2648 if (item.
message_type == EventResponse::MESSAGE_TYPE) {
2654 this, remaining_size);
2662#define CASE_STATE_INFO(entity_name, StateResp, InfoResp) \
2663 case StateResp::MESSAGE_TYPE: \
2664 func = &try_send_##entity_name##_state; \
2666 case InfoResp::MESSAGE_TYPE: \
2667 func = &try_send_##entity_name##_info; \
2669#define CASE_INFO_ONLY(entity_name, InfoResp) \
2670 case InfoResp::MESSAGE_TYPE: \
2671 func = &try_send_##entity_name##_info; \
2675#ifdef USE_BINARY_SENSOR
2696#ifdef USE_TEXT_SENSOR
2705#ifdef USE_DATETIME_DATE
2708#ifdef USE_DATETIME_TIME
2711#ifdef USE_DATETIME_DATETIME
2726#ifdef USE_MEDIA_PLAYER
2729#ifdef USE_ALARM_CONTROL_PANEL
2732#ifdef USE_WATER_HEATER
2741#ifdef USE_RADIO_FREQUENCY
2751 case ListEntitiesDoneResponse::MESSAGE_TYPE:
2752 func = &try_send_list_info_done;
2754 case DisconnectRequest::MESSAGE_TYPE:
2755 func = &try_send_disconnect_request;
2757 case PingRequest::MESSAGE_TYPE:
2758 func = &try_send_ping_request;
2764#undef CASE_STATE_INFO
2765#undef CASE_INFO_ONLY
2767 return func(item.
entity,
this, remaining_size);
2772 return encode_message_to_buffer(resp, conn, remaining_size);
2777 return encode_message_to_buffer(req, conn, remaining_size);
2782 return encode_message_to_buffer(req, conn, remaining_size);
2785#ifdef USE_API_HOMEASSISTANT_STATES
2786void APIConnection::process_state_subscriptions_() {
2787 const auto &subs = this->parent_->get_state_subs();
2788 if (this->state_subs_at_ >=
static_cast<int>(subs.size())) {
2789 this->state_subs_at_ = -1;
2793 const auto &it = subs[this->state_subs_at_];
2794#ifdef USE_API_WIZARD_LINKED_INPUTS
2796 if (it.entity_id[0] ==
'\0') {
2797 this->state_subs_at_++;
2807 resp.
once = it.once;
2808 if (this->send_message(resp)) {
2809 this->state_subs_at_++;
2814void APIConnection::log_client_(
int level,
const LogString *
message) {
2815 char peername[socket::SOCKADDR_STR_LEN];
2816 esp_log_printf_(level, TAG, __LINE__, ESPHOME_LOG_FORMAT(
"%s (%s): %s"), this->helper_->get_client_name(),
2817 this->helper_->get_peername_to(peername), LOG_STR_ARG(
message));
2821 char peername[socket::SOCKADDR_STR_LEN];
2822 ESP_LOGW(TAG,
"%s (%s): %s %s errno=%d", this->helper_->get_client_name(), this->helper_->get_peername_to(peername),
const StringRef & get_name() const
Get the name of this Application set by pre_setup().
static constexpr size_t BUILD_TIME_STR_SIZE
Size of buffer required for build time string (including null terminator)
const StringRef & get_friendly_name() const
Get the friendly name of this Application set by pre_setup().
void get_build_time_string(std::span< char, BUILD_TIME_STR_SIZE > buffer)
Copy the build time string into the provided buffer Buffer must be BUILD_TIME_STR_SIZE bytes (compile...
const char * get_area() const
Get the area of this Application set by pre_setup().
const auto & get_devices()
auto & get_serial_proxies() const
uint32_t IRAM_ATTR HOT get_loop_component_start_time() const
Get the cached time in milliseconds from when the current component started its loop execution.
void begin(bool include_internal=false)
ESPHOME_ALWAYS_INLINE void try_advance(size_t max_steps)
Run up to max_steps iteration steps; stops early when iteration completes or a callback refuses (that...
const char * get_device_class_to(std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const
bool has_own_name() const
const StringRef & get_name() const
const char * get_icon_to(std::span< char, MAX_ICON_LENGTH > buffer) const
uint32_t get_object_id_hash() const
uint32_t get_device_id() const
bool is_disabled_by_default() const
EntityCategory get_entity_category() const
Fixed-capacity vector - sized once through init() or try_init(); push_back never reallocates This avo...
void push_back(const T &value)
Add element without bounds checking Caller must ensure sufficient capacity was allocated via init() S...
StringRef is a reference to a string owned by something else.
constexpr const char * c_str() const
constexpr bool empty() const
constexpr size_type size() const
static constexpr StringRef from_lit(const CharT(&s)[N])
static StringRef from_maybe_nullptr(const char *s)
Byte buffer that skips zero-initialization on resize().
bool resize(size_t n) ESPHOME_ALWAYS_INLINE
Returns false if allocation fails; the buffer is left unchanged. No zero-fill.
void on_button_command_request(const ButtonCommandRequest &msg)
ProtoEncodeFn MessageEncodeFn
APIConnection(std::unique_ptr< socket::Socket > socket, APIServer *parent)
uint16_t(*)(EntityBase *, APIConnection *, uint32_t remaining_size) MessageCreatorPtr
uint32_t(*)(const void *) CalculateSizeFn
uint8_t get_consumed_header(uint8_t out[3]) const
noise::NoiseContext & get_noise_ctx()
enums::AlarmControlPanelStateCommand command
enums::AlarmControlPanelState state
enums::BluetoothScannerMode mode
void set_data(const uint8_t *data, size_t len)
bool has_target_temperature_high
float target_temperature_low
bool has_target_temperature_low
StringRef custom_fan_mode
float target_temperature_high
enums::ClimateSwingMode swing_mode
enums::ClimateFanMode fan_mode
bool has_target_temperature
enums::ClimatePreset preset
enums::ClimateFanMode fan_mode
float target_temperature_low
enums::ClimateSwingMode swing_mode
enums::ClimateAction action
enums::ClimatePreset preset
StringRef custom_fan_mode
float current_temperature
float target_temperature_high
enums::CoverOperation current_operation
std::array< SerialProxyInfo, SERIAL_PROXY_COUNT > serial_proxies
VoiceAssistantCapabilities voice_assistant
WizardCapabilities wizard
ZWaveProxyCapabilities zwave_proxy
SendspinCapabilities sendspin
BluetoothProxyCapabilities bluetooth_proxy
bool api_outgoing_connection_supported
bool api_encryption_provisionable
StringRef project_version
uint32_t zwave_proxy_feature_flags
StringRef esphome_version
std::array< AreaInfo, ESPHOME_AREA_COUNT > areas
StringRef bluetooth_mac_address
uint32_t bluetooth_proxy_feature_flags
StringRef compilation_time
uint32_t voice_assistant_feature_flags
bool api_encryption_supported
std::array< SerialProxyInfo, SERIAL_PROXY_COUNT > serial_proxies
std::array< DeviceInfo, ESPHOME_DEVICE_COUNT > devices
enums::DisconnectReason reason
Fixed-size buffer for message dumps - avoids heap allocation.
uint16_t response_data_len
const uint8_t * response_data
enums::FanDirection direction
enums::FanDirection direction
ParsedTimezone parsed_timezone
uint32_t api_version_major
uint32_t api_version_minor
bool outgoing_connection_target
uint32_t api_version_minor
uint32_t api_version_major
const uint8_t * response_data
uint16_t response_data_len
enums::EntityCategory entity_category
const uint8_t * timings_data_
uint32_t carrier_frequency
bool has_color_temperature
enums::ColorMode color_mode
bool has_transition_length
uint32_t transition_length
bool has_color_brightness
enums::ColorMode color_mode
bool requires_code_to_arm
uint32_t supported_features
bool is_status_binary_sensor
const std::vector< const char * > * supported_custom_presets
const climate::ClimateSwingModeMask * supported_swing_modes
enums::TemperatureUnit temperature_unit
float visual_max_humidity
const std::vector< const char * > * supported_custom_fan_modes
bool supports_current_temperature
bool supports_current_humidity
bool supports_target_humidity
float visual_min_humidity
float visual_max_temperature
float visual_target_temperature_step
bool supports_two_point_target_temperature
const climate::ClimatePresetMask * supported_presets
const climate::ClimateFanModeMask * supported_fan_modes
const climate::ClimateModeMask * supported_modes
float visual_min_temperature
float visual_current_temperature_step
const FixedVector< const char * > * event_types
const std::vector< const char * > * supported_preset_modes
int32_t supported_speed_count
bool supports_oscillation
uint32_t receiver_frequency
const FixedVector< const char * > * effects
const light::ColorModeMask * supported_color_modes
StringRef unit_of_measurement
uint32_t supported_modulations
const std::span< const char *const > * options
int32_t accuracy_decimals
StringRef unit_of_measurement
enums::SensorStateClass state_class
enums::TemperatureUnit temperature_unit
float target_temperature_step
const water_heater::WaterHeaterModeMask * supported_modes
uint32_t supported_features
enums::LockCommand command
enums::SendspinPairingTokenStatus status
enums::SerialProxyRequestType type
enums::SerialProxyMode mode
void set_message(const uint8_t *data, size_t len)
enums::UpdateCommand command
StringRef current_version
StringRef release_summary
enums::ValveOperation current_operation
std::vector< VoiceAssistantWakeWord > available_wake_words
uint32_t max_active_wake_words
const std::vector< std::string > * active_wake_words
std::vector< std::string > active_wake_words
float target_temperature_low
enums::WaterHeaterMode mode
float target_temperature_high
float current_temperature
float target_temperature_low
float target_temperature_high
enums::WaterHeaterMode mode
enums::ZWaveProxyRequestType type
enums::ZWaveProxyRequestType type
Base class for all binary_sensor-type classes.
void bluetooth_gatt_read(const api::BluetoothGATTReadRequest &msg)
void bluetooth_gatt_send_services(const api::BluetoothGATTGetServicesRequest &msg)
void get_bluetooth_mac_address_pretty(std::span< char, MAC_ADDRESS_PRETTY_BUFFER_SIZE > output)
void bluetooth_device_request(const api::BluetoothDeviceRequest &msg)
void bluetooth_gatt_write_descriptor(const api::BluetoothGATTWriteDescriptorRequest &msg)
void bluetooth_scanner_set_mode(bool active)
void subscribe_api_connection(api::APIConnection *api_connection, uint32_t flags)
uint32_t get_feature_flags() const
void send_connections_free()
void unsubscribe_api_connection(api::APIConnection *api_connection)
void bluetooth_set_connection_params(const api::BluetoothSetConnectionParamsRequest &msg)
void bluetooth_gatt_read_descriptor(const api::BluetoothGATTReadDescriptorRequest &msg)
void bluetooth_gatt_write(const api::BluetoothGATTWriteRequest &msg)
void bluetooth_gatt_notify(const api::BluetoothGATTNotifyRequest &msg)
Abstract camera base class.
virtual CameraImageReader * create_image_reader()=0
Returns a new camera image reader that keeps track of the JPEG data in the camera image.
virtual void start_stream(CameraRequester requester)=0
virtual void stop_stream(CameraRequester requester)=0
virtual void request_image(CameraRequester requester)=0
static Camera * instance()
The singleton instance of the camera implementation.
ClimateDevice - This is the base class for all climate integrations.
Base class for all cover devices.
uint8_t get_last_event_type_index() const
Return index of last triggered event type, or max uint8_t if no event triggered yet.
void set_epoch_time(uint32_t epoch)
Infrared - Base class for infrared remote control implementations.
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Base class for all locks.
static bool is_all_zeros(const psk_t &psk)
Base-class for all numbers.
RadioFrequency - Base class for radio frequency implementations.
Base-class for all selects.
uint32_t get_feature_flags() const
Returns the SendspinFeature flags reported to API clients.
std::optional< std::string > get_pairing_token() const
Returns the pairing token a Sendspin server uses to pair with this device.
StringRef get_client_id() const
Returns the Sendspin client_id: base64url of the client's static public key.
Base-class for all sensors.
Base class for all switches.
Base-class for all text inputs.
Base class for all valve devices.
const Configuration & get_configuration()
void on_timer_event(const api::VoiceAssistantTimerEventResponse &msg)
void on_audio(const api::VoiceAssistantAudio &msg)
void client_subscription(api::APIConnection *client, bool subscribe)
void on_event(const api::VoiceAssistantEventResponse &msg)
void on_announce(const api::VoiceAssistantAnnounceRequest &msg)
api::APIConnection * get_api_connection() const
uint32_t get_feature_flags() const
void on_set_configuration(const std::vector< std::string > &active_wake_words)
uint32_t get_feature_flags() const
void send_frame(api::APIConnection *api_connection, const uint8_t *data, size_t length)
void api_connection_authenticated(api::APIConnection *conn)
api::enums::ZWaveProxyStatus zwave_proxy_request(api::APIConnection *api_connection, api::enums::ZWaveProxyRequestType type)
const LogString * message
const LogString * api_error_to_logstr(APIError err)
void proto_check_encode_end(const uint8_t *end, const uint8_t *expected)
Aborts unless an encode body ended exactly where calculate_size() promised.
void log_dropped_message(const char *tag, int line, const LogString *what)
BluetoothProxy * global_bluetooth_proxy
@ CLIMATE_SUPPORTS_CURRENT_HUMIDITY
@ CLIMATE_SUPPORTS_TARGET_HUMIDITY
@ CLIMATE_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE
@ CLIMATE_SUPPORTS_CURRENT_TEMPERATURE
@ CLIMATE_SUPPORTS_ACTION
@ CLIMATE_REQUIRES_TWO_POINT_TARGET_TEMPERATURE
ClimatePreset
Enum for all preset modes NOTE: If adding values, update ClimatePresetMask in climate_traits....
ClimateSwingMode
Enum for all modes a climate swing can be in NOTE: If adding values, update ClimateSwingModeMask in c...
ClimateMode
Enum for all modes a climate device can be in.
ClimateFanMode
NOTE: If adding values, update ClimateFanModeMask in climate_traits.h to use the new last value.
bool global_has_deep_sleep
FanDirection
Simple enum to represent the direction of a fan.
HomeassistantTime * global_homeassistant_time
ColorMode
Color modes are a combination of color capabilities that can be used at the same time.
@ COLOR_TEMPERATURE
Color temperature can be controlled.
@ COLD_WARM_WHITE
Brightness of cold and warm white output can be controlled.
std::array< uint8_t, 32 > psk_t
ProvisioningManager * global_provisioning_manager
RadioFrequencyModulation
Modulation types supported by radio frequency implementations.
SendspinHub * global_sendspin_hub
SerialProxyResult
Result of a client-initiated operation; mapped to api::enums::SerialProxyStatus by the API layer.
@ SERIAL_PROXY_RESULT_TIMEOUT
Timed out before TX completed.
@ SERIAL_PROXY_RESULT_ERROR
Driver or hardware error.
@ SERIAL_PROXY_RESULT_NOT_SUPPORTED
Requested feature is not available on this instance.
@ SERIAL_PROXY_RESULT_PORT_IN_USE
Denied: another live client holds the port.
@ SERIAL_PROXY_RESULT_OK
Operation completed or request accepted.
@ SERIAL_PROXY_RESULT_INVALID_ARGUMENT
A parameter value is out of range.
@ SERIAL_PROXY_RESULT_ASSUMED_SUCCESS
Platform cannot confirm TX drain; success assumed.
void set_global_tz(const ParsedTimezone &tz)
Set the global timezone used by epoch_to_local_tm() when called without a timezone.
DSTRuleType
Type of DST transition rule.
@ UPDATE_STATE_INSTALLING
VoiceAssistant * global_voice_assistant
@ WATER_HEATER_STATE_ON
Water heater is on (not in standby)
@ WATER_HEATER_STATE_AWAY
Away/vacation mode is currently active.
ZWaveProxy * global_zwave_proxy
void HOT esp_log_printf_(int level, const char *tag, int line, const char *format,...)
std::vector< uint8_t > base64_decode(const std::string &encoded_string)
Decode a base64 string to a byte vector.
void get_mac_address_raw(uint8_t *mac)
Get the device MAC address as raw bytes, written into the provided byte array (6 bytes).
void HOT delay(uint32_t ms)
Application App
Global storage of Application pointer - only one Application can exist.
char * format_mac_addr_upper(const uint8_t *mac, char *output)
Format MAC address as XX:XX:XX:XX:XX:XX (uppercase, colon separators)
A more user-friendly version of struct tm from time.h.
uint16_t day
Day of year (for JULIAN_NO_LEAP and DAY_OF_YEAR)
DSTRuleType type
Type of rule.
uint8_t week
Week 1-5, 5 = last (for MONTH_WEEK_DAY)
int32_t time_seconds
Seconds after midnight (default 7200 = 2:00 AM)
uint8_t day_of_week
Day 0-6, 0 = Sunday (for MONTH_WEEK_DAY)
uint8_t month
Month 1-12 (for MONTH_WEEK_DAY)
Parsed POSIX timezone information (packed for 32-bit: 32 bytes)
DSTRule dst_end
When DST ends.
DSTRule dst_start
When DST starts.
int32_t dst_offset_seconds
DST offset from UTC in seconds.
int32_t std_offset_seconds
Standard time offset from UTC in seconds (positive = west)
const uint8_t ESPHOME_WEBSERVER_INDEX_HTML[] PROGMEM