7#ifdef USE_API_PLAINTEXT
10#ifdef USE_API_USER_DEFINED_ACTIONS
32#ifdef USE_HOMEASSISTANT_TIME
35#ifdef USE_BLUETOOTH_PROXY
41#ifdef USE_VOICE_ASSISTANT
47#ifdef USE_WATER_HEATER
53#ifdef USE_RADIO_FREQUENCY
63static constexpr uint8_t MAX_MESSAGES_PER_LOOP = 10;
64static constexpr uint8_t MAX_PING_RETRIES = 60;
65static constexpr uint16_t PING_RETRY_INTERVAL = 1000;
66static constexpr uint32_t KEEPALIVE_DISCONNECT_TIMEOUT = (KEEPALIVE_TIMEOUT_MS * 5) / 2;
75static constexpr uint32_t HANDSHAKE_TIMEOUT_MS = 60000;
80static_assert(MAC_ADDRESS_PRETTY_BUFFER_SIZE - 1 == 17,
81 "Update max_data_length for mac_address/bluetooth_mac_address in api.proto");
83static_assert(
sizeof(ESPHOME_VERSION) - 1 <= 32,
"Update max_data_length for esphome_version in api.proto");
84static_assert(ESPHOME_DEVICE_NAME_MAX_LEN <= 31,
"Update max_data_length for name in api.proto");
85static_assert(ESPHOME_FRIENDLY_NAME_MAX_LEN <= 120,
"Update max_data_length for friendly_name in api.proto");
87static const char *
const TAG =
"api.connection";
89static const int CAMERA_STOP_STREAM = 5000;
95#define ENTITY_COMMAND_MAKE_CALL(entity_type, entity_var, getter_name) \
96 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key, msg.device_id); \
97 if ((entity_var) == nullptr) \
99 auto call = (entity_var)->make_call();
103#define ENTITY_COMMAND_GET(entity_type, entity_var, getter_name) \
104 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key, msg.device_id); \
105 if ((entity_var) == nullptr) \
110#define ENTITY_COMMAND_LOOKUP(entity_type, entity_var, getter_name) \
111 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key, msg.device_id)
116#define ENTITY_COMMAND_MAKE_CALL(entity_type, entity_var, getter_name) \
117 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key); \
118 if ((entity_var) == nullptr) \
120 auto call = (entity_var)->make_call();
124#define ENTITY_COMMAND_GET(entity_type, entity_var, getter_name) \
125 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key); \
126 if ((entity_var) == nullptr) \
131#define ENTITY_COMMAND_LOOKUP(entity_type, entity_var, getter_name) \
132 entity_type *entity_var = App.get_##getter_name##_by_key(msg.key)
137#if defined(USE_API_PLAINTEXT) && defined(USE_API_NOISE)
139 if (noise_ctx.has_psk()) {
140 this->helper_ = std::unique_ptr<APIFrameHelper>{new APINoiseFrameHelper(std::move(sock), noise_ctx)};
144#elif defined(USE_API_PLAINTEXT)
145 this->helper_ = std::unique_ptr<APIPlaintextFrameHelper>{
new APIPlaintextFrameHelper(std::move(sock))};
146#elif defined(USE_API_NOISE)
148 std::unique_ptr<APINoiseFrameHelper>{
new APINoiseFrameHelper(std::move(sock), parent->get_noise_ctx())};
150#error "No frame helper defined"
159void APIConnection::start() {
162 APIError err = this->helper_->init();
163 if (err != APIError::OK) {
164 this->fatal_error_with_log_(LOG_STR(
"Helper init failed"), err);
168 char peername[socket::SOCKADDR_STR_LEN];
169 this->helper_->set_client_name(this->helper_->get_peername_to(peername), strlen(peername));
172APIConnection::~APIConnection() {
173 this->destroy_active_iterator_();
174#ifdef USE_BLUETOOTH_PROXY
179#ifdef USE_VOICE_ASSISTANT
184#ifdef USE_ZWAVE_PROXY
189#ifdef USE_SERIAL_PROXY
191 if (proxy->get_api_connection() ==
this) {
192 proxy->serial_proxy_request(
this, enums::SERIAL_PROXY_REQUEST_TYPE_UNSUBSCRIBE);
198void APIConnection::destroy_active_iterator_() {
199 switch (this->active_iterator_) {
200 case ActiveIterator::LIST_ENTITIES:
201 this->iterator_storage_.list_entities.~ListEntitiesIterator();
203 case ActiveIterator::INITIAL_STATE:
204 this->iterator_storage_.initial_state.~InitialStateIterator();
206 case ActiveIterator::NONE:
209 this->active_iterator_ = ActiveIterator::NONE;
213 this->destroy_active_iterator_();
214 this->active_iterator_ =
type;
215 if (
type == ActiveIterator::LIST_ENTITIES) {
217 this->iterator_storage_.list_entities.
begin();
220 this->iterator_storage_.initial_state.
begin();
224void APIConnection::loop() {
225 if (this->flags_.next_close) {
228 this->flags_.remove =
true;
232 APIError err = this->helper_->loop();
233 if (err != APIError::OK) {
234 this->fatal_error_with_log_(LOG_STR(
"Socket operation failed"), err);
245 if (this->helper_->is_socket_ready() || this->flags_.may_have_remaining_data) {
246 this->flags_.may_have_remaining_data =
false;
248 uint8_t message_count = 0;
249 for (; message_count < MAX_MESSAGES_PER_LOOP; message_count++) {
251 err = this->helper_->read_packet(&buffer);
252 if (err == APIError::WOULD_BLOCK) {
255 }
else if (err != APIError::OK) {
256 this->fatal_error_with_log_(LOG_STR(
"Reading failed"), err);
262 if (this->is_authenticated()) {
263 this->last_traffic_ = now;
267 if (this->flags_.remove)
273 if (message_count == MAX_MESSAGES_PER_LOOP) {
274 this->flags_.may_have_remaining_data =
true;
279 if (this->flags_.batch_scheduled && now - this->deferred_batch_.batch_start_time >= this->get_batch_delay_ms_()) {
280 this->process_batch_();
283 if (this->active_iterator_ != ActiveIterator::NONE) {
284 this->process_active_iterator_();
290 if (!this->is_authenticated() && now - this->last_traffic_ > HANDSHAKE_TIMEOUT_MS) {
291 this->on_fatal_error();
292 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"handshake timeout; disconnecting"));
299 if (now - this->last_traffic_ > KEEPALIVE_TIMEOUT_MS) {
300 this->check_keepalive_(now);
303#ifdef USE_API_HOMEASSISTANT_STATES
304 if (state_subs_at_ >= 0) {
305 this->process_state_subscriptions_();
312 this->try_send_camera_image_();
316void APIConnection::check_keepalive_(
uint32_t now) {
318 if (this->flags_.sent_ping) {
320 if (now - this->last_traffic_ > KEEPALIVE_DISCONNECT_TIMEOUT) {
322 this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR(
"is unresponsive; disconnecting"));
324 }
else if (!this->flags_.remove) {
326 ESP_LOGVV(TAG,
"Sending keepalive PING");
328 this->flags_.sent_ping = this->send_message(req);
329 if (!this->flags_.sent_ping) {
332 ESP_LOGW(TAG,
"Buffer full, ping queued");
333 this->schedule_message_front_(
nullptr, PingRequest::MESSAGE_TYPE, PingRequest::ESTIMATED_SIZE);
334 this->flags_.sent_ping =
true;
339void APIConnection::process_active_iterator_() {
341 if (this->active_iterator_ == ActiveIterator::LIST_ENTITIES) {
342 if (this->iterator_storage_.list_entities.completed()) {
343 this->destroy_active_iterator_();
344 if (this->flags_.state_subscription) {
345 this->begin_iterator_(ActiveIterator::INITIAL_STATE);
347 this->finalize_iterator_sync_();
350 this->process_iterator_batch_(this->iterator_storage_.list_entities);
353 if (this->iterator_storage_.initial_state.completed()) {
354 this->destroy_active_iterator_();
355 this->finalize_iterator_sync_();
357 this->process_iterator_batch_(this->iterator_storage_.initial_state);
362void APIConnection::finalize_iterator_sync_() {
366 if (!this->deferred_batch_.empty()) {
367 this->process_batch_();
370 this->flags_.should_try_send_immediately =
true;
372 this->deferred_batch_.release_buffer();
373 this->helper_->release_buffers();
377 size_t initial_size = this->deferred_batch_.size();
378 size_t max_batch = this->get_max_batch_size_();
379 while (!iterator.
completed() && (this->deferred_batch_.size() - initial_size) < max_batch) {
385 if (this->deferred_batch_.size() >= max_batch) {
386 this->process_batch_();
390bool APIConnection::send_disconnect_response_() {
394 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"disconnected"));
395 this->flags_.next_close =
true;
397 return this->send_message(resp);
399void APIConnection::on_disconnect_response() {
402 this->flags_.remove =
true;
412 return encode_to_buffer(size_fn(&msg), encode_fn, &msg, conn, remaining_size);
426 char object_id_buf[OBJECT_ID_MAX_LEN];
436#ifdef USE_ENTITY_ICON
437 char icon_buf[MAX_ICON_LENGTH];
445 return encode_to_buffer_slow(size_fn(&msg), encode_fn, &msg, conn, remaining_size);
453 char dc_buf[MAX_DEVICE_CLASS_LENGTH];
455 return fill_and_encode_entity_info(entity, msg, size_fn, encode_fn, conn, remaining_size);
458#ifdef USE_BINARY_SENSOR
460 return this->send_message_smart_(binary_sensor, BinarySensorStateResponse::MESSAGE_TYPE,
461 BinarySensorStateResponse::ESTIMATED_SIZE);
467 resp.
state = binary_sensor->state;
469 return fill_and_encode_entity_state(binary_sensor, resp, conn, remaining_size);
476 return fill_and_encode_entity_info_with_device_class(binary_sensor, msg, msg.
device_class, conn, remaining_size);
482 return this->send_message_smart_(cover, CoverStateResponse::MESSAGE_TYPE, CoverStateResponse::ESTIMATED_SIZE);
487 auto traits = cover->get_traits();
489 if (traits.get_supports_tilt())
490 msg.
tilt = cover->tilt;
492 return fill_and_encode_entity_state(cover, msg, conn, remaining_size);
497 auto traits = cover->get_traits();
502 return fill_and_encode_entity_info_with_device_class(cover, msg, msg.
device_class, conn, remaining_size);
509 call.set_tilt(msg.
tilt);
511 call.set_command_stop();
518 return this->send_message_smart_(fan, FanStateResponse::MESSAGE_TYPE, FanStateResponse::ESTIMATED_SIZE);
521 auto *fan =
static_cast<fan::Fan *
>(entity);
523 auto traits = fan->get_traits();
524 msg.
state = fan->state;
525 if (traits.supports_oscillation())
527 if (traits.supports_speed()) {
530 if (traits.supports_direction())
532 if (traits.supports_preset_modes() && fan->has_preset_mode())
534 return fill_and_encode_entity_state(fan, msg, conn, remaining_size);
537 auto *fan =
static_cast<fan::Fan *
>(entity);
539 auto traits = fan->get_traits();
545 return fill_and_encode_entity_info(fan, msg, conn, remaining_size);
548 ENTITY_COMMAND_MAKE_CALL(
fan::Fan, fan, fan)
550 call.set_state(msg.
state);
567 return this->send_message_smart_(light, LightStateResponse::MESSAGE_TYPE, LightStateResponse::ESTIMATED_SIZE);
572 auto values = light->remote_values;
573 auto color_mode = values.get_color_mode();
574 resp.
state = values.is_on();
578 resp.
red = values.get_red();
579 resp.
green = values.get_green();
580 resp.
blue = values.get_blue();
581 resp.
white = values.get_white();
585 if (light->supports_effects()) {
586 resp.
effect = light->get_effect_name();
588 return fill_and_encode_entity_state(light, resp, conn, remaining_size);
593 auto traits = light->get_traits();
594 auto supported_modes = traits.get_supported_color_modes();
603 if (light->supports_effects()) {
604 auto &light_effects = light->get_effects();
605 effects_list.
init(light_effects.size() + 1);
607 for (
auto *effect : light_effects) {
609 effects_list.
push_back(effect->get_name().c_str());
613 return fill_and_encode_entity_info(light, msg, conn, remaining_size);
618 call.set_state(msg.
state);
626 call.set_red(msg.
red);
627 call.set_green(msg.
green);
628 call.set_blue(msg.
blue);
631 call.set_white(msg.
white);
650 return this->send_message_smart_(sensor, SensorStateResponse::MESSAGE_TYPE, SensorStateResponse::ESTIMATED_SIZE);
656 resp.
state = sensor->state;
658 return fill_and_encode_entity_state(sensor, resp, conn, remaining_size);
668 return fill_and_encode_entity_info_with_device_class(sensor, msg, msg.
device_class, conn, remaining_size);
674 return this->send_message_smart_(a_switch, SwitchStateResponse::MESSAGE_TYPE, SwitchStateResponse::ESTIMATED_SIZE);
680 resp.
state = a_switch->state;
681 return fill_and_encode_entity_state(a_switch, resp, conn, remaining_size);
688 return fill_and_encode_entity_info_with_device_class(a_switch, msg, msg.
device_class, conn, remaining_size);
696 a_switch->turn_off();
701#ifdef USE_TEXT_SENSOR
703 return this->send_message_smart_(text_sensor, TextSensorStateResponse::MESSAGE_TYPE,
704 TextSensorStateResponse::ESTIMATED_SIZE);
712 return fill_and_encode_entity_state(text_sensor, resp, conn, remaining_size);
717 return fill_and_encode_entity_info_with_device_class(text_sensor, msg, msg.
device_class, conn, remaining_size);
723 return this->send_message_smart_(climate, ClimateStateResponse::MESSAGE_TYPE, ClimateStateResponse::ESTIMATED_SIZE);
728 auto traits = climate->get_traits();
740 if (traits.get_supports_fan_modes() && climate->fan_mode.has_value())
742 if (!traits.get_supported_custom_fan_modes().empty() && climate->has_custom_fan_mode()) {
745 if (traits.get_supports_presets() && climate->preset.has_value()) {
748 if (!traits.get_supported_custom_presets().empty() && climate->has_custom_preset()) {
751 if (traits.get_supports_swing_modes())
757 return fill_and_encode_entity_state(climate, resp, conn, remaining_size);
762 auto traits = climate->get_traits();
784 return fill_and_encode_entity_info(climate, msg, conn, remaining_size);
814 return this->send_message_smart_(number, NumberStateResponse::MESSAGE_TYPE, NumberStateResponse::ESTIMATED_SIZE);
820 resp.
state = number->state;
822 return fill_and_encode_entity_state(number, resp, conn, remaining_size);
830 msg.
min_value = number->traits.get_min_value();
831 msg.
max_value = number->traits.get_max_value();
832 msg.
step = number->traits.get_step();
833 return fill_and_encode_entity_info_with_device_class(number, msg, msg.
device_class, conn, remaining_size);
837 call.set_value(msg.
state);
842#ifdef USE_DATETIME_DATE
844 return this->send_message_smart_(date, DateStateResponse::MESSAGE_TYPE, DateStateResponse::ESTIMATED_SIZE);
850 resp.
year = date->year;
851 resp.
month = date->month;
852 resp.
day = date->day;
853 return fill_and_encode_entity_state(date, resp, conn, remaining_size);
858 return fill_and_encode_entity_info(date, msg, conn, remaining_size);
867#ifdef USE_DATETIME_TIME
869 return this->send_message_smart_(time, TimeStateResponse::MESSAGE_TYPE, TimeStateResponse::ESTIMATED_SIZE);
875 resp.
hour = time->hour;
876 resp.
minute = time->minute;
877 resp.
second = time->second;
878 return fill_and_encode_entity_state(time, resp, conn, remaining_size);
883 return fill_and_encode_entity_info(time, msg, conn, remaining_size);
892#ifdef USE_DATETIME_DATETIME
894 return this->send_message_smart_(datetime, DateTimeStateResponse::MESSAGE_TYPE,
895 DateTimeStateResponse::ESTIMATED_SIZE);
901 if (datetime->has_state()) {
905 return fill_and_encode_entity_state(datetime, resp, conn, remaining_size);
910 return fill_and_encode_entity_info(datetime, msg, conn, remaining_size);
921 return this->send_message_smart_(text, TextStateResponse::MESSAGE_TYPE, TextStateResponse::ESTIMATED_SIZE);
925 auto *text =
static_cast<text::Text *
>(entity);
929 return fill_and_encode_entity_state(text, resp, conn, remaining_size);
933 auto *text =
static_cast<text::Text *
>(entity);
936 msg.
min_length = text->traits.get_min_length();
937 msg.
max_length = text->traits.get_max_length();
938 msg.
pattern = text->traits.get_pattern_ref();
939 return fill_and_encode_entity_info(text, msg, conn, remaining_size);
942 ENTITY_COMMAND_MAKE_CALL(
text::Text, text, text)
950 return this->send_message_smart_(select, SelectStateResponse::MESSAGE_TYPE, SelectStateResponse::ESTIMATED_SIZE);
956 resp.
state = select->current_option();
958 return fill_and_encode_entity_state(select, resp, conn, remaining_size);
964 msg.
options = &select->traits.get_options();
965 return fill_and_encode_entity_info(select, msg, conn, remaining_size);
978 return fill_and_encode_entity_info_with_device_class(button, msg, msg.
device_class, conn, remaining_size);
988 return this->send_message_smart_(a_lock, LockStateResponse::MESSAGE_TYPE, LockStateResponse::ESTIMATED_SIZE);
992 auto *a_lock =
static_cast<lock::Lock *
>(entity);
995 return fill_and_encode_entity_state(a_lock, resp, conn, remaining_size);
999 auto *a_lock =
static_cast<lock::Lock *
>(entity);
1004 return fill_and_encode_entity_info(a_lock, msg, conn, remaining_size);
1010 case enums::LOCK_UNLOCK:
1013 case enums::LOCK_LOCK:
1016 case enums::LOCK_OPEN:
1025 return this->send_message_smart_(valve, ValveStateResponse::MESSAGE_TYPE, ValveStateResponse::ESTIMATED_SIZE);
1032 return fill_and_encode_entity_state(valve, resp, conn, remaining_size);
1037 auto traits = valve->get_traits();
1041 return fill_and_encode_entity_info_with_device_class(valve, msg, msg.
device_class, conn, remaining_size);
1048 call.set_command_stop();
1053#ifdef USE_MEDIA_PLAYER
1055 return this->send_message_smart_(media_player, MediaPlayerStateResponse::MESSAGE_TYPE,
1056 MediaPlayerStateResponse::ESTIMATED_SIZE);
1063 : media_player->state;
1065 resp.
volume = media_player->volume;
1066 resp.
muted = media_player->is_muted();
1067 return fill_and_encode_entity_state(media_player, resp, conn, remaining_size);
1072 auto traits = media_player->get_traits();
1075 for (
auto &supported_format : traits.get_supported_formats()) {
1078 media_format.format =
StringRef(supported_format.format);
1079 media_format.sample_rate = supported_format.sample_rate;
1080 media_format.num_channels = supported_format.num_channels;
1082 media_format.sample_bytes = supported_format.sample_bytes;
1084 return fill_and_encode_entity_info(media_player, msg, conn, remaining_size);
1092 call.set_volume(msg.
volume);
1105void APIConnection::try_send_camera_image_() {
1106 if (!this->image_reader_)
1110 while (this->image_reader_->available()) {
1111 if (!this->helper_->can_write_without_blocking())
1114 uint32_t to_send = std::min((
size_t) MAX_BATCH_PACKET_SIZE, this->image_reader_->available());
1115 bool done = this->image_reader_->available() == to_send;
1119 msg.
set_data(this->image_reader_->peek_data_buffer(), to_send);
1125 if (!this->send_message(msg)) {
1128 this->image_reader_->consume_data(to_send);
1130 this->image_reader_->return_image();
1135void APIConnection::set_camera_state(std::shared_ptr<camera::CameraImage> image) {
1136 if (!this->flags_.state_subscription)
1138 if (!this->image_reader_)
1140 if (this->image_reader_->available())
1143 this->image_reader_->set_image(std::move(image));
1145 this->try_send_camera_image_();
1151 return fill_and_encode_entity_info(camera, msg, conn, remaining_size);
1162 App.
scheduler.set_timeout(this->parent_,
"api_camera_stop_stream", CAMERA_STOP_STREAM,
1168#ifdef USE_HOMEASSISTANT_TIME
1172#if defined(USE_HOMEASSISTANT_TIMEZONE) && defined(USE_TIME_TIMEZONE)
1178 if (pt.std_offset_seconds != 0 || pt.dst_start.type != enums::DST_RULE_TYPE_NONE) {
1183 tz.
dst_start.
day =
static_cast<uint16_t
>(pt.dst_start.day);
1186 tz.
dst_start.
week =
static_cast<uint8_t
>(pt.dst_start.week);
1189 tz.
dst_end.
day =
static_cast<uint16_t
>(pt.dst_end.day);
1191 tz.
dst_end.
month =
static_cast<uint8_t
>(pt.dst_end.month);
1192 tz.
dst_end.
week =
static_cast<uint8_t
>(pt.dst_end.week);
1204#ifdef USE_BLUETOOTH_PROXY
1205void APIConnection::on_subscribe_bluetooth_le_advertisements_request(
1209void APIConnection::on_unsubscribe_bluetooth_le_advertisements_request() {
1235bool APIConnection::send_subscribe_bluetooth_connections_free_response_() {
1239void APIConnection::on_subscribe_bluetooth_connections_free_request() {
1240 if (!this->send_subscribe_bluetooth_connections_free_response_()) {
1241 this->on_fatal_error();
1247 msg.
mode == enums::BluetoothScannerMode::BLUETOOTH_SCANNER_MODE_ACTIVE);
1254#ifdef USE_VOICE_ASSISTANT
1255bool APIConnection::check_voice_assistant_api_connection_()
const {
1266 if (!this->check_voice_assistant_api_connection_()) {
1274 if (msg.
port == 0) {
1280 this->helper_->getpeername((
struct sockaddr *) &storage, &
len);
1285 if (this->check_voice_assistant_api_connection_()) {
1290 if (this->check_voice_assistant_api_connection_()) {
1295 if (this->check_voice_assistant_api_connection_()) {
1301 if (this->check_voice_assistant_api_connection_()) {
1308 if (!this->check_voice_assistant_api_connection_()) {
1310 const std::vector<std::string> empty_wake_words;
1312 return this->send_message(resp);
1316 for (
auto &wake_word : config.available_wake_words) {
1319 resp_wake_word.id =
StringRef(wake_word.id);
1320 resp_wake_word.wake_word =
StringRef(wake_word.wake_word);
1321 for (
const auto &lang : wake_word.trained_languages) {
1322 resp_wake_word.trained_languages.push_back(lang);
1328 if (wake_word.model_type !=
"micro") {
1335 resp_wake_word.id =
StringRef(wake_word.id);
1336 resp_wake_word.wake_word =
StringRef(wake_word.wake_word);
1337 for (
const auto &lang : wake_word.trained_languages) {
1338 resp_wake_word.trained_languages.push_back(lang);
1344 return this->send_message(resp);
1347 if (!this->send_voice_assistant_get_configuration_response_(msg)) {
1348 this->on_fatal_error();
1353 if (this->check_voice_assistant_api_connection_()) {
1359#ifdef USE_ZWAVE_PROXY
1369#ifdef USE_ALARM_CONTROL_PANEL
1371 return this->send_message_smart_(a_alarm_control_panel, AlarmControlPanelStateResponse::MESSAGE_TYPE,
1372 AlarmControlPanelStateResponse::ESTIMATED_SIZE);
1379 return fill_and_encode_entity_state(a_alarm_control_panel, resp, conn, remaining_size);
1386 msg.
requires_code = a_alarm_control_panel->get_requires_code();
1388 return fill_and_encode_entity_info(a_alarm_control_panel, msg, conn, remaining_size);
1393 case enums::ALARM_CONTROL_PANEL_DISARM:
1396 case enums::ALARM_CONTROL_PANEL_ARM_AWAY:
1399 case enums::ALARM_CONTROL_PANEL_ARM_HOME:
1402 case enums::ALARM_CONTROL_PANEL_ARM_NIGHT:
1405 case enums::ALARM_CONTROL_PANEL_ARM_VACATION:
1406 call.arm_vacation();
1408 case enums::ALARM_CONTROL_PANEL_ARM_CUSTOM_BYPASS:
1409 call.arm_custom_bypass();
1411 case enums::ALARM_CONTROL_PANEL_TRIGGER:
1420#ifdef USE_WATER_HEATER
1422 return this->send_message_smart_(water_heater, WaterHeaterStateResponse::MESSAGE_TYPE,
1423 WaterHeaterStateResponse::ESTIMATED_SIZE);
1433 resp.
state = wh->get_state();
1435 return fill_and_encode_entity_state(wh, resp, conn, remaining_size);
1440 auto traits = wh->get_traits();
1446 return fill_and_encode_entity_info(wh, msg, conn, remaining_size);
1451 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_MODE)
1453 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE)
1455 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE_LOW)
1457 if (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_TARGET_TEMPERATURE_HIGH)
1459 if ((msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_AWAY_STATE) ||
1460 (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_STATE)) {
1463 if ((msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_ON_STATE) ||
1464 (msg.
has_fields & enums::WATER_HEATER_COMMAND_HAS_STATE)) {
1475 this->send_message_smart_(event, EventResponse::MESSAGE_TYPE, EventResponse::ESTIMATED_SIZE,
1482 return fill_and_encode_entity_state(event, resp, conn, remaining_size);
1489 return fill_and_encode_entity_info_with_device_class(event, msg, msg.
device_class, conn, remaining_size);
1493#if defined(USE_IR_RF) || defined(USE_RADIO_FREQUENCY)
1499 if (infrared !=
nullptr) {
1500 auto call = infrared->make_call();
1508#ifdef USE_RADIO_FREQUENCY
1510 if (radio_frequency !=
nullptr) {
1511 auto call = radio_frequency->make_call();
1522#if defined(USE_IR_RF) || defined(USE_RADIO_FREQUENCY)
1526#ifdef USE_SERIAL_PROXY
1529 if (msg.
instance >= proxies.size()) {
1530 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range (max %" PRIu32
")", msg.
instance,
1531 static_cast<uint32_t>(proxies.size()));
1540 if (msg.
instance >= proxies.size()) {
1541 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1549 if (msg.
instance >= proxies.size()) {
1550 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1558 if (msg.
instance >= proxies.size()) {
1559 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1564 resp.line_states = proxies[msg.
instance]->get_modem_pins();
1565 this->send_message(resp);
1570 if (msg.
instance >= proxies.size()) {
1571 ESP_LOGW(TAG,
"Serial proxy instance %" PRIu32
" out of range", msg.
instance);
1575 case enums::SERIAL_PROXY_REQUEST_TYPE_SUBSCRIBE:
1576 case enums::SERIAL_PROXY_REQUEST_TYPE_UNSUBSCRIBE:
1577 proxies[msg.
instance]->serial_proxy_request(
this, msg.
type);
1579 case enums::SERIAL_PROXY_REQUEST_TYPE_FLUSH: {
1582 resp.type = enums::SERIAL_PROXY_REQUEST_TYPE_FLUSH;
1583 switch (proxies[msg.
instance]->flush_port()) {
1585 resp.status = enums::SERIAL_PROXY_STATUS_OK;
1588 resp.status = enums::SERIAL_PROXY_STATUS_ASSUMED_SUCCESS;
1591 resp.status = enums::SERIAL_PROXY_STATUS_TIMEOUT;
1594 resp.status = enums::SERIAL_PROXY_STATUS_ERROR;
1597 this->send_message(resp);
1601 ESP_LOGW(TAG,
"Unknown serial proxy request type: %" PRIu32,
static_cast<uint32_t>(msg.
type));
1615 return fill_and_encode_entity_info(infrared, msg, conn, remaining_size);
1619#ifdef USE_RADIO_FREQUENCY
1625 msg.
frequency_min = rf->get_traits().get_frequency_min_hz();
1626 msg.
frequency_max = rf->get_traits().get_frequency_max_hz();
1628 return fill_and_encode_entity_info(rf, msg, conn, remaining_size);
1634 return this->send_message_smart_(update, UpdateStateResponse::MESSAGE_TYPE, UpdateStateResponse::ESTIMATED_SIZE);
1640 if (update->has_state()) {
1642 if (update->update_info.has_progress) {
1644 resp.
progress = update->update_info.progress;
1652 return fill_and_encode_entity_state(update, resp, conn, remaining_size);
1657 return fill_and_encode_entity_info_with_device_class(update, msg, msg.
device_class, conn, remaining_size);
1663 case enums::UPDATE_COMMAND_UPDATE:
1666 case enums::UPDATE_COMMAND_CHECK:
1669 case enums::UPDATE_COMMAND_NONE:
1670 ESP_LOGE(TAG,
"UPDATE_COMMAND_NONE not handled; confirm command is correct");
1673 ESP_LOGW(TAG,
"Unknown update command: %" PRIu32, msg.
command);
1679bool APIConnection::try_send_log_message(
int level,
const char *
tag,
const char *
line,
size_t message_len) {
1682 msg.
set_message(
reinterpret_cast<const uint8_t *
>(
line), message_len);
1683 return this->send_message(msg);
1686void APIConnection::complete_authentication_() {
1688 if (this->flags_.connection_state ==
static_cast<uint8_t
>(ConnectionState::AUTHENTICATED)) {
1692 this->flags_.connection_state =
static_cast<uint8_t
>(ConnectionState::AUTHENTICATED);
1695 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"connected"));
1696#ifdef USE_API_CLIENT_CONNECTED_TRIGGER
1698 char peername[socket::SOCKADDR_STR_LEN];
1699 this->parent_->get_client_connected_trigger()->trigger(std::string(this->helper_->get_client_name()),
1700 std::string(this->helper_->get_peername_to(peername)));
1703#ifdef USE_HOMEASSISTANT_TIME
1705 this->send_time_request();
1708#ifdef USE_ZWAVE_PROXY
1720 char peername[socket::SOCKADDR_STR_LEN];
1721 ESP_LOGV(TAG,
"Hello from client: '%s' | %s | API Version %" PRIu16
".%" PRIu16, this->helper_->get_client_name(),
1722 this->helper_->get_peername_to(peername), this->client_api_version_major_, this->client_api_version_minor_);
1725 if (!this->client_supports_api_version(1, 14)) {
1726 ESP_LOGW(TAG,
"'%s' using outdated API %" PRIu16
".%" PRIu16
", update to 1.14+", this->helper_->get_client_name(),
1727 this->client_api_version_major_, this->client_api_version_minor_);
1738 this->complete_authentication_();
1740 return this->send_message(resp);
1743bool APIConnection::send_ping_response_() {
1745 return this->send_message(resp);
1748bool APIConnection::send_device_info_response_() {
1756 char mac_address[18];
1770#if defined(USE_ESP8266) || defined(USE_ESP32)
1771#define ESPHOME_MANUFACTURER "Espressif"
1772#elif defined(USE_RP2040)
1773#define ESPHOME_MANUFACTURER "Raspberry Pi"
1774#elif defined(USE_BK72XX)
1775#define ESPHOME_MANUFACTURER "Beken"
1776#elif defined(USE_LN882X)
1777#define ESPHOME_MANUFACTURER "Lightning"
1778#elif defined(USE_NRF52)
1779#define ESPHOME_MANUFACTURER "Nordic Semiconductor"
1780#elif defined(USE_RTL87XX)
1781#define ESPHOME_MANUFACTURER "Realtek"
1782#elif defined(USE_HOST)
1783#define ESPHOME_MANUFACTURER "Host"
1788 static const char MANUFACTURER_PROGMEM[]
PROGMEM = ESPHOME_MANUFACTURER;
1789 char manufacturer_buf[
sizeof(MANUFACTURER_PROGMEM)];
1790 memcpy_P(manufacturer_buf, MANUFACTURER_PROGMEM,
sizeof(MANUFACTURER_PROGMEM));
1796 static_assert(
sizeof(ESPHOME_MANUFACTURER) - 1 <= 20,
"Update max_data_length for manufacturer in api.proto");
1797#undef ESPHOME_MANUFACTURER
1800 static const char MODEL_PROGMEM[]
PROGMEM = ESPHOME_BOARD;
1801 char model_buf[
sizeof(MODEL_PROGMEM)];
1802 memcpy_P(model_buf, MODEL_PROGMEM,
sizeof(MODEL_PROGMEM));
1808#ifdef USE_DEEP_SLEEP
1811#ifdef ESPHOME_PROJECT_NAME
1813 static const char PROJECT_NAME_PROGMEM[]
PROGMEM = ESPHOME_PROJECT_NAME;
1814 static const char PROJECT_VERSION_PROGMEM[]
PROGMEM = ESPHOME_PROJECT_VERSION;
1815 char project_name_buf[
sizeof(PROJECT_NAME_PROGMEM)];
1816 char project_version_buf[
sizeof(PROJECT_VERSION_PROGMEM)];
1817 memcpy_P(project_name_buf, PROJECT_NAME_PROGMEM,
sizeof(PROJECT_NAME_PROGMEM));
1818 memcpy_P(project_version_buf, PROJECT_VERSION_PROGMEM,
sizeof(PROJECT_VERSION_PROGMEM));
1831#ifdef USE_BLUETOOTH_PROXY
1834 char bluetooth_mac[18];
1838#ifdef USE_VOICE_ASSISTANT
1841#ifdef USE_ZWAVE_PROXY
1845#ifdef USE_SERIAL_PROXY
1846 size_t serial_proxy_index = 0;
1848 if (serial_proxy_index >= SERIAL_PROXY_COUNT)
1851 info.name =
StringRef(proxy->get_name());
1852 info.port_type = proxy->get_port_type();
1859 size_t device_index = 0;
1861 if (device_index >= ESPHOME_DEVICE_COUNT)
1863 auto &device_info = resp.
devices[device_index++];
1864 device_info.device_id = device->get_device_id();
1865 device_info.name =
StringRef(device->get_name());
1866 device_info.area_id = device->get_area_id();
1870 size_t area_index = 0;
1872 if (area_index >= ESPHOME_AREA_COUNT)
1874 auto &area_info = resp.
areas[area_index++];
1875 area_info.area_id = area->get_area_id();
1876 area_info.name =
StringRef(area->get_name());
1880 return this->send_message(resp);
1883 if (!this->send_hello_response_(msg)) {
1884 this->on_fatal_error();
1887void APIConnection::on_disconnect_request() {
1888 if (!this->send_disconnect_response_()) {
1889 this->on_fatal_error();
1892void APIConnection::on_ping_request() {
1893 if (!this->send_ping_response_()) {
1894 this->on_fatal_error();
1897void APIConnection::on_device_info_request() {
1898 if (!this->send_device_info_response_()) {
1899 this->on_fatal_error();
1903#ifdef USE_API_HOMEASSISTANT_STATES
1919 for (
auto &it : this->parent_->get_state_subs()) {
1930 it.callback(msg.
state);
1934#ifdef USE_API_USER_DEFINED_ACTIONS
1942 if (!arg.string_.empty()) {
1943 const_cast<char *
>(arg.string_.c_str())[arg.string_.size()] =
'\0';
1947#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES
1952 action_call_id = this->parent_->register_active_action_call(msg.
call_id,
this);
1955 for (
auto *service : this->parent_->get_user_services()) {
1956 if (service->execute_service(msg, action_call_id)) {
1961 for (
auto *service : this->parent_->get_user_services()) {
1962 if (service->execute_service(msg)) {
1968 ESP_LOGV(TAG,
"Could not find service");
1974#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES
1975void APIConnection::send_execute_service_response(
uint32_t call_id,
bool success,
StringRef error_message) {
1980 this->send_message(resp);
1982#ifdef USE_API_USER_DEFINED_ACTION_RESPONSES_JSON
1983void APIConnection::send_execute_service_response(
uint32_t call_id,
bool success,
StringRef error_message,
1984 const uint8_t *response_data,
size_t response_data_len) {
1991 this->send_message(resp);
1997#ifdef USE_API_HOMEASSISTANT_ACTION_RESPONSES
1999#ifdef USE_API_HOMEASSISTANT_ACTION_RESPONSES_JSON
2017 if (this->parent_->clear_noise_psk(
true)) {
2020 ESP_LOGW(TAG,
"Failed to clear encryption key");
2023 ESP_LOGW(TAG,
"Invalid encryption key length");
2024 }
else if (!this->parent_->save_noise_psk(psk,
true)) {
2025 ESP_LOGW(TAG,
"Failed to save encryption key");
2030 return this->send_message(resp);
2033 if (!this->send_noise_encryption_set_key_response_(msg)) {
2034 this->on_fatal_error();
2038#ifdef USE_API_HOMEASSISTANT_STATES
2039void APIConnection::on_subscribe_home_assistant_states_request() { state_subs_at_ = 0; }
2041bool APIConnection::try_to_clear_buffer_slow_(
bool log_out_of_space) {
2043 APIError err = this->helper_->loop();
2044 if (err != APIError::OK) {
2045 this->fatal_error_with_log_(LOG_STR(
"Socket operation failed"), err);
2048 if (this->helper_->can_write_without_blocking())
2050 if (log_out_of_space) {
2051 ESP_LOGV(TAG,
"Cannot send message because of TCP buffer space");
2057#ifdef HAS_PROTO_MESSAGE_DUMP
2059 if (message_type != SubscribeLogsResponse::MESSAGE_TYPE
2061 && message_type != CameraImageResponse::MESSAGE_TYPE
2064 auto *proto_msg =
static_cast<const ProtoMessage *
>(msg);
2066 this->log_send_message_(proto_msg->message_name(), proto_msg->dump_to(dump_buf));
2069 auto &shared_buf = this->parent_->get_shared_buffer_ref();
2070 this->prepare_first_message_buffer(shared_buf,
payload_size);
2071 size_t write_start = shared_buf.size();
2074 encode_fn(msg, buffer PROTO_ENCODE_DEBUG_INIT(&shared_buf));
2082 return encode_to_buffer(calculated_size, encode_fn, msg, conn, remaining_size);
2085 const bool is_log_message = (message_type == SubscribeLogsResponse::MESSAGE_TYPE);
2087 if (!this->try_to_clear_buffer(!is_log_message)) {
2092 this->helper_->set_nodelay_for_message(is_log_message);
2094 APIError err = this->helper_->write_protobuf_packet(message_type, buffer);
2095 if (err == APIError::WOULD_BLOCK)
2097 if (err != APIError::OK) {
2098 this->fatal_error_with_log_(LOG_STR(
"Packet write failed"), err);
2104void APIConnection::on_no_setup_connection() {
2105 this->on_fatal_error();
2106 this->log_client_(ESPHOME_LOG_LEVEL_DEBUG, LOG_STR(
"no connection setup"));
2108void APIConnection::on_fatal_error() {
2111 this->flags_.remove =
true;
2114bool APIConnection::schedule_message_front_(
EntityBase *entity, uint8_t message_type, uint8_t estimated_size) {
2115 this->deferred_batch_.add_item_front(entity, message_type, estimated_size);
2116 return this->schedule_batch_();
2119bool APIConnection::send_message_smart_(
EntityBase *entity, uint8_t message_type, uint8_t estimated_size,
2120 uint8_t aux_data_index) {
2121 if (this->should_send_immediately_(message_type) && this->helper_->can_write_without_blocking()) {
2122 auto &shared_buf = this->parent_->get_shared_buffer_ref();
2123 this->prepare_first_message_buffer(shared_buf, estimated_size);
2125 if (this->dispatch_message_(item, MAX_BATCH_PACKET_SIZE,
true) &&
2127#ifdef HAS_PROTO_MESSAGE_DUMP
2128 this->log_batch_item_(item);
2133 return this->schedule_message_(entity, message_type, estimated_size, aux_data_index);
2136bool APIConnection::schedule_batch_() {
2137 if (!this->flags_.batch_scheduled) {
2138 this->flags_.batch_scheduled =
true;
2144void APIConnection::process_batch_() {
2145 if (this->deferred_batch_.empty()) {
2146 this->flags_.batch_scheduled =
false;
2155 this->helper_->set_nodelay_for_message(
false);
2158 if (!this->try_to_clear_buffer(
true)) {
2164 auto &shared_buf = this->parent_->get_shared_buffer_ref();
2165 size_t num_items = this->deferred_batch_.size();
2168 const uint8_t header_padding = this->helper_->frame_header_padding();
2169 const uint8_t footer_size = this->helper_->frame_footer_size();
2172 uint32_t total_estimated_size = num_items * (header_padding + footer_size);
2173 for (
size_t i = 0; i < num_items; i++) {
2174 total_estimated_size += this->deferred_batch_[i].estimated_size;
2177 if (total_estimated_size > MAX_BATCH_PACKET_SIZE) {
2178 total_estimated_size = MAX_BATCH_PACKET_SIZE;
2181 this->prepare_first_message_buffer(shared_buf, header_padding, total_estimated_size);
2184 if (num_items == 1) {
2185 const auto &item = this->deferred_batch_[0];
2187 uint16_t
payload_size = this->dispatch_message_(item, std::numeric_limits<uint16_t>::max(),
true);
2190#ifdef HAS_PROTO_MESSAGE_DUMP
2192 this->log_batch_item_(item);
2194 this->clear_batch_();
2197 ESP_LOGW(TAG,
"Message too large to send: type=%u", item.message_type);
2198 this->clear_batch_();
2204 this->process_batch_multi_(shared_buf, num_items, header_padding, footer_size);
2209void APIConnection::process_batch_multi_(
APIBuffer &shared_buf,
size_t num_items, uint8_t header_padding,
2210 uint8_t footer_size) {
2212 static_assert(std::is_trivially_destructible<MessageInfo>::value,
2213 "MessageInfo must remain trivially destructible with this placement-new approach");
2215 const size_t messages_to_process = std::min(num_items, MAX_MESSAGES_PER_BATCH);
2220 size_t items_processed = 0;
2221 uint16_t remaining_size = std::numeric_limits<uint16_t>::max();
2228 for (
size_t i = 0; i < messages_to_process; i++) {
2229 const auto &item = this->deferred_batch_[i];
2232 uint16_t
payload_size = this->dispatch_message_(item, remaining_size, i == 0);
2241 uint16_t proto_payload_size =
payload_size - this->batch_header_size_ - footer_size;
2246 new (&message_info[items_processed++])
2247 MessageInfo(item.message_type, current_offset, proto_payload_size, this->batch_header_size_);
2249 if (items_processed == 1) {
2250 remaining_size = MAX_BATCH_PACKET_SIZE;
2255 current_offset = shared_buf.
size() + footer_size;
2258 if (items_processed > 0) {
2260 if (footer_size > 0) {
2261 shared_buf.
resize(shared_buf.
size() + footer_size);
2266 std::span<const MessageInfo>(message_info, items_processed));
2267 if (err != APIError::OK && err != APIError::WOULD_BLOCK) {
2268 this->fatal_error_with_log_(LOG_STR(
"Batch write failed"), err);
2271#ifdef HAS_PROTO_MESSAGE_DUMP
2274 for (
size_t i = 0; i < items_processed; i++) {
2275 const auto &item = this->deferred_batch_[i];
2276 this->log_batch_item_(item);
2281 if (items_processed < this->deferred_batch_.size()) {
2282 this->deferred_batch_.remove_front(items_processed);
2283 this->schedule_batch_();
2289 this->clear_batch_();
2296 this->flags_.batch_first_message = batch_first;
2300 if (item.
message_type == EventResponse::MESSAGE_TYPE) {
2306 this, remaining_size);
2314#define CASE_STATE_INFO(entity_name, StateResp, InfoResp) \
2315 case StateResp::MESSAGE_TYPE: \
2316 func = &try_send_##entity_name##_state; \
2318 case InfoResp::MESSAGE_TYPE: \
2319 func = &try_send_##entity_name##_info; \
2321#define CASE_INFO_ONLY(entity_name, InfoResp) \
2322 case InfoResp::MESSAGE_TYPE: \
2323 func = &try_send_##entity_name##_info; \
2327#ifdef USE_BINARY_SENSOR
2348#ifdef USE_TEXT_SENSOR
2357#ifdef USE_DATETIME_DATE
2360#ifdef USE_DATETIME_TIME
2363#ifdef USE_DATETIME_DATETIME
2378#ifdef USE_MEDIA_PLAYER
2381#ifdef USE_ALARM_CONTROL_PANEL
2384#ifdef USE_WATER_HEATER
2393#ifdef USE_RADIO_FREQUENCY
2403 case ListEntitiesDoneResponse::MESSAGE_TYPE:
2404 func = &try_send_list_info_done;
2406 case DisconnectRequest::MESSAGE_TYPE:
2407 func = &try_send_disconnect_request;
2409 case PingRequest::MESSAGE_TYPE:
2410 func = &try_send_ping_request;
2416#undef CASE_STATE_INFO
2417#undef CASE_INFO_ONLY
2419 return func(item.
entity,
this, remaining_size);
2424 return encode_message_to_buffer(resp, conn, remaining_size);
2429 return encode_message_to_buffer(req, conn, remaining_size);
2434 return encode_message_to_buffer(req, conn, remaining_size);
2437#ifdef USE_API_HOMEASSISTANT_STATES
2438void APIConnection::process_state_subscriptions_() {
2439 const auto &subs = this->parent_->get_state_subs();
2440 if (this->state_subs_at_ >=
static_cast<int>(subs.size())) {
2441 this->state_subs_at_ = -1;
2445 const auto &it = subs[this->state_subs_at_];
2452 resp.
once = it.once;
2453 if (this->send_message(resp)) {
2454 this->state_subs_at_++;
2459void APIConnection::log_client_(
int level,
const LogString *
message) {
2460 char peername[socket::SOCKADDR_STR_LEN];
2461 esp_log_printf_(level, TAG, __LINE__, ESPHOME_LOG_FORMAT(
"%s (%s): %s"), this->helper_->get_client_name(),
2462 this->helper_->get_peername_to(peername), LOG_STR_ARG(
message));
2466 char peername[socket::SOCKADDR_STR_LEN];
2467 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)
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())
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
ESPDEPRECATED("object_id mangles names and all object_id methods are planned for removal " "(see https://github.com/esphome/backlog/issues/76). " "Now is the time to stop using object_id. If still needed, use get_object_id_to() " "which will remain available longer. get_object_id() will be removed in 2026.7.0", "2025.12.0") std uint32_t get_object_id_hash() const
EntityCategory get_entity_category() const
StringRef get_object_id_to(std::span< char, OBJECT_ID_MAX_LEN > buf) const
Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffe...
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
bool client_supports_api_version(uint16_t major, uint16_t minor) const
uint32_t(*)(const void *) CalculateSizeFn
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
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
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
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
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< VoiceAssistantExternalWakeWord > external_wake_words
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 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 get_bluetooth_mac_address_pretty(std::span< char, 18 > output)
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)
void send_frame(const uint8_t *data, size_t length)
uint32_t get_feature_flags() const
void api_connection_authenticated(api::APIConnection *conn)
const LogString * message
const LogString * api_error_to_logstr(APIError err)
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.
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