sascha/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-10-31 07:03:55 +00:00
Code Issues Releases Wiki Activity

Register device_id to entity and separate struct for all device info

Browse Source
This commit is contained in:
Daniel Vikström
2025-04-09 00:11:05 +02:00
parent 3b5fbc359f
commit 68ecc08111
12 changed files with 65 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
esphome/components/api/api.proto
View File

@@ -185,6 +185,12 @@ message DeviceInfoRequest {
// Empty // Empty
} }
message SubDeviceInfo {
string id = 1;
string name = 2;
string suggested_area = 3;
}
message DeviceInfoResponse { message DeviceInfoResponse {
option (id) = 10; option (id) = 10;
option (source) = SOURCE_SERVER; option (source) = SOURCE_SERVER;
@@ -230,6 +236,8 @@ message DeviceInfoResponse {
// The Bluetooth mac address of the device. For example "AC:BC:32:89:0E:AA" // The Bluetooth mac address of the device. For example "AC:BC:32:89:0E:AA"
string bluetooth_mac_address = 18; string bluetooth_mac_address = 18;
repeated SubDeviceInfo sub_devices = 19;
} }
message ListEntitiesRequest { message ListEntitiesRequest {
@@ -273,7 +281,7 @@ message ListEntitiesBinarySensorResponse {
bool disabled_by_default = 7; bool disabled_by_default = 7;
string icon = 8; string icon = 8;
EntityCategory entity_category = 9; EntityCategory entity_category = 9;
string device_name = 10; string device_id = 10;
} }
message BinarySensorStateResponse { message BinarySensorStateResponse {
option (id) = 21; option (id) = 21;
@@ -307,7 +315,7 @@ message ListEntitiesCoverResponse {
string icon = 10; string icon = 10;
EntityCategory entity_category = 11; EntityCategory entity_category = 11;
bool supports_stop = 12; bool supports_stop = 12;
string device_name = 13; string device_id = 13;
} }
enum LegacyCoverState { enum LegacyCoverState {

4
esphome/components/api/api_connection.cpp
View File

@@ -280,7 +280,7 @@ bool APIConnection::try_send_binary_sensor_info(APIConnection *api, void *v_bina
msg.disabled_by_default = binary_sensor->is_disabled_by_default(); msg.disabled_by_default = binary_sensor->is_disabled_by_default();
msg.icon = binary_sensor->get_icon(); msg.icon = binary_sensor->get_icon();
msg.entity_category = static_cast<enums::EntityCategory>(binary_sensor->get_entity_category()); msg.entity_category = static_cast<enums::EntityCategory>(binary_sensor->get_entity_category());
msg.device_name = binary_sensor->get_device_name(); msg.device_id = binary_sensor->get_device_id();
return api->send_list_entities_binary_sensor_response(msg); return api->send_list_entities_binary_sensor_response(msg);
} }
#endif #endif
@@ -331,7 +331,7 @@ bool APIConnection::try_send_cover_info(APIConnection *api, void *v_cover) {
msg.disabled_by_default = cover->is_disabled_by_default(); msg.disabled_by_default = cover->is_disabled_by_default();
msg.icon = cover->get_icon(); msg.icon = cover->get_icon();
msg.entity_category = static_cast<enums::EntityCategory>(cover->get_entity_category()); msg.entity_category = static_cast<enums::EntityCategory>(cover->get_entity_category());
msg.device_name = cover->get_device_name(); msg.device_id = cover->get_device_id();
return api->send_list_entities_cover_response(msg); return api->send_list_entities_cover_response(msg);
} }
void APIConnection::cover_command(const CoverCommandRequest &msg) { void APIConnection::cover_command(const CoverCommandRequest &msg) {

16
esphome/components/api/api_pb2.cpp
View File

@@ -1002,7 +1002,7 @@ bool ListEntitiesBinarySensorResponse::decode_length(uint32_t field_id, ProtoLen
return true; return true;
} }
case 10: { case 10: {
this->device_name = value.as_string(); this->device_id = value.as_string();
return true; return true;
} }
default: default:
@@ -1029,7 +1029,7 @@ void ListEntitiesBinarySensorResponse::encode(ProtoWriteBuffer buffer) const {
buffer.encode_bool(7, this->disabled_by_default); buffer.encode_bool(7, this->disabled_by_default);
buffer.encode_string(8, this->icon); buffer.encode_string(8, this->icon);
buffer.encode_enum<enums::EntityCategory>(9, this->entity_category); buffer.encode_enum<enums::EntityCategory>(9, this->entity_category);
buffer.encode_string(10, this->device_name); buffer.encode_string(10, this->device_id);
} }
#ifdef HAS_PROTO_MESSAGE_DUMP #ifdef HAS_PROTO_MESSAGE_DUMP
void ListEntitiesBinarySensorResponse::dump_to(std::string &out) const { void ListEntitiesBinarySensorResponse::dump_to(std::string &out) const {
@@ -1072,8 +1072,8 @@ void ListEntitiesBinarySensorResponse::dump_to(std::string &out) const {
out.append(proto_enum_to_string<enums::EntityCategory>(this->entity_category)); out.append(proto_enum_to_string<enums::EntityCategory>(this->entity_category));
out.append("\n"); out.append("\n");
out.append(" device_name: "); out.append(" device_id: ");
out.append("'").append(this->device_name).append("'"); out.append("'").append(this->device_id).append("'");
out.append("\n"); out.append("\n");
out.append("}"); out.append("}");
} }
@@ -1179,7 +1179,7 @@ bool ListEntitiesCoverResponse::decode_length(uint32_t field_id, ProtoLengthDeli
return true; return true;
} }
case 13: { case 13: {
this->device_name = value.as_string(); this->device_id = value.as_string();
return true; return true;
} }
default: default:
@@ -1209,7 +1209,7 @@ void ListEntitiesCoverResponse::encode(ProtoWriteBuffer buffer) const {
buffer.encode_string(10, this->icon); buffer.encode_string(10, this->icon);
buffer.encode_enum<enums::EntityCategory>(11, this->entity_category); buffer.encode_enum<enums::EntityCategory>(11, this->entity_category);
buffer.encode_bool(12, this->supports_stop); buffer.encode_bool(12, this->supports_stop);
buffer.encode_string(13, this->device_name); buffer.encode_string(13, this->device_id);
} }
#ifdef HAS_PROTO_MESSAGE_DUMP #ifdef HAS_PROTO_MESSAGE_DUMP
void ListEntitiesCoverResponse::dump_to(std::string &out) const { void ListEntitiesCoverResponse::dump_to(std::string &out) const {
@@ -1264,8 +1264,8 @@ void ListEntitiesCoverResponse::dump_to(std::string &out) const {
out.append(YESNO(this->supports_stop)); out.append(YESNO(this->supports_stop));
out.append("\n"); out.append("\n");
out.append(" device_name: "); out.append(" device_id: ");
out.append("'").append(this->device_name).append("'"); out.append("'").append(this->device_id).append("'");
out.append("\n"); out.append("\n");
out.append("}"); out.append("}");
} }

4
esphome/components/api/api_pb2.h
View File

@@ -402,7 +402,7 @@ class ListEntitiesBinarySensorResponse : public ProtoMessage {
bool disabled_by_default{false}; bool disabled_by_default{false};
std::string icon{}; std::string icon{};
enums::EntityCategory entity_category{}; enums::EntityCategory entity_category{};
std::string device_name{}; std::string device_id{};
void encode(ProtoWriteBuffer buffer) const override; void encode(ProtoWriteBuffer buffer) const override;
#ifdef HAS_PROTO_MESSAGE_DUMP #ifdef HAS_PROTO_MESSAGE_DUMP
void dump_to(std::string &out) const override; void dump_to(std::string &out) const override;
@@ -441,7 +441,7 @@ class ListEntitiesCoverResponse : public ProtoMessage {
std::string icon{}; std::string icon{};
enums::EntityCategory entity_category{}; enums::EntityCategory entity_category{};
bool supports_stop{false}; bool supports_stop{false};
std::string device_name{}; std::string device_id{};
void encode(ProtoWriteBuffer buffer) const override; void encode(ProtoWriteBuffer buffer) const override;
#ifdef HAS_PROTO_MESSAGE_DUMP #ifdef HAS_PROTO_MESSAGE_DUMP
void dump_to(std::string &out) const override; void dump_to(std::string &out) const override;

9
esphome/components/device/__init__.py → esphome/components/devices/__init__.py
View File

@@ -1,9 +1,8 @@
from esphome import config_validation as cv from esphome import codegen as cg, config_validation as cv
from esphome import codegen as cg
from esphome.const import CONF_ID, CONF_NAME from esphome.const import CONF_ID, CONF_NAME
# ns = cg.esphome_ns.namespace("device") # ns = cg.esphome_ns.namespace("devices")
# DeviceClass = ns.Class("Device") # DeviceClass = ns.Class("SubDevice")
StringRef = cg.esphome_ns.struct("StringRef") StringRef = cg.esphome_ns.struct("StringRef")
MULTI_CONF = True MULTI_CONF = True
@@ -24,4 +23,4 @@ async def to_code(config):
config[CONF_ID], config[CONF_ID],
config[CONF_NAME], config[CONF_NAME],
) )
# cg.add_define("USE_DEVICE_ID") cg.add_define("USE_SUB_DEVICE")

8
esphome/components/device/device.h → esphome/components/devices/devices.h
View File

@@ -1,16 +1,18 @@
#pragma once #pragma once
namespace esphome { namespace esphome {
namespace device { namespace devices {
class Device { class SubDevice {
public: public:
void set_name(std::string name) { name_ = name; } void set_name(std::string name) { name_ = name; }
std::string get_name(void) { return name_; } std::string get_name(void) { return name_; }
protected: protected:
// std::string id_ = "";
std::string name_ = ""; std::string name_ = "";
std::string suggested_area_ = "";
}; };
} // namespace device } // namespace devices
} // namespace esphome } // namespace esphome

20
esphome/core/application.h
View File

@@ -9,6 +9,9 @@
#include "esphome/core/preferences.h" #include "esphome/core/preferences.h"
#include "esphome/core/scheduler.h" #include "esphome/core/scheduler.h"
#ifdef USE_SUB_DEVICE
#include "esphome/components/devices/devices.h"
#endif
#ifdef USE_BINARY_SENSOR #ifdef USE_BINARY_SENSOR
#include "esphome/components/binary_sensor/binary_sensor.h" #include "esphome/components/binary_sensor/binary_sensor.h"
#endif #endif
@@ -97,6 +100,10 @@ class Application {
this->compilation_time_ = compilation_time; this->compilation_time_ = compilation_time;
} }
#ifdef USE_SUB_DEVICE
void register_sub_device(devices::SubDevice *sub_device) { this->sub_devices_.push_back(sub_device); }
#endif
#ifdef USE_BINARY_SENSOR #ifdef USE_BINARY_SENSOR
void register_binary_sensor(binary_sensor::BinarySensor *binary_sensor) { void register_binary_sensor(binary_sensor::BinarySensor *binary_sensor) {
this->binary_sensors_.push_back(binary_sensor); this->binary_sensors_.push_back(binary_sensor);
@@ -243,6 +250,16 @@ class Application {
uint32_t get_app_state() const { return this->app_state_; } uint32_t get_app_state() const { return this->app_state_; }
#ifdef USE_SUB_DEVICE
const std::vector<devices::SubDevice *> &get_sub_devices() { return this->sub_devices_; }
// devices::SubDevice *get_sub_device_by_key(uint32_t key, bool include_internal = false) {
// for (auto *obj : this->sub_devices_) {
// if (obj->get_object_id_hash() == key && (include_internal || !obj->is_internal()))
// return obj;
// }
// return nullptr;
// }
#endif
#ifdef USE_BINARY_SENSOR #ifdef USE_BINARY_SENSOR
const std::vector<binary_sensor::BinarySensor *> &get_binary_sensors() { return this->binary_sensors_; } const std::vector<binary_sensor::BinarySensor *> &get_binary_sensors() { return this->binary_sensors_; }
binary_sensor::BinarySensor *get_binary_sensor_by_key(uint32_t key, bool include_internal = false) { binary_sensor::BinarySensor *get_binary_sensor_by_key(uint32_t key, bool include_internal = false) {
@@ -473,6 +490,9 @@ class Application {
std::vector<Component *> components_{}; std::vector<Component *> components_{};
std::vector<Component *> looping_components_{}; std::vector<Component *> looping_components_{};
#ifdef USE_SUB_DEVICE
std::vector<devices::SubDevice *> sub_devices_{};
#endif
#ifdef USE_BINARY_SENSOR #ifdef USE_BINARY_SENSOR
std::vector<binary_sensor::BinarySensor *> binary_sensors_{}; std::vector<binary_sensor::BinarySensor *> binary_sensors_{};
#endif #endif

1
esphome/core/defines.h
View File

@@ -99,6 +99,7 @@
#define USE_SELECT #define USE_SELECT
#define USE_SENSOR #define USE_SENSOR
#define USE_STATUS_LED #define USE_STATUS_LED
#define USE_SUB_DEVICE
#define USE_SWITCH #define USE_SWITCH
#define USE_TEXT #define USE_TEXT
#define USE_TEXT_SENSOR #define USE_TEXT_SENSOR

8
esphome/core/entity_base.cpp
View File

@@ -36,13 +36,13 @@ std::string EntityBase::get_icon() const {
void EntityBase::set_icon(const char *icon) { this->icon_c_str_ = icon; } void EntityBase::set_icon(const char *icon) { this->icon_c_str_ = icon; }
// Entity Device Name // Entity Device Name
StringRef EntityBase::get_device_name() const { StringRef EntityBase::get_device_id() const {
if (this->device_name_.empty()) { if (this->device_id_.empty()) {
return StringRef(""); return StringRef("");
} }
return this->device_name_; return this->device_id_;
} }
void EntityBase::set_device_name(const StringRef *device_name) { this->device_name_ = *device_name; } void EntityBase::set_device_id(const StringRef *device_id) { this->device_id_ = *device_id; }
// Entity Category // Entity Category
EntityCategory EntityBase::get_entity_category() const { return this->entity_category_; } EntityCategory EntityBase::get_entity_category() const { return this->entity_category_; }

6
esphome/core/entity_base.h
View File

@@ -48,8 +48,8 @@ class EntityBase {
void set_icon(const char *icon); void set_icon(const char *icon);
// Get/set this entity's device name // Get/set this entity's device name
StringRef get_device_name() const; StringRef get_device_id() const;
void set_device_name(const StringRef *device_name); void set_device_id(const StringRef *device_id);
protected: protected:
/// The hash_base() function has been deprecated. It is kept in this /// The hash_base() function has been deprecated. It is kept in this
@@ -65,7 +65,7 @@ class EntityBase {
bool internal_{false}; bool internal_{false};
bool disabled_by_default_{false}; bool disabled_by_default_{false};
EntityCategory entity_category_{ENTITY_CATEGORY_NONE}; EntityCategory entity_category_{ENTITY_CATEGORY_NONE};
StringRef device_name_; StringRef device_id_;
}; };
class EntityBase_DeviceClass { // NOLINT(readability-identifier-naming) class EntityBase_DeviceClass { // NOLINT(readability-identifier-naming)

6
esphome/cpp_helpers.py
View File

@@ -89,6 +89,10 @@ async def register_component(var, config):
return var return var
# async def register_sub_device(var, value):
# pass
async def register_parented(var, value): async def register_parented(var, value):
if isinstance(value, ID): if isinstance(value, ID):
paren = await get_variable(value) paren = await get_variable(value)
@@ -113,7 +117,7 @@ async def setup_entity(var, config):
add(var.set_entity_category(config[CONF_ENTITY_CATEGORY])) add(var.set_entity_category(config[CONF_ENTITY_CATEGORY]))
if CONF_DEVICE_ID in config: if CONF_DEVICE_ID in config:
parent = await get_variable(config[CONF_DEVICE_ID]) parent = await get_variable(config[CONF_DEVICE_ID])
add(var.set_device_name(parent)) add(var.set_device_id(parent))
def extract_registry_entry_config( def extract_registry_entry_config(

2
tests/components/device/common.yaml
View File

@@ -1,4 +1,4 @@
device: devices:
- id: other_device - id: other_device
name: Another device name: Another device