Make entities and devices independent in the scene editor by dmulcahey · Pull Request #11046 · home-assistant/frontend

dmulcahey · 2021-12-29T15:04:18Z

Breaking change

Proposed change

The scene editor currently only works with devices. You can pick an entity but if it has an associated device the device is what is added to the scene. This "works" but falls down with devices such as multi-gang smart switches where the individual states for each gang should not be forced to be used together in a scene. It is very common for 1 gang to control the lighting for 1 room / area and another gang to control the lighting in another room / area.

This change adds a key entity_only to the stored configuration in scenes.yaml so that it can be used by the editor as a hint when saving and loading the scene. This allows individual entities to be used in scenes regardless of whether or not they are associated to a device.

I have done some light testing and this appears to work. It needs a typing issue corrected but I wanted to open this to get some feedback on the change before trying to finish it.

If this change is welcome it may also be worth discussing making the entity picker always available. I get the intention to make this as easy to use as possible but IMO it isn't intuitive to have this picker hidden behind advanced mode.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (thank you!)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example configuration

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue or discussion: Adding single entities from a device with multiple entities appears to add all of the entities of the device to a scene in the scene editor. #6468, ZHA Zigbee groups are incorrect assigned to controller device core#37582
Link to documentation pull request:

Checklist

The code change is tested and works locally.
There is no commented out code in this PR.
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

frenck · 2021-12-29T15:05:54Z

The scene editor currently only works with devices.

No?

dmulcahey · 2021-12-29T15:18:02Z

The scene editor currently only works with devices.

No?

🤔 is the rest of what I wrote after the opening sentence unclear? I can try to explain it differently but I’m unsure of how to start with just No?

frenck · 2021-12-29T15:28:01Z

is the rest of what I wrote after the opening sentence unclear?

It wasn't unclear, I just don't recognize this myself.

But I think I've now learned what is happening. Apparently, most of my scenes use devices with a single entity. Wonder why I never ran into this myself before :S

dmulcahey · 2021-12-29T15:42:30Z

Another question: should entities (either individual or entities belonging to devices) that have entity_category set to config / diagnostic / system be excluded from the editor / scenes?

frenck · 2021-12-29T15:57:00Z

That is a very good question, which I don't have the answer to myself, to be honest. Both cases sound interesting. As in, scenes can be used to restore the state of a device (e.g., a specific camera configuration when you are away for example, or child locks enabled when kids are home... those things).

I think the most common use cases won't be needing the non-primary entities; but ruling them out sounds kinda odd as well 🤷

dmulcahey · 2021-12-29T16:08:10Z

As in, scenes can be used to restore the state of a device (e.g., a specific camera configuration when you are away for example, or child locks enabled when kids are home... those things).

Good point. I think leaving them as is makes sense if we can solve the issue this RFC attempts to solve. Then the user can explicitly include or exclude them depending on what they want to achieve.

emontnemery · 2022-01-04T14:31:41Z

@dmulcahey, @frenck let's leave out entities with entity_category set when a device is picked, that should maybe be done in a separate PR though.

Ragingfire105 · 2022-02-19T02:56:40Z

When I ran into this issue on my Shelly 2.5 this is the simple interface that came to mind as a solution.

To implement this today you would have to go into scenes.yaml and delete the entities you wish to exclude.
So, the expected behavior would be, on save of the scene unchecked entities would not be written to file. On load of the scene in the editor as each entity is read in it would check if the device has already been loaded. If so, enable that entity else, add the device and enable only the loading entity.
If implemented how outlined, I would expect this would no longer be considered a breaking change. Loading of scenes that both have and have not been modified to exclude entities would load and save as expected.

SuPeRMiNoR2 · 2022-03-14T15:53:23Z

Something like this would be super helpful for me. The main devices I have trouble with are WLED devices and my Inovelli Fan + Light Switches.
It is pretty annoying having to manually edit the scenes just so that the scenes don't control my fan AND my light.

emontnemery · 2022-04-21T13:04:24Z

src/data/scene.ts

-  [entityId: string]: string | { state: string; [key: string]: any };
+  [entityId: string]:
+    | string
+    | { state: string; [key: string]: any; entity_only?: boolean | undefined };


Should we tuck the entity_only flag away in a metadata object?

Do we even need entity_only? If we allow this, we would just make it so that picking an entity in the entity list doesn't automatically upgrade to the device.

So you pick a device for devices, you pick an entity for entities.

The problem is that the scene config does not have a concept of devices which are included, frontend derives the included devices by looking up device ids for entities included in the scene.

It means we need some way for frontend to keep track of which devices should be included by storing additional data in the scene config. The entity_only is an opt-out flag; it would maybe be more logical to make it an opt-in flag instead?

If it's for the frontend only, we generally use metadata.

Fixed, the frontend settings are now moved to a seperata metadata item in the scene

balloob · 2022-04-21T21:55:21Z

I am not sure if we currently already do this, but selecting a device for a scene should only include entities that have no entity categories.

emontnemery · 2022-04-25T13:06:00Z

I am not sure if we currently already do this, but selecting a device for a scene should only include entities that have no entity categories.

We don't do that, and we should fix that too, in a separate PR

balloob · 2022-05-20T04:23:16Z

Erik has updated the backend to allow metadata to be stored. Use that to store if an entity was added without a device.

balloob · 2022-05-20T04:50:26Z

src/panels/config/scene/ha-scene-editor.ts

+        entityMetaData
+          ? !entityMetaData.entity_only
+          : false


It took me a while staring at this code to figure out what it does. This seems to simplify it a bit.

Suggested change

entityMetaData

? !entityMetaData.entity_only

: false

entityMetaData &&

!entityMetaData.entity_only

To not change the behavior in a surprising way, the logic should be reversed so we assume entities in scenes without metadata are added as devices.

balloob · 2022-05-20T04:51:04Z

src/panels/config/scene/ha-scene-editor.ts

+      const entityMetaData = config.metadata?.[entityReg.entity_id];
+      if (
+        !this._devices.includes(entityReg.device_id) &&
+        !(typeof entity === "string") &&


Why check this?

Suggested change

!(typeof entity === "string") &&

typeof entity !== "string" &&

This was added when the entity_only flag was set in the entities map and is indeed no longer needed 👍

src/panels/config/scene/ha-scene-editor.ts

src/translations/en.json

Co-authored-by: Zack Barett <zackbarett@hey.com>

homeassistant added the cla-signed label Dec 29, 2021

kongo09 mentioned this pull request Mar 4, 2022

Cannot define light scene for light entities as HA insists on setting devices home-assistant/core#67647

Closed

emontnemery force-pushed the dm/scene-editor-changes branch from dbbc0e8 to bd3a546 Compare April 21, 2022 12:40

emontnemery reviewed Apr 21, 2022

View reviewed changes

dmulcahey and others added 3 commits May 19, 2022 17:08

make entities independent of devices

1e38e54

flip condition

f18de1c

Fix typing

cf15bf7

emontnemery force-pushed the dm/scene-editor-changes branch from 3f022e7 to cf15bf7 Compare May 19, 2022 15:09

Move entity_only setting to metadata

d269c9a

emontnemery mentioned this pull request May 19, 2022

Allow frontend to store metadata in homeassistant scenes home-assistant/core#72178

Merged

22 tasks

emontnemery marked this pull request as ready for review May 19, 2022 16:03

balloob reviewed May 20, 2022

View reviewed changes

src/panels/config/scene/ha-scene-editor.ts Outdated Show resolved Hide resolved

balloob changed the title ~~RFC: Make entities and devices independent in the scene editor~~ Make entities and devices independent in the scene editor May 20, 2022

emontnemery added 3 commits May 23, 2022 11:08

Remove useless typechecking

76d3451

Reverse logic when scene doesn't have metadata

253327b

Update translations

cbe1ee6

zsarnett reviewed May 23, 2022

View reviewed changes

src/translations/en.json Outdated Show resolved Hide resolved

zsarnett previously approved these changes May 23, 2022

View reviewed changes

zsarnett requested a review from balloob May 23, 2022 22:02

balloob dismissed zsarnett’s stale review via 5739aa2 May 23, 2022 22:40

balloob and others added 2 commits May 23, 2022 15:40

Update src/translations/en.json

5739aa2

Co-authored-by: Zack Barett <zackbarett@hey.com>

Simplify a bit

debb3d5

balloob approved these changes May 23, 2022

View reviewed changes

balloob enabled auto-merge (squash) May 23, 2022 22:59

balloob merged commit b71b230 into home-assistant:dev May 23, 2022

github-actions bot locked and limited conversation to collaborators May 25, 2022

	!(typeof entity === "string") &&
	typeof entity !== "string" &&

Conversation

dmulcahey commented Dec 29, 2021

Breaking change

Proposed change

Type of change

Example configuration

Additional information

Checklist

Uh oh!

frenck commented Dec 29, 2021

Uh oh!

dmulcahey commented Dec 29, 2021

Uh oh!

frenck commented Dec 29, 2021

Uh oh!

dmulcahey commented Dec 29, 2021

Uh oh!

frenck commented Dec 29, 2021

Uh oh!

dmulcahey commented Dec 29, 2021

Uh oh!

emontnemery commented Jan 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ragingfire105 commented Feb 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SuPeRMiNoR2 commented Mar 14, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

balloob commented Apr 21, 2022

Uh oh!

emontnemery commented Apr 25, 2022

Uh oh!

balloob commented May 20, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

emontnemery commented Jan 4, 2022 •

edited

Loading

Ragingfire105 commented Feb 19, 2022 •

edited

Loading