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

Mark set_internal() as legacy support in the header comment

Browse Source
This commit is contained in:
J. Nick Koston
2026-09-10 08:51:42 -05:00
parent db1dfff925
commit 77d6570605
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esphome/core/entity_base.h
+4 -3
View File
@@ -88,9 +88,10 @@ class EntityBase {
// Get whether this Entity should be hidden outside ESPHome
bool is_internal() const { return this->flags_.internal; }
// Set whether this Entity should be hidden outside ESPHome. Must be called before MQTT and the
// API read the flag: from on_boot at the default priority, or a setup() that runs above
// setup_priority::AFTER_WIFI. Calls after setup finishes are ignored and log an error.
// Set whether this Entity should be hidden outside ESPHome. Kept for existing projects that
// decide the flag at boot; new designs should use the 'internal:' YAML key. Must be called before
// MQTT and the API read the flag: from on_boot at the default priority, or a setup() that runs
// above setup_priority::AFTER_WIFI. Calls after setup finishes are ignored and log an error.
//
// Known limitations, all by design and not going to be fixed:
// - No consumer is notified of a change, so the flag can only be decided once per boot.