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
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"
170void APIConnection::start() {
173 APIError err = this->helper_->init();
174 if (err != APIError::OK) {
175 this->fatal_error_with_log_(LOG_STR(
"Helper init failed"), err);
179 char peername[socket::SOCKADDR_STR_LEN];
180 this->helper_->set_client_name(this->helper_->get_peername_to(peername), strlen(peername));
183APIConnection::~APIConnection() {
184 this->destroy_active_iterator_();
185#ifdef USE_BLUETOOTH_PROXY
190#ifdef USE_VOICE_ASSISTANT
195#ifdef USE_ZWAVE_PROXY
200#ifdef USE_SERIAL_PROXY
202 if (proxy->get_api_connection() ==
this) {
203 proxy->serial_proxy_request(
this, enums::SERIAL_PROXY_REQUEST_TYPE_UNSUBSCRIBE);
209#if defined(USE_API_NOISE) && defined(USE_API_PLAINTEXT)
210void APIConnection::upgrade_helper_to_noise_() {
220 auto *noise =
new APINoiseFrameHelper(plaintext->release_socket_for_switch(), this->parent_->get_noise_ctx());
222 const char *name = plaintext->get_client_name();
223 noise->set_client_name(name, strlen(name));
224 this->helper_.reset(noise);
225 APIError err = noise->init_from_handoff(header, header_len);
226 if (err != APIError::OK) {
227 this->fatal_error_with_log_(LOG_STR(
"Noise handoff failed"), err);
232void APIConnection::destroy_active_iterator_() {
233 switch (this->active_iterator_) {
234 case ActiveIterator::LIST_ENTITIES:
235 this->iterator_storage_.list_entities.~ListEntitiesIterator();
237 case ActiveIterator::INITIAL_STATE:
238 this->iterator_storage_.initial_state.~InitialStateIterator();
240 case ActiveIterator::NONE:
243 this->active_iterator_ = ActiveIterator::NONE;
247 this->destroy_active_iterator_();
248 this->active_iterator_ =
type;
249 if (
type == ActiveIterator::LIST_ENTITIES) {
251 this->iterator_storage_.list_entities.
begin();
254 this->iterator_storage_.initial_state.
begin();
258void APIConnection::loop() {
259 if (this->flags_.next_close) {
262 this->flags_.remove =
true;
266 APIError err = this->helper_->loop();
267 if (err != APIError::OK) {
268 this->fatal_error_with_log_(LOG_STR(
"Socket operation failed"), err);
279 if (this->helper_->is_socket_ready() || this->flags_.may_have_remaining_data) {
280 this->flags_.may_have_remaining_data =
false;
282 uint8_t message_count = 0;
283 for (; message_count < MAX_MESSAGES_PER_LOOP; message_count++) {
285 err = this->helper_->read_packet(&buffer);
286 if (err == APIError::WOULD_BLOCK) {
289 }
else if (err != APIError::OK) {
290#if defined(USE_API_NOISE) && defined(USE_API_PLAINTEXT)
294 if (err == APIError::PROTOCOL_SWITCH_TO_NOISE) {
295 this->upgrade_helper_to_noise_();
299 this->fatal_error_with_log_(LOG_STR(
"Reading failed"), err);
305 if (this->is_authenticated()) {
306 this->last_traffic_ = now;
310 if (this->flags_.remove)
316 if (message_count == MAX_MESSAGES_PER_LOOP) {
317 this->flags_.may_have_remaining_data =
true;
322 if (this->flags_.batch_scheduled && now - this->deferred_batch_.batch_start_time >= this->get_batch_delay_ms_()) {
323 this->process_batch_();
326 if (this->active_iterator_ != ActiveIterator::NONE) {
327 this->process_active_iterator_();
333 if (!this->is_authenticated() && now - this->last_traffic_ > HANDSHAKE_TIMEOUT_MS) {
334 this->on_fatal_error();
335 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"handshake timeout; disconnecting"));
342 if (now - this->last_traffic_ > KEEPALIVE_TIMEOUT_MS) {
343 this->check_keepalive_(now);
346#ifdef USE_API_HOMEASSISTANT_STATES
347 if (state_subs_at_ >= 0) {
348 this->process_state_subscriptions_();
355 this->try_send_camera_image_();
359void APIConnection::check_keepalive_(
uint32_t now) {
361 if (this->flags_.sent_ping) {
363 if (now - this->last_traffic_ > KEEPALIVE_DISCONNECT_TIMEOUT) {
365 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"is unresponsive; disconnecting"));
367 }
else if (!this->flags_.remove) {
369 ESP_LOGVV(TAG,
"Sending keepalive PING");
371 this->flags_.sent_ping = this->send_message(req);
372 if (!this->flags_.sent_ping) {
375 ESP_LOGW(TAG,
"Buffer full, ping queued");
376 this->schedule_message_front_(
nullptr, PingRequest::MESSAGE_TYPE, PingRequest::ESTIMATED_SIZE);
377 this->flags_.sent_ping =
true;
382void APIConnection::process_active_iterator_() {
384 if (this->active_iterator_ == ActiveIterator::LIST_ENTITIES) {
385 if (this->iterator_storage_.list_entities.completed()) {
386 this->destroy_active_iterator_();
387 if (this->flags_.state_subscription) {
388 this->begin_iterator_(ActiveIterator::INITIAL_STATE);
390 this->finalize_iterator_sync_();
393 this->process_iterator_batch_(this->iterator_storage_.list_entities);
396 if (this->iterator_storage_.initial_state.completed()) {
397 this->destroy_active_iterator_();
398 this->finalize_iterator_sync_();
400 this->process_iterator_batch_(this->iterator_storage_.initial_state);
405void APIConnection::finalize_iterator_sync_() {
409 if (!this->deferred_batch_.empty()) {
410 this->process_batch_();
413 this->flags_.should_try_send_immediately =
true;
415 this->deferred_batch_.release_buffer();
416 this->helper_->release_buffers();
422 size_t batch_size = this->deferred_batch_.size();
423 if (batch_size < MAX_INITIAL_BATCH_SIZE)
424 iterator.
try_advance(MAX_INITIAL_BATCH_SIZE - batch_size);
428 if (this->deferred_batch_.size() >= MAX_INITIAL_BATCH_SIZE) {
429 this->process_batch_();
433bool APIConnection::send_disconnect_response_() {
437 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"disconnected"));
438 this->flags_.next_close =
true;
440 return this->send_message(resp);
442void APIConnection::on_disconnect_response() {
445 this->flags_.remove =
true;
455 return encode_to_buffer(size_fn(&msg), encode_fn, &msg, conn, remaining_size);
469#ifdef USE_ENTITY_ICON
470 char icon_buf[MAX_ICON_LENGTH];
478 return encode_to_buffer_slow(size_fn(&msg), encode_fn, &msg, conn, remaining_size);
486 char dc_buf[MAX_DEVICE_CLASS_LENGTH];
488 return fill_and_encode_entity_info(entity, msg, size_fn, encode_fn, conn, remaining_size);
491#ifdef USE_BINARY_SENSOR
493 return this->send_message_smart_(binary_sensor, BinarySensorStateResponse::MESSAGE_TYPE,
494 BinarySensorStateResponse::ESTIMATED_SIZE);
500 resp.
state = binary_sensor->state;
502 return fill_and_encode_entity_state(binary_sensor, resp, conn, remaining_size);
509 return fill_and_encode_entity_info_with_device_class(binary_sensor, msg, msg.
device_class, conn, remaining_size);
515 return this->send_message_smart_(cover, CoverStateResponse::MESSAGE_TYPE, CoverStateResponse::ESTIMATED_SIZE);
520 auto traits = cover->get_traits();
522 if (traits.get_supports_tilt())
523 msg.
tilt = cover->tilt;
525 return fill_and_encode_entity_state(cover, msg, conn, remaining_size);
530 auto traits = cover->get_traits();
535 return fill_and_encode_entity_info_with_device_class(cover, msg, msg.
device_class, conn, remaining_size);
542 call.set_tilt(msg.
tilt);
544 call.set_command_stop();
551 return this->send_message_smart_(fan, FanStateResponse::MESSAGE_TYPE, FanStateResponse::ESTIMATED_SIZE);
554 auto *fan =
static_cast<fan::Fan *
>(entity);
556 auto traits = fan->get_traits();
557 msg.
state = fan->state;
558 if (traits.supports_oscillation())
560 if (traits.supports_speed()) {
563 if (traits.supports_direction())
565 if (traits.supports_preset_modes() && fan->has_preset_mode())
567 return fill_and_encode_entity_state(fan, msg, conn, remaining_size);
570 auto *fan =
static_cast<fan::Fan *
>(entity);
572 auto traits = fan->get_traits();
578 return fill_and_encode_entity_info(fan, msg, conn, remaining_size);
581 ENTITY_COMMAND_MAKE_CALL(
fan::Fan, fan, fan)
583 call.set_state(msg.
state);
600 return this->send_message_smart_(light, LightStateResponse::MESSAGE_TYPE, LightStateResponse::ESTIMATED_SIZE);
605 auto values = light->remote_values;
606 auto color_mode = values.get_color_mode();
607 resp.
state = values.is_on();
611 resp.
red = values.get_red();
612 resp.
green = values.get_green();
613 resp.
blue = values.get_blue();
614 resp.
white = values.get_white();
618 if (light->supports_effects()) {
619 resp.
effect = light->get_effect_name();
621 return fill_and_encode_entity_state(light, resp, conn, remaining_size);
626 auto traits = light->get_traits();
627 auto supported_modes = traits.get_supported_color_modes();
636 if (light->supports_effects()) {
637 auto &light_effects = light->get_effects();
638 effects_list.
init(light_effects.size() + 1);
640 for (
auto *effect : light_effects) {
642 effects_list.
push_back(effect->get_name().c_str());
646 return fill_and_encode_entity_info(light, msg, conn, remaining_size);
651 call.set_state(msg.
state);
659 call.set_red(msg.
red);
660 call.set_green(msg.
green);
661 call.set_blue(msg.
blue);
664 call.set_white(msg.
white);
683 return this->send_message_smart_(sensor, SensorStateResponse::MESSAGE_TYPE, SensorStateResponse::ESTIMATED_SIZE);
689 resp.
state = sensor->state;
691 return fill_and_encode_entity_state(sensor, resp, conn, remaining_size);
701 return fill_and_encode_entity_info_with_device_class(sensor, msg, msg.
device_class, conn, remaining_size);
707 return this->send_message_smart_(a_switch, SwitchStateResponse::MESSAGE_TYPE, SwitchStateResponse::ESTIMATED_SIZE);
713 resp.
state = a_switch->state;
714 return fill_and_encode_entity_state(a_switch, resp, conn, remaining_size);
721 return fill_and_encode_entity_info_with_device_class(a_switch, msg, msg.
device_class, conn, remaining_size);
729 a_switch->turn_off();
734#ifdef USE_TEXT_SENSOR
736 return this->send_message_smart_(text_sensor, TextSensorStateResponse::MESSAGE_TYPE,
737 TextSensorStateResponse::ESTIMATED_SIZE);
745 return fill_and_encode_entity_state(text_sensor, resp, conn, remaining_size);
750 return fill_and_encode_entity_info_with_device_class(text_sensor, msg, msg.
device_class, conn, remaining_size);
756 return this->send_message_smart_(climate, ClimateStateResponse::MESSAGE_TYPE, ClimateStateResponse::ESTIMATED_SIZE);
761 auto traits = climate->get_traits();
773 if (traits.get_supports_fan_modes() && climate->fan_mode.has_value())
775 if (!traits.get_supported_custom_fan_modes().empty() && climate->has_custom_fan_mode()) {
778 if (traits.get_supports_presets() && climate->preset.has_value()) {
781 if (!traits.get_supported_custom_presets().empty() && climate->has_custom_preset()) {
784 if (traits.get_supports_swing_modes())
790 return fill_and_encode_entity_state(climate, resp, conn, remaining_size);
795 auto traits = climate->get_traits();
818 return fill_and_encode_entity_info(climate, msg, conn, remaining_size);
848 return this->send_message_smart_(number, NumberStateResponse::MESSAGE_TYPE, NumberStateResponse::ESTIMATED_SIZE);
854 resp.
state = number->state;
856 return fill_and_encode_entity_state(number, resp, conn, remaining_size);
864 msg.
min_value = number->traits.get_min_value();
865 msg.
max_value = number->traits.get_max_value();
866 msg.
step = number->traits.get_step();
867 return fill_and_encode_entity_info_with_device_class(number, msg, msg.
device_class, conn, remaining_size);
871 call.set_value(msg.
state);
876#ifdef USE_DATETIME_DATE
878 return this->send_message_smart_(date, DateStateResponse::MESSAGE_TYPE, DateStateResponse::ESTIMATED_SIZE);
884 resp.
year = date->year;
885 resp.
month = date->month;
886 resp.
day = date->day;
887 return fill_and_encode_entity_state(date, resp, conn, remaining_size);
892 return fill_and_encode_entity_info(date, msg, conn, remaining_size);
901#ifdef USE_DATETIME_TIME
903 return this->send_message_smart_(time, TimeStateResponse::MESSAGE_TYPE, TimeStateResponse::ESTIMATED_SIZE);
909 resp.
hour = time->hour;
910 resp.
minute = time->minute;
911 resp.
second = time->second;
912 return fill_and_encode_entity_state(time, resp, conn, remaining_size);
917 return fill_and_encode_entity_info(time, msg, conn, remaining_size);
926#ifdef USE_DATETIME_DATETIME
928 return this->send_message_smart_(datetime, DateTimeStateResponse::MESSAGE_TYPE,
929 DateTimeStateResponse::ESTIMATED_SIZE);
935 if (datetime->has_state()) {
939 return fill_and_encode_entity_state(datetime, resp, conn, remaining_size);
944 return fill_and_encode_entity_info(datetime, msg, conn, remaining_size);
955 return this->send_message_smart_(text, TextStateResponse::MESSAGE_TYPE, TextStateResponse::ESTIMATED_SIZE);
959 auto *text =
static_cast<text::Text *
>(entity);
963 return fill_and_encode_entity_state(text, resp, conn, remaining_size);
967 auto *text =
static_cast<text::Text *
>(entity);
970 msg.
min_length = text->traits.get_min_length();
971 msg.
max_length = text->traits.get_max_length();
972 msg.
pattern = text->traits.get_pattern_ref();
973 return fill_and_encode_entity_info(text, msg, conn, remaining_size);
976 ENTITY_COMMAND_MAKE_CALL(
text::Text, text, text)
984 return this->send_message_smart_(select, SelectStateResponse::MESSAGE_TYPE, SelectStateResponse::ESTIMATED_SIZE);
990 resp.
state = select->current_option();
992 return fill_and_encode_entity_state(select, resp, conn, remaining_size);
998 msg.
options = &select->traits.get_options();
999 return fill_and_encode_entity_info(select, msg, conn, remaining_size);
1012 return fill_and_encode_entity_info_with_device_class(button, msg, msg.
device_class, conn, remaining_size);
1022 return this->send_message_smart_(a_lock, LockStateResponse::MESSAGE_TYPE, LockStateResponse::ESTIMATED_SIZE);
1026 auto *a_lock =
static_cast<lock::Lock *
>(entity);
1029 return fill_and_encode_entity_state(a_lock, resp, conn, remaining_size);
1033 auto *a_lock =
static_cast<lock::Lock *
>(entity);
1038 return fill_and_encode_entity_info(a_lock, msg, conn, remaining_size);
1044 case enums::LOCK_UNLOCK:
1047 case enums::LOCK_LOCK:
1050 case enums::LOCK_OPEN:
1059 return this->send_message_smart_(valve, ValveStateResponse::MESSAGE_TYPE, ValveStateResponse::ESTIMATED_SIZE);
1066 return fill_and_encode_entity_state(valve, resp, conn, remaining_size);
1071 auto traits = valve->get_traits();
1075 return fill_and_encode_entity_info_with_device_class(valve, msg, msg.
device_class, conn, remaining_size);
1082 call.set_command_stop();
1087#ifdef USE_MEDIA_PLAYER
1089 return this->send_message_smart_(media_player, MediaPlayerStateResponse::MESSAGE_TYPE,
1090 MediaPlayerStateResponse::ESTIMATED_SIZE);
1097 : media_player->state;
1099 resp.
volume = media_player->volume;
1100 resp.
muted = media_player->is_muted();
1101 return fill_and_encode_entity_state(media_player, resp, conn, remaining_size);
1106 auto traits = media_player->get_traits();
1109 for (
auto &supported_format : traits.get_supported_formats()) {
1112 media_format.format =
StringRef(supported_format.format);
1113 media_format.sample_rate = supported_format.sample_rate;
1114 media_format.num_channels = supported_format.num_channels;
1116 media_format.sample_bytes = supported_format.sample_bytes;
1118 return fill_and_encode_entity_info(media_player, msg, conn, remaining_size);
1126 call.set_volume(msg.
volume);
1139void APIConnection::try_send_camera_image_() {
1140 if (!this->image_reader_)
1144 while (this->image_reader_->available()) {
1145 if (!this->helper_->can_write_without_blocking())
1148 uint32_t to_send = std::min((
size_t) MAX_BATCH_PACKET_SIZE, this->image_reader_->available());
1149 bool done = this->image_reader_->available() == to_send;
1153 msg.
set_data(this->image_reader_->peek_data_buffer(), to_send);
1159 if (!this->send_message(msg)) {
1162 this->image_reader_->consume_data(to_send);
1164 this->image_reader_->return_image();
1169void APIConnection::set_camera_state(std::shared_ptr<camera::CameraImage> image) {
1170 if (!this->flags_.state_subscription)
1172 if (!this->image_reader_)
1174 if (this->image_reader_->available())
1177 this->image_reader_->set_image(std::move(image));
1179 this->try_send_camera_image_();
1185 return fill_and_encode_entity_info(camera, msg, conn, remaining_size);
1196 App.
scheduler.set_timeout(this->parent_,
"api_camera_stop_stream", CAMERA_STOP_STREAM,
1202#ifdef USE_HOMEASSISTANT_TIME
1206#if defined(USE_HOMEASSISTANT_TIMEZONE) && defined(USE_TIME_TIMEZONE)
1212 if (pt.std_offset_seconds != 0 || pt.dst_start.type != enums::DST_RULE_TYPE_NONE) {
1217 tz.
dst_start.
day =
static_cast<uint16_t
>(pt.dst_start.day);
1220 tz.
dst_start.
week =
static_cast<uint8_t
>(pt.dst_start.week);
1223 tz.
dst_end.
day =
static_cast<uint16_t
>(pt.dst_end.day);
1225 tz.
dst_end.
month =
static_cast<uint8_t
>(pt.dst_end.month);
1226 tz.
dst_end.
week =
static_cast<uint8_t
>(pt.dst_end.week);
1238#ifdef USE_BLUETOOTH_PROXY
1239void APIConnection::on_subscribe_bluetooth_le_advertisements_request(
1243void APIConnection::on_unsubscribe_bluetooth_le_advertisements_request() {
1246#ifdef USE_BLUETOOTH_PROXY_CONNECTIONS
1270bool APIConnection::send_subscribe_bluetooth_connections_free_response_() {
1274void APIConnection::on_subscribe_bluetooth_connections_free_request() {
1275 if (!this->send_subscribe_bluetooth_connections_free_response_()) {
1276 this->on_fatal_error();
1287 msg.
mode == enums::BluetoothScannerMode::BLUETOOTH_SCANNER_MODE_ACTIVE);
1291#ifdef USE_VOICE_ASSISTANT
1292bool APIConnection::check_voice_assistant_api_connection_()
const {
1303 if (!this->check_voice_assistant_api_connection_()) {
1311 if (msg.
port == 0) {
1317 this->helper_->getpeername((
struct sockaddr *) &storage, &
len);
1322 if (this->check_voice_assistant_api_connection_()) {
1327 if (this->check_voice_assistant_api_connection_()) {
1332 if (this->check_voice_assistant_api_connection_()) {
1338 if (this->check_voice_assistant_api_connection_()) {
1343bool APIConnection::send_voice_assistant_get_configuration_response_(
1346 if (!this->check_voice_assistant_api_connection_()) {
1348 const std::vector<std::string> empty_wake_words;
1350 return this->send_message(resp);
1354 for (
auto &wake_word : config.available_wake_words) {
1357 resp_wake_word.id =
StringRef(wake_word.id);
1358 resp_wake_word.wake_word =
StringRef(wake_word.wake_word);
1359 for (
const auto &lang : wake_word.trained_languages) {
1360 resp_wake_word.trained_languages.push_back(lang);
1366 return this->send_message(resp);
1369 if (!this->send_voice_assistant_get_configuration_response_(msg)) {
1370 this->on_fatal_error();
1375 if (this->check_voice_assistant_api_connection_()) {
1381#ifdef USE_ZWAVE_PROXY
1391#ifdef USE_ALARM_CONTROL_PANEL
1393 return this->send_message_smart_(a_alarm_control_panel, AlarmControlPanelStateResponse::MESSAGE_TYPE,
1394 AlarmControlPanelStateResponse::ESTIMATED_SIZE);
1401 return fill_and_encode_entity_state(a_alarm_control_panel, resp, conn, remaining_size);
1408 msg.
requires_code = a_alarm_control_panel->get_requires_code();
1410 return fill_and_encode_entity_info(a_alarm_control_panel, msg, conn, remaining_size);
1415 case enums::ALARM_CONTROL_PANEL_DISARM:
1418 case enums::ALARM_CONTROL_PANEL_ARM_AWAY:
1421 case enums::ALARM_CONTROL_PANEL_ARM_HOME:
1424 case enums::ALARM_CONTROL_PANEL_ARM_NIGHT:
1427 case enums::ALARM_CONTROL_PANEL_ARM_VACATION:
1428 call.arm_vacation();
1430 case enums::ALARM_CONTROL_PANEL_ARM_CUSTOM_BYPASS:
1431 call.arm_custom_bypass();
1433 case enums::ALARM_CONTROL_PANEL_TRIGGER:
1442#ifdef USE_WATER_HEATER
1444 return this->send_message_smart_(water_heater, WaterHeaterStateResponse::MESSAGE_TYPE,
1445 WaterHeaterStateResponse::ESTIMATED_SIZE);
1455 resp.
state = wh->get_state();
1457 return fill_and_encode_entity_state(wh, resp, conn, remaining_size);
1462 auto traits = wh->get_traits();
1469 return fill_and_encode_entity_info(wh, msg, conn, remaining_size);
1474 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_MODE)
1476 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE)
1478 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE_LOW)
1480 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE_HIGH)
1482 if ((msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_AWAY_STATE) ||
1483 (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_STATE)) {
1486 if ((msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_ON_STATE) ||
1487 (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_STATE)) {
1498 this->send_message_smart_(event, EventResponse::MESSAGE_TYPE, EventResponse::ESTIMATED_SIZE,
1505 return fill_and_encode_entity_state(event, resp, conn, remaining_size);
1512 return fill_and_encode_entity_info_with_device_class(event, msg, msg.
device_class, conn, remaining_size);
1516#if defined(USE_IR_RF) || defined(USE_RADIO_FREQUENCY)
1522 if (infrared !=
nullptr) {
1523 auto call = infrared->make_call();
1531#ifdef USE_RADIO_FREQUENCY
1533 if (radio_frequency !=
nullptr) {
1534 auto call = radio_frequency->make_call();
1545#if defined(USE_IR_RF) || defined(USE_RADIO_FREQUENCY)
1547 if (!this->send_message(msg)) {
1550 ESP_LOGV(TAG,
"IR/RF event dropped, TCP buffer full");
1555#ifdef USE_SERIAL_PROXY
1558 if (msg.
instance >= proxies.size()) {
1559 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range (max %" PRIu32
")", msg.
instance,
1560 static_cast<uint32_t>(proxies.size()));
1569 if (msg.
instance >= proxies.size()) {
1570 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1578 if (msg.
instance >= proxies.size()) {
1579 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1587 if (msg.
instance >= proxies.size()) {
1588 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1593 resp.line_states = proxies[msg.
instance]->get_modem_pins();
1594 if (!this->send_message(resp)) {
1595 API_LOG_MSG_DROPPED(TAG,
"Serial proxy response");
1601 if (msg.
instance >= proxies.size()) {
1602 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1606 case enums::SERIAL_PROXY_REQUEST_TYPE_SUBSCRIBE:
1607 case enums::SERIAL_PROXY_REQUEST_TYPE_UNSUBSCRIBE:
1608 proxies[msg.
instance]->serial_proxy_request(
this, msg.
type);
1610 case enums::SERIAL_PROXY_REQUEST_TYPE_FLUSH: {
1613 resp.type = enums::SERIAL_PROXY_REQUEST_TYPE_FLUSH;
1614 switch (proxies[msg.
instance]->flush_port()) {
1616 resp.status = enums::SERIAL_PROXY_STATUS_OK;
1619 resp.status = enums::SERIAL_PROXY_STATUS_ASSUMED_SUCCESS;
1622 resp.status = enums::SERIAL_PROXY_STATUS_TIMEOUT;
1625 resp.status = enums::SERIAL_PROXY_STATUS_ERROR;
1628 if (!this->send_message(resp)) {
1629 API_LOG_MSG_DROPPED(TAG,
"Serial proxy response");
1634 ESP_LOGW(TAG,
"Unknown serial proxy request type: %" PRIu32,
static_cast<uint32_t>(msg.
type));
1640 if (!this->send_message(msg)) {
1641 ESP_LOGV(TAG,
"Serial proxy data dropped, TCP buffer full");
1652 return fill_and_encode_entity_info(infrared, msg, conn, remaining_size);
1656#ifdef USE_RADIO_FREQUENCY
1662 msg.
frequency_min = rf->get_traits().get_frequency_min_hz();
1663 msg.
frequency_max = rf->get_traits().get_frequency_max_hz();
1665 return fill_and_encode_entity_info(rf, msg, conn, remaining_size);
1671 return this->send_message_smart_(update, UpdateStateResponse::MESSAGE_TYPE, UpdateStateResponse::ESTIMATED_SIZE);
1677 if (update->has_state()) {
1679 if (update->update_info.has_progress) {
1681 resp.
progress = update->update_info.progress;
1689 return fill_and_encode_entity_state(update, resp, conn, remaining_size);
1694 return fill_and_encode_entity_info_with_device_class(update, msg, msg.
device_class, conn, remaining_size);
1700 case enums::UPDATE_COMMAND_UPDATE:
1703 case enums::UPDATE_COMMAND_CHECK:
1706 case enums::UPDATE_COMMAND_NONE:
1707 ESP_LOGE(TAG,
"UPDATE_COMMAND_NONE not handled; confirm command is correct");
1710 ESP_LOGW(TAG,
"Unknown update command: %" PRIu32, msg.
command);
1716bool APIConnection::try_send_log_message(
int level,
const char *
tag,
const char *
line,
size_t message_len) {
1719 msg.
set_message(
reinterpret_cast<const uint8_t *
>(
line), message_len);
1720 return this->send_message(msg);
1723void APIConnection::complete_authentication_() {
1725 if (this->flags_.connection_state ==
static_cast<uint8_t
>(ConnectionState::AUTHENTICATED)) {
1729 this->flags_.connection_state =
static_cast<uint8_t
>(ConnectionState::AUTHENTICATED);
1732 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"connected"));
1733#ifdef USE_API_CLIENT_CONNECTED_TRIGGER
1735 char peername[socket::SOCKADDR_STR_LEN];
1736 this->parent_->get_client_connected_trigger()->trigger(std::string(this->helper_->get_client_name()),
1737 std::string(this->helper_->get_peername_to(peername)));
1740#ifdef USE_HOMEASSISTANT_TIME
1742 this->send_time_request();
1745#ifdef USE_ZWAVE_PROXY
1757 char peername[socket::SOCKADDR_STR_LEN];
1758 ESP_LOGV(TAG,
"Hello from client: '%s' | %s | API Version %" PRIu16
".%" PRIu16, this->helper_->get_client_name(),
1759 this->helper_->get_peername_to(peername), this->client_api_version_major_, this->client_api_version_minor_);
1768#ifdef USE_PROVISIONING
1773 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"Provisioning closed; rejecting connection"));
1774 if (!this->send_message(resp)) {
1775 API_LOG_MSG_DROPPED(TAG,
"Hello response");
1778 req.
reason = enums::DISCONNECT_REASON_PROVISIONING_CLOSED;
1779 return this->send_message(req);
1784 this->complete_authentication_();
1786 return this->send_message(resp);
1789bool APIConnection::send_ping_response_() {
1791 return this->send_message(resp);
1794bool APIConnection::send_device_info_response_() {
1801 char mac_address[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1802 uint8_t mac[MAC_ADDRESS_SIZE];
1815#if defined(USE_ESP8266) || defined(USE_ESP32)
1816#define ESPHOME_MANUFACTURER "Espressif"
1817#elif defined(USE_RP2)
1818#define ESPHOME_MANUFACTURER "Raspberry Pi"
1819#elif defined(USE_BK72XX)
1820#define ESPHOME_MANUFACTURER "Beken"
1821#elif defined(USE_LN882X)
1822#define ESPHOME_MANUFACTURER "Lightning"
1823#elif defined(USE_NRF52)
1824#define ESPHOME_MANUFACTURER "Nordic Semiconductor"
1825#elif defined(USE_RTL87XX)
1826#define ESPHOME_MANUFACTURER "Realtek"
1827#elif defined(USE_HOST)
1828#define ESPHOME_MANUFACTURER "Host"
1833 static const char MANUFACTURER_PROGMEM[]
PROGMEM = ESPHOME_MANUFACTURER;
1834 char manufacturer_buf[
sizeof(MANUFACTURER_PROGMEM)];
1835 memcpy_P(manufacturer_buf, MANUFACTURER_PROGMEM,
sizeof(MANUFACTURER_PROGMEM));
1841 static_assert(
sizeof(ESPHOME_MANUFACTURER) - 1 <= 20,
"Update max_data_length for manufacturer in api.proto");
1842#undef ESPHOME_MANUFACTURER
1845 static const char MODEL_PROGMEM[]
PROGMEM = ESPHOME_BOARD;
1846 char model_buf[
sizeof(MODEL_PROGMEM)];
1847 memcpy_P(model_buf, MODEL_PROGMEM,
sizeof(MODEL_PROGMEM));
1853#ifdef USE_DEEP_SLEEP
1856#ifdef ESPHOME_PROJECT_NAME
1858 static const char PROJECT_NAME_PROGMEM[]
PROGMEM = ESPHOME_PROJECT_NAME;
1859 static const char PROJECT_VERSION_PROGMEM[]
PROGMEM = ESPHOME_PROJECT_VERSION;
1860 char project_name_buf[
sizeof(PROJECT_NAME_PROGMEM)];
1861 char project_version_buf[
sizeof(PROJECT_VERSION_PROGMEM)];
1862 memcpy_P(project_name_buf, PROJECT_NAME_PROGMEM,
sizeof(PROJECT_NAME_PROGMEM));
1863 memcpy_P(project_version_buf, PROJECT_VERSION_PROGMEM,
sizeof(PROJECT_VERSION_PROGMEM));
1876#ifdef USE_BLUETOOTH_PROXY
1878 char bluetooth_mac[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1882#ifdef USE_VOICE_ASSISTANT
1885#ifdef USE_ZWAVE_PROXY
1889#ifdef USE_SERIAL_PROXY
1890 size_t serial_proxy_index = 0;
1892 if (serial_proxy_index >= SERIAL_PROXY_COUNT)
1895 info.name =
StringRef(proxy->get_name());
1896 info.port_type = proxy->get_port_type();
1901#ifndef USE_API_NOISE_PSK_FROM_YAML
1909 size_t device_index = 0;
1911 if (device_index >= ESPHOME_DEVICE_COUNT)
1913 auto &device_info = resp.
devices[device_index++];
1914 device_info.device_id = device->get_device_id();
1915 device_info.name =
StringRef(device->get_name());
1916 device_info.area_id = device->get_area_id();
1920 size_t area_index = 0;
1922 if (area_index >= ESPHOME_AREA_COUNT)
1924 auto &area_info = resp.
areas[area_index++];
1925 area_info.area_id = area->get_area_id();
1926 area_info.name =
StringRef(area->get_name());
1930 return this->send_message(resp);
1932bool APIConnection::send_device_capabilities_response_() {
1936#ifdef USE_BLUETOOTH_PROXY
1938 char bluetooth_mac[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
1942#ifdef USE_VOICE_ASSISTANT
1945#ifdef USE_ZWAVE_PROXY
1949#ifdef USE_SERIAL_PROXY
1950 size_t serial_proxy_index = 0;
1952 if (serial_proxy_index >= SERIAL_PROXY_COUNT)
1955 info.name =
StringRef(proxy->get_name());
1956 info.port_type = proxy->get_port_type();
1959 return this->send_message(resp);
1962 if (!this->send_hello_response_(msg)) {
1963 this->on_fatal_error();
1968 if (!this->send_disconnect_response_()) {
1969 this->on_fatal_error();
1972void APIConnection::on_ping_request() {
1973 if (!this->send_ping_response_()) {
1974 this->on_fatal_error();
1977void APIConnection::on_device_info_request() {
1978 if (!this->send_device_info_response_()) {
1979 this->on_fatal_error();
1982void APIConnection::on_device_capabilities_request() {
1983 if (!this->send_device_capabilities_response_()) {
1984 this->on_fatal_error();
1988#ifdef USE_API_HOMEASSISTANT_STATES
2004 for (
auto &it : this->parent_->get_state_subs()) {
2015 it.callback(msg.
state);
2019#ifdef USE_API_USER_DEFINED_ACTIONS
2027 if (!arg.string_.empty()) {
2028 const_cast<char *
>(arg.string_.c_str())[arg.string_.size()] =
'\0';
2032#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES
2037 action_call_id = this->parent_->register_active_action_call(msg.
call_id,
this);
2040 for (
auto *service : this->parent_->get_user_services()) {
2041 if (service->execute_service(msg, action_call_id)) {
2046 for (
auto *service : this->parent_->get_user_services()) {
2047 if (service->execute_service(msg)) {
2053 ESP_LOGV(TAG,
"Could not find service");
2059#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES
2060void APIConnection::send_execute_service_response(
uint32_t call_id,
bool success,
StringRef error_message) {
2065 if (!this->send_message(resp)) {
2066 API_LOG_MSG_DROPPED(TAG,
"Action response");
2069#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES_JSON
2070void APIConnection::send_execute_service_response(
uint32_t call_id,
bool success,
StringRef error_message,
2071 const uint8_t *response_data,
size_t response_data_len) {
2078 if (!this->send_message(resp)) {
2079 API_LOG_MSG_DROPPED(TAG,
"Action response");
2086#ifdef USE_API_HOMEASSISTANT_SERVICES
2088 if (!this->flags_.service_call_subscription)
2090 if (!this->send_message(call)) {
2091 API_LOG_MSG_DROPPED(TAG,
"Action request");
2097#ifdef USE_HOMEASSISTANT_TIME
2098void APIConnection::send_time_request() {
2100 if (!this->send_message(req)) {
2101 API_LOG_MSG_DROPPED(TAG,
"Time request");
2106#ifdef USE_API_HOMEASSISTANT_ACTION_RESPONSES
2108#ifdef USE_API_HOMEASSISTANT_ACTION_RESPONSES_JSON
2124#ifdef USE_PROVISIONING
2128 ESP_LOGW(TAG,
"Provisioning closed; rejecting key set");
2129 return this->send_message(resp);
2135 if (this->parent_->clear_noise_psk(
true)) {
2138 ESP_LOGW(TAG,
"Failed to clear encryption key");
2141 ESP_LOGW(TAG,
"Invalid encryption key length");
2142 }
else if (APINoiseContext::is_all_zeros(psk)) {
2145 ESP_LOGW(TAG,
"Rejecting all-zero encryption key");
2146 }
else if (!this->parent_->save_noise_psk(psk,
true)) {
2147 ESP_LOGW(TAG,
"Failed to save encryption key");
2150#ifdef USE_API_PLAINTEXT
2151 if (this->helper_->frame_footer_size() == 0) {
2154 ESP_LOGW(TAG,
"Key received over plaintext; deprecated, will be removed in 2027.2.0");
2159 return this->send_message(resp);
2162 if (!this->send_noise_encryption_set_key_response_(msg)) {
2163 this->on_fatal_error();
2167#ifdef USE_API_HOMEASSISTANT_STATES
2168void APIConnection::on_subscribe_home_assistant_states_request() { state_subs_at_ = 0; }
2170bool APIConnection::try_to_clear_buffer_slow_(
bool log_out_of_space) {
2172 APIError err = this->helper_->loop();
2173 if (err != APIError::OK) {
2174 this->fatal_error_with_log_(LOG_STR(
"Socket operation failed"), err);
2177 if (this->helper_->can_write_without_blocking())
2179 if (log_out_of_space) {
2183 ESP_LOGVV(TAG,
"Cannot send message because of TCP buffer space");
2189#ifdef HAS_PROTO_MESSAGE_DUMP
2191 if (message_type != SubscribeLogsResponse::MESSAGE_TYPE
2193 && message_type != CameraImageResponse::MESSAGE_TYPE
2196 auto *proto_msg =
static_cast<const ProtoMessage *
>(msg);
2198 this->log_send_message_(proto_msg->message_name(), proto_msg->dump_to(dump_buf));
2201 auto &shared_buf = this->parent_->get_shared_buffer_ref();
2202 this->prepare_first_message_buffer(shared_buf,
payload_size);
2203 size_t write_start = shared_buf.size();
2206 encode_fn(msg, buffer PROTO_ENCODE_DEBUG_INIT(&shared_buf));
2214 return encode_to_buffer(calculated_size, encode_fn, msg, conn, remaining_size);
2217 const bool is_log_message = (message_type == SubscribeLogsResponse::MESSAGE_TYPE);
2219 if (!this->try_to_clear_buffer(!is_log_message)) {
2224 this->helper_->set_nodelay_for_message(is_log_message);
2226 APIError err = this->helper_->write_protobuf_packet(message_type, buffer);
2227 if (err == APIError::WOULD_BLOCK)
2229 if (err != APIError::OK) {
2230 this->fatal_error_with_log_(LOG_STR(
"Packet write failed"), err);
2236void APIConnection::on_no_setup_connection() {
2237 this->on_fatal_error();
2238 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"no connection setup"));
2240void APIConnection::on_fatal_error() {
2243 this->flags_.remove =
true;
2246bool APIConnection::schedule_message_front_(
EntityBase *entity, uint8_t message_type, uint8_t estimated_size) {
2247 this->deferred_batch_.add_item_front(entity, message_type, estimated_size);
2248 return this->schedule_batch_();
2251bool APIConnection::send_message_smart_(
EntityBase *entity, uint8_t message_type, uint8_t estimated_size,
2252 uint8_t aux_data_index) {
2253 if (this->should_send_immediately_(message_type) && this->helper_->can_write_without_blocking()) {
2254 auto &shared_buf = this->parent_->get_shared_buffer_ref();
2255 this->prepare_first_message_buffer(shared_buf, estimated_size);
2257 if (this->dispatch_message_(item, MAX_BATCH_PACKET_SIZE,
true) &&
2259#ifdef HAS_PROTO_MESSAGE_DUMP
2260 this->log_batch_item_(item);
2265 return this->schedule_message_(entity, message_type, estimated_size, aux_data_index);
2268bool APIConnection::schedule_batch_() {
2269 if (!this->flags_.batch_scheduled) {
2270 this->flags_.batch_scheduled =
true;
2276void APIConnection::process_batch_() {
2277 if (this->deferred_batch_.empty()) {
2278 this->flags_.batch_scheduled =
false;
2287 this->helper_->set_nodelay_for_message(
false);
2290 if (!this->try_to_clear_buffer(
true)) {
2296 auto &shared_buf = this->parent_->get_shared_buffer_ref();
2297 size_t num_items = this->deferred_batch_.size();
2300 const uint8_t header_padding = this->helper_->frame_header_padding();
2301 const uint8_t footer_size = this->helper_->frame_footer_size();
2304 uint32_t total_estimated_size = num_items * (header_padding + footer_size);
2305 for (
size_t i = 0; i < num_items; i++) {
2306 total_estimated_size += this->deferred_batch_[i].estimated_size;
2309 if (total_estimated_size > MAX_BATCH_PACKET_SIZE) {
2310 total_estimated_size = MAX_BATCH_PACKET_SIZE;
2313 this->prepare_first_message_buffer(shared_buf, header_padding, total_estimated_size);
2316 if (num_items == 1) {
2317 const auto &item = this->deferred_batch_[0];
2319 uint16_t
payload_size = this->dispatch_message_(item, std::numeric_limits<uint16_t>::max(),
true);
2322#ifdef HAS_PROTO_MESSAGE_DUMP
2324 this->log_batch_item_(item);
2326 this->clear_batch_();
2329 ESP_LOGW(TAG,
"Message too large to send: type=%u", item.message_type);
2330 this->clear_batch_();
2336 this->process_batch_multi_(shared_buf, num_items, header_padding, footer_size);
2341void APIConnection::process_batch_multi_(
APIBuffer &shared_buf,
size_t num_items, uint8_t header_padding,
2342 uint8_t footer_size) {
2344 static_assert(std::is_trivially_destructible<MessageInfo>::value,
2345 "MessageInfo must remain trivially destructible with this placement-new approach");
2347 const size_t messages_to_process = std::min(num_items, MAX_MESSAGES_PER_BATCH);
2352 size_t items_processed = 0;
2353 uint16_t remaining_size = std::numeric_limits<uint16_t>::max();
2360 for (
size_t i = 0; i < messages_to_process; i++) {
2361 const auto &item = this->deferred_batch_[i];
2364 uint16_t
payload_size = this->dispatch_message_(item, remaining_size, i == 0);
2373 uint16_t proto_payload_size =
payload_size - this->batch_header_size_ - footer_size;
2378 new (&message_info[items_processed++])
2379 MessageInfo(item.message_type, current_offset, proto_payload_size, this->batch_header_size_);
2381 if (items_processed == 1) {
2382 remaining_size = MAX_BATCH_PACKET_SIZE;
2387 current_offset = shared_buf.
size() + footer_size;
2390 if (items_processed > 0) {
2392 if (footer_size > 0) {
2393 shared_buf.
resize(shared_buf.
size() + footer_size);
2398 std::span<const MessageInfo>(message_info, items_processed));
2399 if (err != APIError::OK && err != APIError::WOULD_BLOCK) {
2400 this->fatal_error_with_log_(LOG_STR(
"Batch write failed"), err);
2403#ifdef HAS_PROTO_MESSAGE_DUMP
2406 for (
size_t i = 0; i < items_processed; i++) {
2407 const auto &item = this->deferred_batch_[i];
2408 this->log_batch_item_(item);
2413 if (items_processed < this->deferred_batch_.size()) {
2414 this->deferred_batch_.remove_front(items_processed);
2415 this->schedule_batch_();
2421 this->clear_batch_();
2428 this->flags_.batch_first_message = batch_first;
2432 if (item.
message_type == EventResponse::MESSAGE_TYPE) {
2438 this, remaining_size);
2446#define CASE_STATE_INFO(entity_name, StateResp, InfoResp) \
2447 case StateResp::MESSAGE_TYPE: \
2448 func = &try_send_##entity_name##_state; \
2450 case InfoResp::MESSAGE_TYPE: \
2451 func = &try_send_##entity_name##_info; \
2453#define CASE_INFO_ONLY(entity_name, InfoResp) \
2454 case InfoResp::MESSAGE_TYPE: \
2455 func = &try_send_##entity_name##_info; \
2459#ifdef USE_BINARY_SENSOR
2480#ifdef USE_TEXT_SENSOR
2489#ifdef USE_DATETIME_DATE
2492#ifdef USE_DATETIME_TIME
2495#ifdef USE_DATETIME_DATETIME
2510#ifdef USE_MEDIA_PLAYER
2513#ifdef USE_ALARM_CONTROL_PANEL
2516#ifdef USE_WATER_HEATER
2525#ifdef USE_RADIO_FREQUENCY
2535 case ListEntitiesDoneResponse::MESSAGE_TYPE:
2536 func = &try_send_list_info_done;
2538 case DisconnectRequest::MESSAGE_TYPE:
2539 func = &try_send_disconnect_request;
2541 case PingRequest::MESSAGE_TYPE:
2542 func = &try_send_ping_request;
2548#undef CASE_STATE_INFO
2549#undef CASE_INFO_ONLY
2551 return func(item.
entity,
this, remaining_size);
2556 return encode_message_to_buffer(resp, conn, remaining_size);
2561 return encode_message_to_buffer(req, conn, remaining_size);
2566 return encode_message_to_buffer(req, conn, remaining_size);
2569#ifdef USE_API_HOMEASSISTANT_STATES
2570void APIConnection::process_state_subscriptions_() {
2571 const auto &subs = this->parent_->get_state_subs();
2572 if (this->state_subs_at_ >=
static_cast<int>(subs.size())) {
2573 this->state_subs_at_ = -1;
2577 const auto &it = subs[this->state_subs_at_];
2584 resp.
once = it.once;
2585 if (this->send_message(resp)) {
2586 this->state_subs_at_++;
2591void APIConnection::log_client_(
int level,
const LogString *
message) {
2592 char peername[socket::SOCKADDR_STR_LEN];
2593 esp_log_printf_(level, TAG, __LINE__, ESPHOME_LOG_FORMAT(
"%s (%s): %s"), this->helper_->get_client_name(),
2594 this->helper_->get_peername_to(peername), LOG_STR_ARG(
message));
2598 char peername[socket::SOCKADDR_STR_LEN];
2599 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
ESPDEPRECATED("Use get_unit_of_measurement_ref() instead for better performance (avoids string copy). Will be " "removed in ESPHome 2026.9.0", "2026.3.0") std const char * get_icon_to(std::span< char, MAX_ICON_LENGTH > buffer) const
Get the unit of measurement as std::string (deprecated, prefer get_unit_of_measurement_ref())
uint32_t get_object_id_hash() const
ESPDEPRECATED("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std uint32_t get_device_id() const
bool is_disabled_by_default() const
EntityCategory get_entity_category() const
Fixed-capacity vector - allocates once at runtime, never reallocates This avoids std::vector template...
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().
void resize(size_t n) ESPHOME_ALWAYS_INLINE
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
APINoiseContext & 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
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.
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.
void set_timezone(const char *tz)
Set the time zone from a POSIX TZ string.
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)
void zwave_proxy_request(api::APIConnection *api_connection, api::enums::ZWaveProxyRequestType type)
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)
const LogString * message
const LogString * api_error_to_logstr(APIError err)
void log_dropped_message(const char *tag, int line, const LogString *what)
std::array< uint8_t, 32 > psk_t
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.
ProvisioningManager * global_provisioning_manager
RadioFrequencyModulation
Modulation types supported by radio frequency implementations.
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.
@ UART_FLUSH_RESULT_ASSUMED_SUCCESS
Platform cannot report result; success is assumed.
@ UART_FLUSH_RESULT_SUCCESS
Confirmed: all bytes left the TX FIFO.
@ UART_FLUSH_RESULT_FAILED
Confirmed: driver or hardware error.
@ UART_FLUSH_RESULT_TIMEOUT
Confirmed: timed out before TX completed.
@ 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
const char int const __FlashStringHelper va_list args
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