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#ifdef USE_WATER_HEATER
57#ifdef USE_RADIO_FREQUENCY
67static constexpr uint8_t MAX_MESSAGES_PER_LOOP = 10;
68static constexpr uint8_t MAX_PING_RETRIES = 60;
69static constexpr uint16_t PING_RETRY_INTERVAL = 1000;
70static constexpr uint32_t KEEPALIVE_DISCONNECT_TIMEOUT = (KEEPALIVE_TIMEOUT_MS * 5) / 2;
79static constexpr uint32_t HANDSHAKE_TIMEOUT_MS = 60000;
84static_assert(MAC_ADDRESS_PRETTY_BUFFER_SIZE - 1 == 17,
85 "Update max_data_length for mac_address/bluetooth_mac_address in api.proto");
87static_assert(
sizeof(ESPHOME_VERSION) - 1 <= 32,
"Update max_data_length for esphome_version in api.proto");
88static_assert(ESPHOME_DEVICE_NAME_MAX_LEN <= 31,
"Update max_data_length for name in api.proto");
89static_assert(ESPHOME_FRIENDLY_NAME_MAX_LEN <= 120,
"Update max_data_length for friendly_name in api.proto");
91static const char *
const TAG =
"api.connection";
93#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_WARN
95 esp_log_printf_(ESPHOME_LOG_LEVEL_WARN, tag, line, ESPHOME_LOG_FORMAT(
"%s dropped, TCP buffer full"),
100static const int CAMERA_STOP_STREAM = 5000;
106#define ENTITY_COMMAND_MAKE_CALL(entity_type, entity_var, getter_name) \
107 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key, msg.device_id); \
108 if ((entity_var) == nullptr) \
110 auto call = (entity_var)->make_call();
114#define ENTITY_COMMAND_GET(entity_type, entity_var, getter_name) \
115 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key, msg.device_id); \
116 if ((entity_var) == nullptr) \
121#define ENTITY_COMMAND_LOOKUP(entity_type, entity_var, getter_name) \
122 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key, msg.device_id)
127#define ENTITY_COMMAND_MAKE_CALL(entity_type, entity_var, getter_name) \
128 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key); \
129 if ((entity_var) == nullptr) \
131 auto call = (entity_var)->make_call();
135#define ENTITY_COMMAND_GET(entity_type, entity_var, getter_name) \
136 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key); \
137 if ((entity_var) == nullptr) \
142#define ENTITY_COMMAND_LOOKUP(entity_type, entity_var, getter_name) \
143 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key)
148#if defined(USE_API_PLAINTEXT) && defined(USE_API_NOISE)
150 if (noise_ctx.has_psk()) {
151 this->helper_ = std::unique_ptr<APIFrameHelper>{new APINoiseFrameHelper(std::move(sock), noise_ctx)};
155#elif defined(USE_API_PLAINTEXT)
156 this->helper_ = std::unique_ptr<APIPlaintextFrameHelper>{
new APIPlaintextFrameHelper(std::move(sock))};
157#elif defined(USE_API_NOISE)
159 std::unique_ptr<APINoiseFrameHelper>{
new APINoiseFrameHelper(std::move(sock), parent->get_noise_ctx())};
161#error "No frame helper defined"
165void APIConnection::start() {
168 APIError err = this->helper_->init();
169 if (err != APIError::OK) {
170 this->fatal_error_with_log_(LOG_STR(
"Helper init failed"), err);
174 char peername[socket::SOCKADDR_STR_LEN];
175 this->helper_->set_client_name(this->helper_->get_peername_to(peername), strlen(peername));
178APIConnection::~APIConnection() {
179 this->destroy_active_iterator_();
180#ifdef USE_BLUETOOTH_PROXY
185#ifdef USE_VOICE_ASSISTANT
190#ifdef USE_ZWAVE_PROXY
195#ifdef USE_SERIAL_PROXY
197 if (proxy->get_api_connection() ==
this) {
198 proxy->serial_proxy_request(
this, enums::SERIAL_PROXY_REQUEST_TYPE_UNSUBSCRIBE);
204#if defined(USE_API_NOISE) && defined(USE_API_PLAINTEXT)
205void APIConnection::upgrade_helper_to_noise_() {
215 auto *noise =
new APINoiseFrameHelper(plaintext->release_socket_for_switch(), this->parent_->get_noise_ctx());
217 const char *name = plaintext->get_client_name();
218 noise->set_client_name(name, strlen(name));
219 this->helper_.reset(noise);
220 APIError err = noise->init_from_handoff(header, header_len);
221 if (err != APIError::OK) {
222 this->fatal_error_with_log_(LOG_STR(
"Noise handoff failed"), err);
227void APIConnection::destroy_active_iterator_() {
228 switch (this->active_iterator_) {
229 case ActiveIterator::LIST_ENTITIES:
230 this->iterator_storage_.list_entities.~ListEntitiesIterator();
232 case ActiveIterator::INITIAL_STATE:
233 this->iterator_storage_.initial_state.~InitialStateIterator();
235 case ActiveIterator::NONE:
238 this->active_iterator_ = ActiveIterator::NONE;
242 this->destroy_active_iterator_();
243 this->active_iterator_ =
type;
244 if (
type == ActiveIterator::LIST_ENTITIES) {
246 this->iterator_storage_.list_entities.
begin();
249 this->iterator_storage_.initial_state.
begin();
253void APIConnection::loop() {
254 if (this->flags_.next_close) {
257 this->flags_.remove =
true;
261 APIError err = this->helper_->loop();
262 if (err != APIError::OK) {
263 this->fatal_error_with_log_(LOG_STR(
"Socket operation failed"), err);
274 if (this->helper_->is_socket_ready() || this->flags_.may_have_remaining_data) {
275 this->flags_.may_have_remaining_data =
false;
277 uint8_t message_count = 0;
278 for (; message_count < MAX_MESSAGES_PER_LOOP; message_count++) {
280 err = this->helper_->read_packet(&buffer);
281 if (err == APIError::WOULD_BLOCK) {
284 }
else if (err != APIError::OK) {
285#if defined(USE_API_NOISE) && defined(USE_API_PLAINTEXT)
289 if (err == APIError::PROTOCOL_SWITCH_TO_NOISE) {
290 this->upgrade_helper_to_noise_();
294 this->fatal_error_with_log_(LOG_STR(
"Reading failed"), err);
300 if (this->is_authenticated()) {
301 this->last_traffic_ = now;
305 if (this->flags_.remove)
311 if (message_count == MAX_MESSAGES_PER_LOOP) {
312 this->flags_.may_have_remaining_data =
true;
317 if (this->flags_.batch_scheduled && now - this->deferred_batch_.batch_start_time >= this->get_batch_delay_ms_()) {
318 this->process_batch_();
321 if (this->active_iterator_ != ActiveIterator::NONE) {
322 this->process_active_iterator_();
328 if (!this->is_authenticated() && now - this->last_traffic_ > HANDSHAKE_TIMEOUT_MS) {
329 this->on_fatal_error();
330 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"handshake timeout; disconnecting"));
337 if (now - this->last_traffic_ > KEEPALIVE_TIMEOUT_MS) {
338 this->check_keepalive_(now);
341#ifdef USE_API_HOMEASSISTANT_STATES
342 if (state_subs_at_ >= 0) {
343 this->process_state_subscriptions_();
350 this->try_send_camera_image_();
354void APIConnection::check_keepalive_(
uint32_t now) {
356 if (this->flags_.sent_ping) {
358 if (now - this->last_traffic_ > KEEPALIVE_DISCONNECT_TIMEOUT) {
360 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"is unresponsive; disconnecting"));
362 }
else if (!this->flags_.remove) {
364 ESP_LOGVV(TAG,
"Sending keepalive PING");
366 this->flags_.sent_ping = this->send_message(req);
367 if (this->flags_.sent_ping) {
369 this->helper_->release_overflow_buffer();
373 ESP_LOGW(TAG,
"Buffer full, ping queued");
374 this->schedule_message_front_(
nullptr, PingRequest::MESSAGE_TYPE, PingRequest::ESTIMATED_SIZE);
375 this->flags_.sent_ping =
true;
380void APIConnection::process_active_iterator_() {
382 if (this->active_iterator_ == ActiveIterator::LIST_ENTITIES) {
383 if (this->iterator_storage_.list_entities.completed()) {
384 this->destroy_active_iterator_();
385 if (this->flags_.state_subscription) {
386 this->begin_iterator_(ActiveIterator::INITIAL_STATE);
388 this->finalize_iterator_sync_();
391 this->process_iterator_batch_(this->iterator_storage_.list_entities);
394 if (this->iterator_storage_.initial_state.completed()) {
395 this->destroy_active_iterator_();
396 this->finalize_iterator_sync_();
398 this->process_iterator_batch_(this->iterator_storage_.initial_state);
403void APIConnection::finalize_iterator_sync_() {
407 if (!this->deferred_batch_.empty()) {
408 this->process_batch_();
411 this->flags_.should_try_send_immediately =
true;
413 this->deferred_batch_.release_buffer();
414 this->helper_->release_buffers();
420 size_t batch_size = this->deferred_batch_.size();
421 if (batch_size < MAX_INITIAL_BATCH_SIZE)
422 iterator.
try_advance(MAX_INITIAL_BATCH_SIZE - batch_size);
426 if (this->deferred_batch_.size() >= MAX_INITIAL_BATCH_SIZE) {
427 this->process_batch_();
431bool APIConnection::send_disconnect_response_() {
435 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"disconnected"));
436 this->flags_.next_close =
true;
438 return this->send_message(resp);
440void APIConnection::on_disconnect_response() {
443 this->flags_.remove =
true;
453 return encode_to_buffer(size_fn(&msg), encode_fn, &msg, conn, remaining_size);
467#ifdef USE_ENTITY_ICON
468 char icon_buf[MAX_ICON_LENGTH];
476 return encode_to_buffer_slow(size_fn(&msg), encode_fn, &msg, conn, remaining_size);
484 char dc_buf[MAX_DEVICE_CLASS_LENGTH];
486 return fill_and_encode_entity_info(entity, msg, size_fn, encode_fn, conn, remaining_size);
489#ifdef USE_BINARY_SENSOR
491 return this->send_message_smart_(binary_sensor, BinarySensorStateResponse::MESSAGE_TYPE,
492 BinarySensorStateResponse::ESTIMATED_SIZE);
498 resp.
state = binary_sensor->state;
500 return fill_and_encode_entity_state(binary_sensor, resp, conn, remaining_size);
507 return fill_and_encode_entity_info_with_device_class(binary_sensor, msg, msg.
device_class, conn, remaining_size);
513 return this->send_message_smart_(cover, CoverStateResponse::MESSAGE_TYPE, CoverStateResponse::ESTIMATED_SIZE);
518 auto traits = cover->get_traits();
520 if (traits.get_supports_tilt())
521 msg.
tilt = cover->tilt;
523 return fill_and_encode_entity_state(cover, msg, conn, remaining_size);
528 auto traits = cover->get_traits();
533 return fill_and_encode_entity_info_with_device_class(cover, msg, msg.
device_class, conn, remaining_size);
540 call.set_tilt(msg.
tilt);
542 call.set_command_stop();
549 return this->send_message_smart_(fan, FanStateResponse::MESSAGE_TYPE, FanStateResponse::ESTIMATED_SIZE);
552 auto *fan =
static_cast<fan::Fan *
>(entity);
554 auto traits = fan->get_traits();
555 msg.
state = fan->state;
556 if (traits.supports_oscillation())
558 if (traits.supports_speed()) {
561 if (traits.supports_direction())
563 if (traits.supports_preset_modes() && fan->has_preset_mode())
565 return fill_and_encode_entity_state(fan, msg, conn, remaining_size);
568 auto *fan =
static_cast<fan::Fan *
>(entity);
570 auto traits = fan->get_traits();
576 return fill_and_encode_entity_info(fan, msg, conn, remaining_size);
579 ENTITY_COMMAND_MAKE_CALL(
fan::Fan, fan, fan)
581 call.set_state(msg.
state);
598 return this->send_message_smart_(light, LightStateResponse::MESSAGE_TYPE, LightStateResponse::ESTIMATED_SIZE);
603 auto values = light->remote_values;
604 auto color_mode = values.get_color_mode();
605 resp.
state = values.is_on();
609 resp.
red = values.get_red();
610 resp.
green = values.get_green();
611 resp.
blue = values.get_blue();
612 resp.
white = values.get_white();
616 if (light->supports_effects()) {
617 resp.
effect = light->get_effect_name();
619 return fill_and_encode_entity_state(light, resp, conn, remaining_size);
624 auto traits = light->get_traits();
625 auto supported_modes = traits.get_supported_color_modes();
634 if (light->supports_effects()) {
635 auto &light_effects = light->get_effects();
636 effects_list.
init(light_effects.size() + 1);
638 for (
auto *effect : light_effects) {
640 effects_list.
push_back(effect->get_name().c_str());
644 return fill_and_encode_entity_info(light, msg, conn, remaining_size);
649 call.set_state(msg.
state);
657 call.set_red(msg.
red);
658 call.set_green(msg.
green);
659 call.set_blue(msg.
blue);
662 call.set_white(msg.
white);
681 return this->send_message_smart_(sensor, SensorStateResponse::MESSAGE_TYPE, SensorStateResponse::ESTIMATED_SIZE);
687 resp.
state = sensor->state;
689 return fill_and_encode_entity_state(sensor, resp, conn, remaining_size);
699 return fill_and_encode_entity_info_with_device_class(sensor, msg, msg.
device_class, conn, remaining_size);
705 return this->send_message_smart_(a_switch, SwitchStateResponse::MESSAGE_TYPE, SwitchStateResponse::ESTIMATED_SIZE);
711 resp.
state = a_switch->state;
712 return fill_and_encode_entity_state(a_switch, resp, conn, remaining_size);
719 return fill_and_encode_entity_info_with_device_class(a_switch, msg, msg.
device_class, conn, remaining_size);
727 a_switch->turn_off();
732#ifdef USE_TEXT_SENSOR
734 return this->send_message_smart_(text_sensor, TextSensorStateResponse::MESSAGE_TYPE,
735 TextSensorStateResponse::ESTIMATED_SIZE);
743 return fill_and_encode_entity_state(text_sensor, resp, conn, remaining_size);
748 return fill_and_encode_entity_info_with_device_class(text_sensor, msg, msg.
device_class, conn, remaining_size);
754 return this->send_message_smart_(climate, ClimateStateResponse::MESSAGE_TYPE, ClimateStateResponse::ESTIMATED_SIZE);
759 auto traits = climate->get_traits();
771 if (traits.get_supports_fan_modes() && climate->fan_mode.has_value())
773 if (!traits.get_supported_custom_fan_modes().empty() && climate->has_custom_fan_mode()) {
776 if (traits.get_supports_presets() && climate->preset.has_value()) {
779 if (!traits.get_supported_custom_presets().empty() && climate->has_custom_preset()) {
782 if (traits.get_supports_swing_modes())
788 return fill_and_encode_entity_state(climate, resp, conn, remaining_size);
793 auto traits = climate->get_traits();
816 return fill_and_encode_entity_info(climate, msg, conn, remaining_size);
846 return this->send_message_smart_(number, NumberStateResponse::MESSAGE_TYPE, NumberStateResponse::ESTIMATED_SIZE);
852 resp.
state = number->state;
854 return fill_and_encode_entity_state(number, resp, conn, remaining_size);
862 msg.
min_value = number->traits.get_min_value();
863 msg.
max_value = number->traits.get_max_value();
864 msg.
step = number->traits.get_step();
865 return fill_and_encode_entity_info_with_device_class(number, msg, msg.
device_class, conn, remaining_size);
869 call.set_value(msg.
state);
874#ifdef USE_DATETIME_DATE
876 return this->send_message_smart_(date, DateStateResponse::MESSAGE_TYPE, DateStateResponse::ESTIMATED_SIZE);
882 resp.
year = date->year;
883 resp.
month = date->month;
884 resp.
day = date->day;
885 return fill_and_encode_entity_state(date, resp, conn, remaining_size);
890 return fill_and_encode_entity_info(date, msg, conn, remaining_size);
899#ifdef USE_DATETIME_TIME
901 return this->send_message_smart_(time, TimeStateResponse::MESSAGE_TYPE, TimeStateResponse::ESTIMATED_SIZE);
907 resp.
hour = time->hour;
908 resp.
minute = time->minute;
909 resp.
second = time->second;
910 return fill_and_encode_entity_state(time, resp, conn, remaining_size);
915 return fill_and_encode_entity_info(time, msg, conn, remaining_size);
924#ifdef USE_DATETIME_DATETIME
926 return this->send_message_smart_(datetime, DateTimeStateResponse::MESSAGE_TYPE,
927 DateTimeStateResponse::ESTIMATED_SIZE);
933 if (datetime->has_state()) {
937 return fill_and_encode_entity_state(datetime, resp, conn, remaining_size);
942 return fill_and_encode_entity_info(datetime, msg, conn, remaining_size);
953 return this->send_message_smart_(text, TextStateResponse::MESSAGE_TYPE, TextStateResponse::ESTIMATED_SIZE);
957 auto *text =
static_cast<text::Text *
>(entity);
961 return fill_and_encode_entity_state(text, resp, conn, remaining_size);
965 auto *text =
static_cast<text::Text *
>(entity);
968 msg.
min_length = text->traits.get_min_length();
969 msg.
max_length = text->traits.get_max_length();
970 msg.
pattern = text->traits.get_pattern_ref();
971 return fill_and_encode_entity_info(text, msg, conn, remaining_size);
974 ENTITY_COMMAND_MAKE_CALL(
text::Text, text, text)
982 return this->send_message_smart_(select, SelectStateResponse::MESSAGE_TYPE, SelectStateResponse::ESTIMATED_SIZE);
988 resp.
state = select->current_option();
990 return fill_and_encode_entity_state(select, resp, conn, remaining_size);
996 msg.
options = &select->traits.get_options();
997 return fill_and_encode_entity_info(select, msg, conn, remaining_size);
1010 return fill_and_encode_entity_info_with_device_class(button, msg, msg.
device_class, conn, remaining_size);
1020 return this->send_message_smart_(a_lock, LockStateResponse::MESSAGE_TYPE, LockStateResponse::ESTIMATED_SIZE);
1024 auto *a_lock =
static_cast<lock::Lock *
>(entity);
1027 return fill_and_encode_entity_state(a_lock, resp, conn, remaining_size);
1031 auto *a_lock =
static_cast<lock::Lock *
>(entity);
1036 return fill_and_encode_entity_info(a_lock, msg, conn, remaining_size);
1042 case enums::LOCK_UNLOCK:
1045 case enums::LOCK_LOCK:
1048 case enums::LOCK_OPEN:
1057 return this->send_message_smart_(valve, ValveStateResponse::MESSAGE_TYPE, ValveStateResponse::ESTIMATED_SIZE);
1064 return fill_and_encode_entity_state(valve, resp, conn, remaining_size);
1069 auto traits = valve->get_traits();
1073 return fill_and_encode_entity_info_with_device_class(valve, msg, msg.
device_class, conn, remaining_size);
1080 call.set_command_stop();
1085#ifdef USE_MEDIA_PLAYER
1087 return this->send_message_smart_(media_player, MediaPlayerStateResponse::MESSAGE_TYPE,
1088 MediaPlayerStateResponse::ESTIMATED_SIZE);
1095 : media_player->state;
1097 resp.
volume = media_player->volume;
1098 resp.
muted = media_player->is_muted();
1099 return fill_and_encode_entity_state(media_player, resp, conn, remaining_size);
1104 auto traits = media_player->get_traits();
1106 for (
auto &supported_format : traits.get_supported_formats()) {
1109 media_format.format =
StringRef(supported_format.format);
1110 media_format.sample_rate = supported_format.sample_rate;
1111 media_format.num_channels = supported_format.num_channels;
1113 media_format.sample_bytes = supported_format.sample_bytes;
1115 return fill_and_encode_entity_info(media_player, msg, conn, remaining_size);
1123 call.set_volume(msg.
volume);
1136void APIConnection::try_send_camera_image_() {
1137 if (!this->image_reader_)
1142 while (this->image_reader_->available()) {
1143 if (!this->helper_->can_write_without_blocking())
1146 uint32_t to_send = std::min((
size_t) MAX_BATCH_PACKET_SIZE, this->image_reader_->available());
1147 bool done = this->image_reader_->available() == to_send;
1150 msg.
key = cam->get_object_id_hash();
1151 msg.
set_data(this->image_reader_->peek_data_buffer(), to_send);
1157 if (!this->send_message(msg)) {
1160 this->image_reader_->consume_data(to_send);
1162 this->image_reader_->return_image();
1167void APIConnection::set_camera_state(std::shared_ptr<camera::CameraImage> image) {
1168 if (!this->flags_.state_subscription)
1170 if (this->image_reader_ && this->image_reader_->available())
1174 if (!this->image_reader_) {
1180 this->image_reader_->set_image(std::move(image));
1182 this->try_send_camera_image_();
1187 return fill_and_encode_entity_info(camera, msg, conn, remaining_size);
1198 App.
scheduler.set_timeout(this->parent_,
"api_camera_stop_stream", CAMERA_STOP_STREAM,
1204#ifdef USE_HOMEASSISTANT_TIME
1208#if defined(USE_HOMEASSISTANT_TIMEZONE) && defined(USE_TIME_TIMEZONE)
1219 tz.
dst_start.
day =
static_cast<uint16_t
>(pt.dst_start.day);
1222 tz.
dst_start.
week =
static_cast<uint8_t
>(pt.dst_start.week);
1225 tz.
dst_end.
day =
static_cast<uint16_t
>(pt.dst_end.day);
1227 tz.
dst_end.
month =
static_cast<uint8_t
>(pt.dst_end.month);
1228 tz.
dst_end.
week =
static_cast<uint8_t
>(pt.dst_end.week);
1237#ifdef USE_BLUETOOTH_PROXY
1238void APIConnection::on_subscribe_bluetooth_le_advertisements_request(
1242void APIConnection::on_unsubscribe_bluetooth_le_advertisements_request() {
1245#ifdef USE_BLUETOOTH_PROXY_CONNECTIONS
1269bool APIConnection::send_subscribe_bluetooth_connections_free_response_() {
1273void APIConnection::on_subscribe_bluetooth_connections_free_request() {
1274 if (!this->send_subscribe_bluetooth_connections_free_response_()) {
1275 this->on_fatal_error();
1286 msg.
mode == enums::BluetoothScannerMode::BLUETOOTH_SCANNER_MODE_ACTIVE);
1290#ifdef USE_VOICE_ASSISTANT
1291bool APIConnection::check_voice_assistant_api_connection_()
const {
1302 if (!this->check_voice_assistant_api_connection_()) {
1310 if (msg.
port == 0) {
1316 this->helper_->getpeername((
struct sockaddr *) &storage, &
len);
1321 if (this->check_voice_assistant_api_connection_()) {
1326 if (this->check_voice_assistant_api_connection_()) {
1331 if (this->check_voice_assistant_api_connection_()) {
1337 if (this->check_voice_assistant_api_connection_()) {
1342bool APIConnection::send_voice_assistant_get_configuration_response_(
1345 if (!this->check_voice_assistant_api_connection_()) {
1347 const std::vector<std::string> empty_wake_words;
1349 return this->send_message(resp);
1353 for (
auto &wake_word : config.available_wake_words) {
1356 resp_wake_word.id =
StringRef(wake_word.id);
1357 resp_wake_word.wake_word =
StringRef(wake_word.wake_word);
1358 for (
const auto &lang : wake_word.trained_languages) {
1359 resp_wake_word.trained_languages.push_back(lang);
1365 return this->send_message(resp);
1368 if (!this->send_voice_assistant_get_configuration_response_(msg)) {
1369 this->on_fatal_error();
1374 if (this->check_voice_assistant_api_connection_()) {
1380#ifdef USE_ZWAVE_PROXY
1389 if (!this->send_message(resp)) {
1390 API_LOG_MSG_DROPPED(TAG,
"Z-Wave proxy response");
1395#ifdef USE_ALARM_CONTROL_PANEL
1397 return this->send_message_smart_(a_alarm_control_panel, AlarmControlPanelStateResponse::MESSAGE_TYPE,
1398 AlarmControlPanelStateResponse::ESTIMATED_SIZE);
1405 return fill_and_encode_entity_state(a_alarm_control_panel, resp, conn, remaining_size);
1412 msg.
requires_code = a_alarm_control_panel->get_requires_code();
1414 return fill_and_encode_entity_info(a_alarm_control_panel, msg, conn, remaining_size);
1419 case enums::ALARM_CONTROL_PANEL_DISARM:
1422 case enums::ALARM_CONTROL_PANEL_ARM_AWAY:
1425 case enums::ALARM_CONTROL_PANEL_ARM_HOME:
1428 case enums::ALARM_CONTROL_PANEL_ARM_NIGHT:
1431 case enums::ALARM_CONTROL_PANEL_ARM_VACATION:
1432 call.arm_vacation();
1434 case enums::ALARM_CONTROL_PANEL_ARM_CUSTOM_BYPASS:
1435 call.arm_custom_bypass();
1437 case enums::ALARM_CONTROL_PANEL_TRIGGER:
1446#ifdef USE_WATER_HEATER
1448 return this->send_message_smart_(water_heater, WaterHeaterStateResponse::MESSAGE_TYPE,
1449 WaterHeaterStateResponse::ESTIMATED_SIZE);
1459 resp.
state = wh->get_state();
1461 return fill_and_encode_entity_state(wh, resp, conn, remaining_size);
1466 auto traits = wh->get_traits();
1473 return fill_and_encode_entity_info(wh, msg, conn, remaining_size);
1478 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_MODE)
1480 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE)
1482 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE_LOW)
1484 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE_HIGH)
1486 if ((msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_AWAY_STATE) ||
1487 (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_STATE)) {
1490 if ((msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_ON_STATE) ||
1491 (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_STATE)) {
1502 this->send_message_smart_(event, EventResponse::MESSAGE_TYPE, EventResponse::ESTIMATED_SIZE,
1509 return fill_and_encode_entity_state(event, resp, conn, remaining_size);
1516 return fill_and_encode_entity_info_with_device_class(event, msg, msg.
device_class, conn, remaining_size);
1520#if defined(USE_IR_RF) || defined(USE_RADIO_FREQUENCY)
1526 if (infrared !=
nullptr) {
1527 auto call = infrared->make_call();
1535#ifdef USE_RADIO_FREQUENCY
1537 if (radio_frequency !=
nullptr) {
1538 auto call = radio_frequency->make_call();
1549#if defined(USE_IR_RF) || defined(USE_RADIO_FREQUENCY)
1551 if (!this->send_message(msg)) {
1554 ESP_LOGV(TAG,
"IR/RF event dropped, TCP buffer full");
1559#ifdef USE_SERIAL_PROXY
1563 return enums::SERIAL_PROXY_STATUS_OK;
1565 return enums::SERIAL_PROXY_STATUS_ASSUMED_SUCCESS;
1567 return enums::SERIAL_PROXY_STATUS_PORT_IN_USE;
1569 return enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT;
1571 return enums::SERIAL_PROXY_STATUS_TIMEOUT;
1573 return enums::SERIAL_PROXY_STATUS_NOT_SUPPORTED;
1575 return enums::SERIAL_PROXY_STATUS_ERROR;
1577 return enums::SERIAL_PROXY_STATUS_ERROR;
1580static void send_serial_proxy_ack(APIConnection *conn,
uint32_t instance, enums::SerialProxyRequestType
type,
1581 enums::SerialProxyStatus
status) {
1582 SerialProxyRequestResponse resp{};
1583 resp.instance = instance;
1586 if (!conn->send_message(resp)) {
1587 API_LOG_MSG_DROPPED(TAG,
"Serial proxy response");
1593 if (msg.
instance >= proxies.size()) {
1594 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range (max %" PRIu32
")", msg.
instance,
1595 static_cast<uint32_t>(proxies.size()));
1596 send_serial_proxy_ack(
this, msg.
instance, enums::SERIAL_PROXY_REQUEST_TYPE_CONFIGURE,
1597 enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT);
1602 send_serial_proxy_ack(
this, msg.
instance, enums::SERIAL_PROXY_REQUEST_TYPE_CONFIGURE,
1603 serial_proxy_result_to_status(result));
1608 if (msg.
instance >= proxies.size()) {
1609 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1617 if (msg.
instance >= proxies.size()) {
1618 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1619 send_serial_proxy_ack(
this, msg.
instance, enums::SERIAL_PROXY_REQUEST_TYPE_SET_MODEM_PINS,
1620 enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT);
1624 send_serial_proxy_ack(
this, msg.
instance, enums::SERIAL_PROXY_REQUEST_TYPE_SET_MODEM_PINS,
1625 serial_proxy_result_to_status(result));
1632 if (msg.
instance >= proxies.size()) {
1633 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1636 if (!this->client_supports_api_version(1, 16)) {
1639 resp.status = enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT;
1641 resp.line_states = proxies[msg.
instance]->get_modem_pins();
1643 if (!this->send_message(resp)) {
1644 API_LOG_MSG_DROPPED(TAG,
"Serial proxy response");
1650 if (msg.
instance >= proxies.size()) {
1651 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1652 send_serial_proxy_ack(
this, msg.
instance, msg.
type, enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT);
1655 auto *proxy = proxies[msg.
instance];
1658 case enums::SERIAL_PROXY_REQUEST_TYPE_SUBSCRIBE:
1659 case enums::SERIAL_PROXY_REQUEST_TYPE_UNSUBSCRIBE:
1660 status = serial_proxy_result_to_status(proxy->serial_proxy_request(
this, msg.
type));
1662 case enums::SERIAL_PROXY_REQUEST_TYPE_FLUSH:
1663 status = serial_proxy_result_to_status(proxy->flush_port(
this));
1665 case enums::SERIAL_PROXY_REQUEST_TYPE_CONFIGURE:
1666 case enums::SERIAL_PROXY_REQUEST_TYPE_SET_MODEM_PINS:
1668 ESP_LOGW(TAG,
"Response-only serial proxy request type: %" PRIu32,
static_cast<uint32_t>(msg.
type));
1669 status = enums::SERIAL_PROXY_STATUS_INVALID_ARGUMENT;
1672 ESP_LOGW(TAG,
"Unknown serial proxy request type: %" PRIu32,
static_cast<uint32_t>(msg.
type));
1673 status = enums::SERIAL_PROXY_STATUS_NOT_SUPPORTED;
1680 if (!this->send_message(msg)) {
1681 ESP_LOGV(TAG,
"Serial proxy data dropped, TCP buffer full");
1692 return fill_and_encode_entity_info(infrared, msg, conn, remaining_size);
1696#ifdef USE_RADIO_FREQUENCY
1702 msg.
frequency_min = rf->get_traits().get_frequency_min_hz();
1703 msg.
frequency_max = rf->get_traits().get_frequency_max_hz();
1705 return fill_and_encode_entity_info(rf, msg, conn, remaining_size);
1711 return this->send_message_smart_(update, UpdateStateResponse::MESSAGE_TYPE, UpdateStateResponse::ESTIMATED_SIZE);
1717 if (update->has_state()) {
1719 if (update->update_info.has_progress) {
1721 resp.
progress = update->update_info.progress;
1729 return fill_and_encode_entity_state(update, resp, conn, remaining_size);
1734 return fill_and_encode_entity_info_with_device_class(update, msg, msg.
device_class, conn, remaining_size);
1740 case enums::UPDATE_COMMAND_UPDATE:
1743 case enums::UPDATE_COMMAND_CHECK:
1746 case enums::UPDATE_COMMAND_NONE:
1747 ESP_LOGE(TAG,
"UPDATE_COMMAND_NONE not handled; confirm command is correct");
1750 ESP_LOGW(TAG,
"Unknown update command: %" PRIu32, msg.
command);
1756bool APIConnection::try_send_log_message(
int level,
const char *tag,
const char *line,
size_t message_len) {
1759 msg.
set_message(
reinterpret_cast<const uint8_t *
>(line), message_len);
1760 return this->send_message(msg);
1763void APIConnection::complete_authentication_() {
1765 if (this->flags_.connection_state ==
static_cast<uint8_t
>(ConnectionState::AUTHENTICATED)) {
1769 this->flags_.connection_state =
static_cast<uint8_t
>(ConnectionState::AUTHENTICATED);
1772 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"connected"));
1773#ifdef USE_API_CLIENT_CONNECTED_TRIGGER
1775 char peername[socket::SOCKADDR_STR_LEN];
1776 this->parent_->get_client_connected_trigger()->trigger(std::string(this->helper_->get_client_name()),
1777 std::string(this->helper_->get_peername_to(peername)));
1780#ifdef USE_HOMEASSISTANT_TIME
1782 this->send_time_request();
1785#ifdef USE_ZWAVE_PROXY
1795 this->client_api_version_major_ =
1796 static_cast<uint8_t
>(std::min<uint32_t>(msg.
api_version_major, std::numeric_limits<uint8_t>::max()));
1797 this->client_api_version_minor_ =
1798 static_cast<uint8_t
>(std::min<uint32_t>(msg.
api_version_minor, std::numeric_limits<uint8_t>::max()));
1799 char peername[socket::SOCKADDR_STR_LEN];
1800 ESP_LOGV(TAG,
"Hello from client: '%s' | %s | API Version %u.%u", this->helper_->get_client_name(),
1801 this->helper_->get_peername_to(peername), this->client_api_version_major_, this->client_api_version_minor_);
1810#ifdef USE_PROVISIONING
1815 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"Provisioning closed; rejecting connection"));
1816 if (!this->send_message(resp)) {
1817 API_LOG_MSG_DROPPED(TAG,
"Hello response");
1820 req.
reason = enums::DISCONNECT_REASON_PROVISIONING_CLOSED;
1821 return this->send_message(req);
1826 this->complete_authentication_();
1828 return this->send_message(resp);
1831bool APIConnection::send_ping_response_() {
1833 return this->send_message(resp);
1836bool APIConnection::send_device_info_response_() {
1843 char mac_address[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1844 uint8_t mac[MAC_ADDRESS_SIZE];
1857#if defined(USE_ESP8266) || defined(USE_ESP32)
1858#define ESPHOME_MANUFACTURER "Espressif"
1859#elif defined(USE_RP2)
1860#define ESPHOME_MANUFACTURER "Raspberry Pi"
1861#elif defined(USE_BK72XX)
1862#define ESPHOME_MANUFACTURER "Beken"
1863#elif defined(USE_LN882X)
1864#define ESPHOME_MANUFACTURER "Lightning"
1865#elif defined(USE_NRF52)
1866#define ESPHOME_MANUFACTURER "Nordic Semiconductor"
1867#elif defined(USE_RTL87XX)
1868#define ESPHOME_MANUFACTURER "Realtek"
1869#elif defined(USE_HOST)
1870#define ESPHOME_MANUFACTURER "Host"
1875 static const char MANUFACTURER_PROGMEM[]
PROGMEM = ESPHOME_MANUFACTURER;
1876 char manufacturer_buf[
sizeof(MANUFACTURER_PROGMEM)];
1877 memcpy_P(manufacturer_buf, MANUFACTURER_PROGMEM,
sizeof(MANUFACTURER_PROGMEM));
1883 static_assert(
sizeof(ESPHOME_MANUFACTURER) - 1 <= 20,
"Update max_data_length for manufacturer in api.proto");
1884#undef ESPHOME_MANUFACTURER
1887 static const char MODEL_PROGMEM[]
PROGMEM = ESPHOME_BOARD;
1888 char model_buf[
sizeof(MODEL_PROGMEM)];
1889 memcpy_P(model_buf, MODEL_PROGMEM,
sizeof(MODEL_PROGMEM));
1895#ifdef USE_DEEP_SLEEP
1898#ifdef ESPHOME_PROJECT_NAME
1900 static const char PROJECT_NAME_PROGMEM[]
PROGMEM = ESPHOME_PROJECT_NAME;
1901 static const char PROJECT_VERSION_PROGMEM[]
PROGMEM = ESPHOME_PROJECT_VERSION;
1902 char project_name_buf[
sizeof(PROJECT_NAME_PROGMEM)];
1903 char project_version_buf[
sizeof(PROJECT_VERSION_PROGMEM)];
1904 memcpy_P(project_name_buf, PROJECT_NAME_PROGMEM,
sizeof(PROJECT_NAME_PROGMEM));
1905 memcpy_P(project_version_buf, PROJECT_VERSION_PROGMEM,
sizeof(PROJECT_VERSION_PROGMEM));
1918#ifdef USE_BLUETOOTH_PROXY
1920 char bluetooth_mac[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1924#ifdef USE_VOICE_ASSISTANT
1927#ifdef USE_ZWAVE_PROXY
1931#ifdef USE_SERIAL_PROXY
1932 size_t serial_proxy_index = 0;
1934 if (serial_proxy_index >= SERIAL_PROXY_COUNT)
1937 info.name =
StringRef(proxy->get_name());
1938 info.port_type = proxy->get_port_type();
1939 info.configured_line_states = proxy->get_configured_modem_pins();
1944#ifndef USE_API_NOISE_PSK_FROM_YAML
1952 size_t device_index = 0;
1954 if (device_index >= ESPHOME_DEVICE_COUNT)
1956 auto &device_info = resp.
devices[device_index++];
1957 device_info.device_id = device->get_device_id();
1958 device_info.name =
StringRef(device->get_name());
1959 device_info.area_id = device->get_area_id();
1963 size_t area_index = 0;
1965 if (area_index >= ESPHOME_AREA_COUNT)
1967 auto &area_info = resp.
areas[area_index++];
1968 area_info.area_id = area->get_area_id();
1969 area_info.name =
StringRef(area->get_name());
1973 return this->send_message(resp);
1975bool APIConnection::send_device_capabilities_response_() {
1979#ifdef USE_BLUETOOTH_PROXY
1981 char bluetooth_mac[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1985#ifdef USE_VOICE_ASSISTANT
1988#ifdef USE_ZWAVE_PROXY
1992#ifdef USE_SERIAL_PROXY
1993 size_t serial_proxy_index = 0;
1995 if (serial_proxy_index >= SERIAL_PROXY_COUNT)
1998 info.name =
StringRef(proxy->get_name());
1999 info.port_type = proxy->get_port_type();
2000 info.configured_line_states = proxy->get_configured_modem_pins();
2003 return this->send_message(resp);
2006 if (!this->send_hello_response_(msg)) {
2007 this->on_fatal_error();
2012 if (!this->send_disconnect_response_()) {
2013 this->on_fatal_error();
2016void APIConnection::on_ping_request() {
2017 if (!this->send_ping_response_()) {
2018 this->on_fatal_error();
2021void APIConnection::on_device_info_request() {
2022 if (!this->send_device_info_response_()) {
2023 this->on_fatal_error();
2026void APIConnection::on_device_capabilities_request() {
2027 if (!this->send_device_capabilities_response_()) {
2028 this->on_fatal_error();
2032#ifdef USE_API_HOMEASSISTANT_STATES
2048 for (
auto &it : this->parent_->get_state_subs()) {
2059 it.callback(msg.
state);
2063#ifdef USE_API_USER_DEFINED_ACTIONS
2071 if (!arg.string_.empty()) {
2072 const_cast<char *
>(arg.string_.c_str())[arg.string_.size()] =
'\0';
2076#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES
2081 action_call_id = this->parent_->register_active_action_call(msg.
call_id,
this);
2084 for (
auto *service : this->parent_->get_user_services()) {
2085 if (service->execute_service(msg, action_call_id)) {
2090 for (
auto *service : this->parent_->get_user_services()) {
2091 if (service->execute_service(msg)) {
2097 ESP_LOGV(TAG,
"Could not find service");
2103#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES
2104void APIConnection::send_execute_service_response(
uint32_t call_id,
bool success,
StringRef error_message) {
2109 if (!this->send_message(resp)) {
2110 API_LOG_MSG_DROPPED(TAG,
"Action response");
2113#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES_JSON
2114void APIConnection::send_execute_service_response(
uint32_t call_id,
bool success,
StringRef error_message,
2115 const uint8_t *response_data,
size_t response_data_len) {
2122 if (!this->send_message(resp)) {
2123 API_LOG_MSG_DROPPED(TAG,
"Action response");
2130#ifdef USE_API_HOMEASSISTANT_SERVICES
2132 if (!this->flags_.service_call_subscription)
2134 if (!this->send_message(call)) {
2135 API_LOG_MSG_DROPPED(TAG,
"Action request");
2141#ifdef USE_HOMEASSISTANT_TIME
2142void APIConnection::send_time_request() {
2144 if (!this->send_message(req)) {
2145 API_LOG_MSG_DROPPED(TAG,
"Time request");
2150#ifdef USE_API_HOMEASSISTANT_ACTION_RESPONSES
2152#ifdef USE_API_HOMEASSISTANT_ACTION_RESPONSES_JSON
2167#ifdef USE_API_NOISE_PSK_FROM_YAML
2169 ESP_LOGW(TAG,
"Key set in YAML");
2171#ifdef USE_PROVISIONING
2175 ESP_LOGW(TAG,
"Provisioning closed; rejecting key set");
2176 return this->send_message(resp);
2182 if (this->parent_->clear_noise_psk(
true)) {
2185 ESP_LOGW(TAG,
"Failed to clear encryption key");
2188 ESP_LOGW(TAG,
"Invalid encryption key length");
2192 ESP_LOGW(TAG,
"Rejecting all-zero encryption key");
2193 }
else if (!this->parent_->save_noise_psk(psk,
true)) {
2194 ESP_LOGW(TAG,
"Failed to save encryption key");
2197#ifdef USE_API_PLAINTEXT
2198 if (this->helper_->frame_footer_size() == 0) {
2201 ESP_LOGW(TAG,
"Key received over plaintext; deprecated, will be removed in 2027.2.0");
2207 return this->send_message(resp);
2210 if (!this->send_noise_encryption_set_key_response_(msg)) {
2211 this->on_fatal_error();
2215#ifdef USE_API_HOMEASSISTANT_STATES
2216void APIConnection::on_subscribe_home_assistant_states_request() { state_subs_at_ = 0; }
2218bool APIConnection::try_to_clear_buffer_slow_(
bool log_out_of_space) {
2220 APIError err = this->helper_->loop();
2221 if (err != APIError::OK) {
2222 this->fatal_error_with_log_(LOG_STR(
"Socket operation failed"), err);
2225 if (this->helper_->can_write_without_blocking())
2227 if (log_out_of_space) {
2231 ESP_LOGVV(TAG,
"Cannot send message because of TCP buffer space");
2237#ifdef HAS_PROTO_MESSAGE_DUMP
2239 if (message_type != SubscribeLogsResponse::MESSAGE_TYPE
2241 && message_type != CameraImageResponse::MESSAGE_TYPE
2244 auto *proto_msg =
static_cast<const ProtoMessage *
>(msg);
2246 this->log_send_message_(proto_msg->message_name(), proto_msg->dump_to(dump_buf));
2249 if (!this->prepare_first_message_buffer(
payload_size)) [[unlikely]] {
2250 this->fatal_out_of_memory_();
2253 auto &shared_buf = this->parent_->get_shared_buffer_ref();
2254 size_t write_start = shared_buf.size();
2255#ifdef ESPHOME_DEBUG_API
2256 assert(shared_buf.capacity() >= write_start +
payload_size);
2261 encode_fn(msg, buffer PROTO_ENCODE_DEBUG_INIT(&shared_buf));
2269 return encode_to_buffer(calculated_size, encode_fn, msg, conn, remaining_size);
2272 const bool is_log_message = (message_type == SubscribeLogsResponse::MESSAGE_TYPE);
2274 if (!this->try_to_clear_buffer(!is_log_message)) {
2279 this->helper_->set_nodelay_for_message(is_log_message);
2281 APIError err = this->helper_->write_protobuf_packet(message_type, buffer);
2282 if (err == APIError::WOULD_BLOCK)
2284 if (err != APIError::OK) {
2285 this->fatal_error_with_log_(LOG_STR(
"Packet write failed"), err);
2291void APIConnection::on_no_setup_connection() {
2292 this->on_fatal_error();
2293 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"no connection setup"));
2295void APIConnection::fatal_out_of_memory_() {
2296 this->fatal_error_with_log_(LOG_STR(
"Out of memory"), APIError::OUT_OF_MEMORY);
2298void APIConnection::on_fatal_error() {
2301 this->flags_.remove =
true;
2304bool APIConnection::schedule_message_front_(
EntityBase *entity, uint16_t message_type, uint8_t estimated_size) {
2305 this->deferred_batch_.add_item_front(entity, message_type, estimated_size);
2306 return this->schedule_batch_();
2309bool APIConnection::send_message_smart_(
EntityBase *entity, uint16_t message_type, uint8_t estimated_size,
2310 uint8_t aux_data_index) {
2311 if (this->should_send_immediately_(message_type) && this->helper_->can_write_without_blocking()) {
2315 if (!this->prepare_first_message_buffer(estimated_size)) [[unlikely]] {
2316 this->fatal_out_of_memory_();
2320 if (this->dispatch_message_(item, MAX_BATCH_PACKET_SIZE,
true) &&
2321 this->send_buffer(
ProtoWriteBuffer{&this->parent_->get_shared_buffer_ref()}, message_type)) {
2322#ifdef HAS_PROTO_MESSAGE_DUMP
2323 this->log_batch_item_(item);
2329 if (this->flags_.remove) [[unlikely]]
2332 return this->schedule_message_(entity, message_type, estimated_size, aux_data_index);
2335bool APIConnection::schedule_batch_() {
2336 if (!this->flags_.batch_scheduled) {
2337 this->flags_.batch_scheduled =
true;
2343void APIConnection::process_batch_() {
2344 if (this->deferred_batch_.empty()) {
2345 this->flags_.batch_scheduled =
false;
2354 this->helper_->set_nodelay_for_message(
false);
2357 if (!this->try_to_clear_buffer(
true)) {
2363 auto &shared_buf = this->parent_->get_shared_buffer_ref();
2364 size_t num_items = this->deferred_batch_.size();
2367 const uint8_t header_padding = this->helper_->frame_header_padding();
2368 const uint8_t footer_size = this->helper_->frame_footer_size();
2371 uint32_t total_estimated_size = num_items * (header_padding + footer_size);
2372 for (
size_t i = 0; i < num_items; i++) {
2373 total_estimated_size += this->deferred_batch_[i].estimated_size;
2376 if (total_estimated_size > MAX_BATCH_PACKET_SIZE) {
2377 total_estimated_size = MAX_BATCH_PACKET_SIZE;
2380 if (!this->prepare_first_message_buffer(header_padding, total_estimated_size)) [[unlikely]] {
2381 this->fatal_out_of_memory_();
2382 this->clear_batch_();
2387 if (num_items == 1) {
2388 const auto &item = this->deferred_batch_[0];
2390 uint16_t
payload_size = this->dispatch_message_(item, std::numeric_limits<uint16_t>::max(),
true);
2393#ifdef HAS_PROTO_MESSAGE_DUMP
2395 this->log_batch_item_(item);
2397 this->clear_batch_();
2401 if (!this->flags_.remove) {
2402 ESP_LOGW(TAG,
"Message too large to send: type=%u", item.message_type);
2404 this->clear_batch_();
2410 this->process_batch_multi_(shared_buf, num_items, header_padding, footer_size);
2415void APIConnection::process_batch_multi_(
APIBuffer &shared_buf,
size_t num_items, uint8_t header_padding,
2416 uint8_t footer_size) {
2418 static_assert(std::is_trivially_destructible<MessageInfo>::value,
2419 "MessageInfo must remain trivially destructible with this placement-new approach");
2421 const size_t messages_to_process = std::min(num_items, MAX_MESSAGES_PER_BATCH);
2426 size_t items_processed = 0;
2427 uint16_t remaining_size = std::numeric_limits<uint16_t>::max();
2434 for (
size_t i = 0; i < messages_to_process; i++) {
2435 const auto &item = this->deferred_batch_[i];
2438 uint16_t
payload_size = this->dispatch_message_(item, remaining_size, i == 0);
2447 uint16_t proto_payload_size =
payload_size - this->batch_header_size_ - footer_size;
2452 new (&message_info[items_processed++])
2453 MessageInfo(item.message_type, current_offset, proto_payload_size, this->batch_header_size_);
2455 if (items_processed == 1) {
2456 remaining_size = MAX_BATCH_PACKET_SIZE;
2461 current_offset = shared_buf.
size() + footer_size;
2464 if (items_processed > 0) {
2466 if (footer_size > 0 && !shared_buf.
resize(shared_buf.
size() + footer_size)) [[unlikely]] {
2467 this->fatal_out_of_memory_();
2468 this->clear_batch_();
2474 std::span<const MessageInfo>(message_info, items_processed));
2475 if (err != APIError::OK && err != APIError::WOULD_BLOCK) {
2476 this->fatal_error_with_log_(LOG_STR(
"Batch write failed"), err);
2479#ifdef HAS_PROTO_MESSAGE_DUMP
2482 for (
size_t i = 0; i < items_processed; i++) {
2483 const auto &item = this->deferred_batch_[i];
2484 this->log_batch_item_(item);
2489 if (items_processed < this->deferred_batch_.size()) {
2490 this->deferred_batch_.remove_front(items_processed);
2491 this->schedule_batch_();
2497 this->clear_batch_();
2504 this->flags_.batch_first_message = batch_first;
2508 if (item.
message_type == EventResponse::MESSAGE_TYPE) {
2514 this, remaining_size);
2522#define CASE_STATE_INFO(entity_name, StateResp, InfoResp) \
2523 case StateResp::MESSAGE_TYPE: \
2524 func = &try_send_##entity_name##_state; \
2526 case InfoResp::MESSAGE_TYPE: \
2527 func = &try_send_##entity_name##_info; \
2529#define CASE_INFO_ONLY(entity_name, InfoResp) \
2530 case InfoResp::MESSAGE_TYPE: \
2531 func = &try_send_##entity_name##_info; \
2535#ifdef USE_BINARY_SENSOR
2556#ifdef USE_TEXT_SENSOR
2565#ifdef USE_DATETIME_DATE
2568#ifdef USE_DATETIME_TIME
2571#ifdef USE_DATETIME_DATETIME
2586#ifdef USE_MEDIA_PLAYER
2589#ifdef USE_ALARM_CONTROL_PANEL
2592#ifdef USE_WATER_HEATER
2601#ifdef USE_RADIO_FREQUENCY
2611 case ListEntitiesDoneResponse::MESSAGE_TYPE:
2612 func = &try_send_list_info_done;
2614 case DisconnectRequest::MESSAGE_TYPE:
2615 func = &try_send_disconnect_request;
2617 case PingRequest::MESSAGE_TYPE:
2618 func = &try_send_ping_request;
2624#undef CASE_STATE_INFO
2625#undef CASE_INFO_ONLY
2627 return func(item.
entity,
this, remaining_size);
2632 return encode_message_to_buffer(resp, conn, remaining_size);
2637 return encode_message_to_buffer(req, conn, remaining_size);
2642 return encode_message_to_buffer(req, conn, remaining_size);
2645#ifdef USE_API_HOMEASSISTANT_STATES
2646void APIConnection::process_state_subscriptions_() {
2647 const auto &subs = this->parent_->get_state_subs();
2648 if (this->state_subs_at_ >=
static_cast<int>(subs.size())) {
2649 this->state_subs_at_ = -1;
2653 const auto &it = subs[this->state_subs_at_];
2660 resp.
once = it.once;
2661 if (this->send_message(resp)) {
2662 this->state_subs_at_++;
2667void APIConnection::log_client_(
int level,
const LogString *
message) {
2668 char peername[socket::SOCKADDR_STR_LEN];
2669 esp_log_printf_(level, TAG, __LINE__, ESPHOME_LOG_FORMAT(
"%s (%s): %s"), this->helper_->get_client_name(),
2670 this->helper_->get_peername_to(peername), LOG_STR_ARG(
message));
2674 char peername[socket::SOCKADDR_STR_LEN];
2675 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)
uint8_t *(*)(const void *, ProtoWriteBuffer &PROTO_ENCODE_DEBUG_PARAM) 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
ZWaveProxyCapabilities zwave_proxy
BluetoothProxyCapabilities bluetooth_proxy
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
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 FixedVector< const char * > * 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::SerialProxyRequestType type
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.
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 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.
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