esphome::api::EntityInfo Struct Reference

Fields present on every ListEntities*Response. More...

#include <entity.hpp>

Inheritance diagram for esphome::api::EntityInfo:

Collaboration diagram for esphome::api::EntityInfo:

Public Attributes
std::uint32_t	key = 0
	Stable per-entity identifier used to correlate state and command messages.
std::string	object_id
std::string	name
std::string	icon
bool	disabled_by_default = false
EntityCategory	entity_category = EntityCategory::None
std::uint32_t	device_id = 0
	Sub-device id (0 = the root device) when the device exposes sub-devices.

Detailed Description

Fields present on every ListEntities*Response.

Each domain's <X>Info struct derives from this and adds its own metadata.

Member Data Documentation

device_id

std::uint32_t esphome::api::EntityInfo::device_id = 0

Sub-device id (0 = the root device) when the device exposes sub-devices.

disabled_by_default

bool esphome::api::EntityInfo::disabled_by_default = false

entity_category

EntityCategory esphome::api::EntityInfo::entity_category = EntityCategory::None

icon

std::string esphome::api::EntityInfo::icon

key

std::uint32_t esphome::api::EntityInfo::key = 0

Stable per-entity identifier used to correlate state and command messages.

name

std::string esphome::api::EntityInfo::name

object_id

std::string esphome::api::EntityInfo::object_id

---

The documentation for this struct was generated from the following file:

• include/esphome/api/model/entity.hpp