github/esphome
2
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-10-06 19:06:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

[web_server] Switch entity id to the new format and drop name_id (#17586)

Browse Source
This commit is contained in:
J. Nick Koston
2026-07-16 08:49:43 -10:00
committed by GitHub
parent dcdd044234
commit 2218edf20c
1 changed files with 3 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esphome/components/web_server/web_server.cpp
+3 -16
View File
@@ -558,26 +558,19 @@ static void set_json_id(JsonObject &root, EntityBase *obj, const char *prefix, J
size_t device_len = device_name ? strlen(device_name) : 0;
#endif
// Single stack buffer for both id formats - ArduinoJson copies the string before we overwrite
// Stack buffer for the id - ArduinoJson copies the string before it goes out of scope
// Buffer sizes use constants from entity_base.h validated in core/config.py
// Note: Device name uses ESPHOME_FRIENDLY_NAME_MAX_LEN (sub-device max 120), not ESPHOME_DEVICE_NAME_MAX_LEN
// (hostname)
// Without USE_DEVICES: legacy id ({prefix}-{object_id}) is the largest format
// With USE_DEVICES: name_id ({prefix}/{device}/{name}) is the largest format
static constexpr size_t LEGACY_ID_SIZE = ESPHOME_DOMAIN_MAX_LEN + 1 + OBJECT_ID_MAX_LEN;
#ifdef USE_DEVICES
static constexpr size_t ID_BUF_SIZE =
std::max(ESPHOME_DOMAIN_MAX_LEN + 1 + ESPHOME_FRIENDLY_NAME_MAX_LEN + 1 + ESPHOME_FRIENDLY_NAME_MAX_LEN + 1,
LEGACY_ID_SIZE);
ESPHOME_DOMAIN_MAX_LEN + 1 + ESPHOME_FRIENDLY_NAME_MAX_LEN + 1 + ESPHOME_FRIENDLY_NAME_MAX_LEN + 1;
#else
static constexpr size_t ID_BUF_SIZE =
std::max(ESPHOME_DOMAIN_MAX_LEN + 1 + ESPHOME_FRIENDLY_NAME_MAX_LEN + 1, LEGACY_ID_SIZE);
static constexpr size_t ID_BUF_SIZE = ESPHOME_DOMAIN_MAX_LEN + 1 + ESPHOME_FRIENDLY_NAME_MAX_LEN + 1;
#endif
char id_buf[ID_BUF_SIZE];
memcpy(id_buf, prefix, prefix_len); // NOLINT(bugprone-not-null-terminated-result)
// name_id: new format {prefix}/{device?}/{name} - frontend should prefer this
// Remove in 2026.8.0 when id switches to new format permanently
char *p = id_buf + prefix_len;
*p++ = '/';
#ifdef USE_DEVICES
@@ -589,12 +582,6 @@ static void set_json_id(JsonObject &root, EntityBase *obj, const char *prefix, J
#endif
memcpy(p, name.c_str(), name_len);
p[name_len] = '\0';
root[ESPHOME_F("name_id")] = id_buf;
// id: old format {prefix}-{object_id} for backward compatibility
// Will switch to new format in 2026.8.0 - reuses prefix already in id_buf
id_buf[prefix_len] = '-';
obj->write_object_id_to(id_buf + prefix_len + 1, ID_BUF_SIZE - prefix_len - 1);
root[ESPHOME_F("id")] = id_buf;
if (start_config == DETAIL_ALL) {