github/esphome
2
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-09-11 15:27:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Recommend the YAML internal key over set_internal()

Browse Source
This commit is contained in:
J. Nick Koston
2026-09-10 08:54:55 -05:00
parent 77d6570605
commit b0bd118991
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esphome/core/entity_base.h
+5 -4
View File
@@ -88,10 +88,11 @@ 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. 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.
// Set whether this Entity should be hidden outside ESPHome. Prefer the 'internal:' YAML key
// whenever possible: it is guaranteed and has none of the limitations below. Use this only when
// the decision can only be made at boot. 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.