cpp-esphome-api/entity_8hpp_source.html

#pragma once


#include <esphome/api/model/entity_type.hpp>

#include <esphome/api/model/enums.hpp>


#include <cstdint>

#include <string>


namespace esphome::api {


struct EntityInfo {

    std::uint32_t key = 0;

    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;

};


}  // namespace esphome::api

entity_type.hpp
Enumeration of ESPHome entity domains and name conversion helpers.

enums.hpp
Typed mirrors of the ESPHome protobuf enums.

esphome::api
Definition bytes.hpp:10

esphome::api::EntityCategory
EntityCategory
Mirror of proto enum EntityCategory.
Definition enums.hpp:20

esphome::api::EntityCategory::None
@ None

esphome::api::EntityInfo
Fields present on every ListEntities*Response.
Definition entity.hpp:16

esphome::api::EntityInfo::disabled_by_default
bool disabled_by_default
Definition entity.hpp:22

esphome::api::EntityInfo::object_id
std::string object_id
Definition entity.hpp:19

esphome::api::EntityInfo::key
std::uint32_t key
Stable per-entity identifier used to correlate state and command messages.
Definition entity.hpp:18

esphome::api::EntityInfo::icon
std::string icon
Definition entity.hpp:21

esphome::api::EntityInfo::entity_category
EntityCategory entity_category
Definition entity.hpp:23

esphome::api::EntityInfo::name
std::string name
Definition entity.hpp:20

esphome::api::EntityInfo::device_id
std::uint32_t device_id
Sub-device id (0 = the root device) when the device exposes sub-devices.
Definition entity.hpp:25