[2.0] Add Floors, Labels, and additional device properties #290

strawgate · 2024-04-26T23:44:20Z

Add floors support for devices
Add labels support for devices and entities
Add unit_of_measure for entities
Add class for devices (device_class, ex. timestamp) and entities (state_class)

Switch dynamic mode from strict to false to ignore extra fields present in the documents instead of failing to index

Bumps Python to 3.12 and minimum HA version to 2024.4.4

Ready to go on everything except updating doc_creator and doc_publisher tests as I want to wait until #272 merges before updating those tests

Resolves #249
Resolves #299

strawgate · 2024-04-27T01:21:41Z

Fixes #249

strawgate · 2024-05-01T00:50:37Z

consider also adding state_class

strawgate · 2024-05-01T03:29:53Z

#299

github-actions · 2024-05-03T21:32:17Z

Coverage Report

File	Stmts	Miss	Cover	Missing
__init__.py	0	0	100%
elasticsearch
__init__.py	112	19	83%	96, 99–101, 104, 110, 119, 137–138, 145–147, 153–154, 174–175, 181, 183, 269
config_flow.py	199	16	91%	163, 196, 326, 390–391, 402–404, 418–419, 423, 501, 576, 585, 619–620
const.py	34	0	100%
entity_details.py	59	0	100%
errors.py	28	3	89%	51, 60, 67
es_doc_creator.py	194	1	99%	353
es_doc_publisher.py	268	38	85%	142–143, 182, 185, 188, 193, 210–211, 229–232, 236, 251–252, 268–269, 273, 298, 302, 396, 416, 458, 472, 483, 486, 514–515, 517–518, 520–521, 525–527, 546, 548, 554
es_gateway.py	144	20	86%	94–95, 114, 133–135, 137, 139–140, 142–143, 146–148, 153–154, 158–160, 253
es_index_manager.py	149	18	87%	77, 82, 182–183, 255–256, 273–274, 279–280, 309–310, 315, 323–324, 337, 350–351
es_integration.py	35	8	77%	40, 45–46, 57–61
es_privilege_check.py	61	0	100%
es_serializer.py	10	1	90%	17
es_version.py	30	0	100%
logger.py	2	0	100%
system_info.py	25	1	96%	37
utils.py	4	0	100%
TOTAL	1354	125	90%

Tests	Skipped	Failures	Errors	Time
223	0 💤	0 ❌	0 🔥	14.992s ⏱️

strawgate · 2024-05-03T21:32:36Z

@legrego good to go!

legrego

Thanks for your patience, I know I've been slow with reviews lately. Code-review only, will test locally for the next iteration

custom_components/elasticsearch/es_index_manager.py

legrego · 2024-05-16T17:32:42Z

custom_components/elasticsearch/es_doc_creator.py

+            "unit_of_measurement": str(entity.unit_of_measurement),
+            "area.id": entity_area.id if entity_area else None,
+            "area.name": entity_area.name if entity_area else None,
+            "class": entity_capabilities.get("state_class"),


question Why did you choose class over state_class for the property name?

value is technically state.value so I was thinking that just class might make sense here, I think in the other PR i lift device_class to be device.class. Happy to just call it state_class though.

device_additions = { "class": entity.device_class or entity.original_device_class,

"class": entity_capabilities.get("state_class"),

I slightly prefer state_class. Leaving this as entity.class gives me the impression that this describes the class of the entity, as opposed to the entity's state.

are you okay with me merging this PR and making new open issues for this and moving the Area and I'll incorporate those into my next PR?

Yes that would be fine with me

custom_components/elasticsearch/es_doc_creator.py

custom_components/elasticsearch/entity_details.py

legrego · 2024-05-16T17:44:38Z

custom_components/elasticsearch/datastreams/index_template.json

@@ -147,6 +162,17 @@
                                                    "type": "keyword"
                                                }
                                            }
+                                        },
+                                        "floor": {


I'm torn about placing floor here, as it's technically an attribute of the area. I think it's easier to consume where you have it, but the pedant in me says it doesn't belong here.

Let's leave it the way you have it for now.

Are you sure? I'd be happy to move it under the Area

Let's move it under area for both entity.area and device.area, if you don't mind.

custom_components/elasticsearch/datastreams/index_template.json

strawgate · 2024-05-16T22:57:47Z

@legrego 3 open discussions but incorporated the rest of the feedback

legrego

LGTM, with naming nits for follow-up

legrego · 2024-05-20T12:38:02Z

custom_components/elasticsearch/entity_details.py

-            device = self._registry_device.async_get(entity.device_id)
-            if device.area_id:
-                device_area = self._registry_area.async_get_area(device.area_id)
+        entity_label = self.async_get_entity_labels(entity)


Suggested change

entity_label = self.async_get_entity_labels(entity)

entity_labels = self.async_get_entity_labels(entity)

legrego · 2024-05-20T12:38:11Z

custom_components/elasticsearch/entity_details.py

+        if device is None:
+            LOGGER.debug("Device not found for entity: %s", entity_id)
+
+        device_label = self.async_get_device_labels(device)


Suggested change

device_label = self.async_get_device_labels(device)

device_labels = self.async_get_device_labels(device)

legrego · 2024-05-20T12:38:20Z

custom_components/elasticsearch/entity_details.py

+            entity,
+            entity_area,
+            entity_floor,
+            entity_label,


Suggested change

entity_label,

entity_labels,

legrego · 2024-05-20T12:38:27Z

custom_components/elasticsearch/entity_details.py

+            device,
+            device_area,
+            device_floor,
+            device_label,


Suggested change

device_label,

device_labels,

legrego · 2024-05-20T12:52:34Z

custom_components/elasticsearch/es_doc_creator.py

+            "unit_of_measurement": str(entity.unit_of_measurement),
+            "area.id": entity_area.id if entity_area else None,
+            "area.name": entity_area.name if entity_area else None,
+            "class": entity_capabilities.get("state_class"),


Yes that would be fine with me

strawgate added 2 commits April 26, 2024 23:43

initial untested implementation

2864e13

Finish implementing and add simple tests

ffd6f03

strawgate changed the title ~~[Draft] Add Floors and Labels support~~ Add Floors and Labels support Apr 27, 2024

Minor entity handling fixes

66f9b44

strawgate changed the title ~~Add Floors and Labels support~~ Add Floors, Labels, and additional device properties May 1, 2024

Updates from testing

3a9efe6

This was referenced May 1, 2024

Strict dynamic mapping is going to cause issues #299

Closed

[2.0] Add attribute skipping for attributes that already exist in other forms #298

Merged

add friendly_name for device and entity

018a1cc

strawgate changed the title ~~Add Floors, Labels, and additional device properties~~ [2.0] Add Floors, Labels, and additional device properties May 2, 2024

Merge branch 'main' into add-floors

3ec0bf3

legrego added this to the Version 2.0 milestone May 3, 2024

strawgate and others added 3 commits May 3, 2024 15:03

Merge branch 'main' into add-floors

6e3d6d6

Adding/fixing tests after config merge

661fbf8

additional fixes

f7f4300

strawgate enabled auto-merge (squash) May 3, 2024 21:20

Bill Easton added 3 commits May 3, 2024 21:23

update dependencies

f56dbfc

Update python version of CI

17c9f2e

bump more python versions

ca678a6

Merge branch 'main' into add-floors

f0b70bc

legrego requested changes May 16, 2024

View reviewed changes

strawgate and others added 3 commits May 16, 2024 17:02

Merge branch 'main' into add-floors

636b746

Feedback from PR

0f86d29

Finishing updates from PR feedback

a3523e1

Also forward ES and Kibana ports

4be92de

legrego mentioned this pull request May 20, 2024

Update doc site for 2.0 release #317

Open

Merge branch 'main' into add-floors

68d7d60

legrego mentioned this pull request May 20, 2024

[2.0] Implement Elasticsearch v8 (Draft) #312

Closed

Merge branch 'main' into add-floors

f678538

legrego approved these changes May 20, 2024

View reviewed changes

strawgate merged commit da8c76a into legrego:main May 20, 2024
3 checks passed

This was referenced May 20, 2024

Clean-up follow-ups from Floors PR #321

Open

state.class vs state.value #325

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2.0] Add Floors, Labels, and additional device properties #290

[2.0] Add Floors, Labels, and additional device properties #290

strawgate commented Apr 26, 2024 •

edited by legrego

strawgate commented Apr 27, 2024

strawgate commented May 1, 2024

strawgate commented May 1, 2024

github-actions bot commented May 3, 2024 •

edited

strawgate commented May 3, 2024

legrego left a comment

legrego May 16, 2024

strawgate May 16, 2024 •

edited

legrego May 20, 2024

strawgate May 20, 2024

legrego May 20, 2024

legrego May 16, 2024

strawgate May 16, 2024

legrego May 20, 2024

strawgate commented May 16, 2024

legrego left a comment

legrego May 20, 2024

legrego May 20, 2024

legrego May 20, 2024

legrego May 20, 2024

legrego May 20, 2024

	entity_label = self.async_get_entity_labels(entity)
	entity_labels = self.async_get_entity_labels(entity)

	device_label = self.async_get_device_labels(device)
	device_labels = self.async_get_device_labels(device)

[2.0] Add Floors, Labels, and additional device properties #290

[2.0] Add Floors, Labels, and additional device properties #290

Conversation

strawgate commented Apr 26, 2024 • edited by legrego

strawgate commented Apr 27, 2024

strawgate commented May 1, 2024

strawgate commented May 1, 2024

github-actions bot commented May 3, 2024 • edited

strawgate commented May 3, 2024

legrego left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

strawgate May 16, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

strawgate commented May 16, 2024

legrego left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

strawgate commented Apr 26, 2024 •

edited by legrego

github-actions bot commented May 3, 2024 •

edited

strawgate May 16, 2024 •

edited