Dev tools/Service calls with `target.label_id` set do not work when label is attached to specific entites

[kquinsland]

The problem

After the 2024.04 update, it is now possible to select labels as "targets" of service calls like so!

In the screenshot below, I've selected a label called regime/night and a specific entity.

The equivalent yaml:

service: button.press
target:
  label_id: regime_night
  entity_id: button.kitchen_switch_nighttime_mode
data: {}

The above works. The issue is when the specific entity is removed and only the label is used for targeting:

service: button.press
target:
  label_id: regime_night
data: {}

In this case, clicking the "call" button does nothing. But the entity button.kitchen_switch_nighttime_mode does have the regime_night label applied:

I believe this is an issue with backed and not front-end because in both cases, clicking the Call Service button yields this in my logs:

INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Running websocket_api script                                                                                 │
INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Executing step call service          

And the button briefly changes to a green checkmark to indicate no errors.

A workaround

It is possible to work around this issue by explicitly resolving the list of entities with the label and passing that list in via target.entity_id like so:

service: button.press
target:
  entity_id: "{{ label_entities('regime_night') }}"

But this has the downside of not being able to use the UI. Depending on the service being called, loosing the UI for quickly customizing all the possible arguments can be rather frustrating.

Additional Information:

Version 	core-2024.4.3
Installation Type 	Unknown
Development 	false
Supervisor 	false
Docker 	false
User 	root
Virtual Environment 	false
Python Version 	3.12.2
Operating System Family 	Linux
Operating System Version 	5.15.0-101-generic
CPU Architecture 	x86_64
Timezone 	America/Los_Angeles
Configuration Directory 	/config

What version of Home Assistant Core has the issue?

core-2024.4.3

What was the last working version of Home Assistant Core?

No response

What type of installation are you running?

Home Assistant Container

Integration causing the issue

No response

Link to integration documentation on our website

No response

Diagnostics information

No response

Example YAML snippet

No response

Anything in the logs that might be useful for us?

No response

Additional information

No response

[bdraco]

I set up the same label with a light and wasn't able to replicate the issue.

service: light.turn_on
target:
  label_id: regime_night
data: {}

Can you provide debug logs from the time you call the service?

Add the following to configuration.yaml, restart, call the service, than download the log in the settings

# Example configuration.yaml entry
logger:
  default: info
  logs:
    homeassistant.core: debug
    homeassistant.helpers.service: debug

[kquinsland]

I set up the same label with a light and wasn't able to replicate the issue.

Thanks for sanity checking me. It would have been less frustrating if you'd have been able to repro the issue, though :(.

I turned on debug logging for the components (that's for providing the IDs!) and the results don't shed a lot of light on the situation, unfortunately.

For context/background

The button.kitchen_switch_nighttime_mode entity belongs to an ESPHome powered device.
When the button is pressed, three four different light entities on the device should transition to a color/brightness that's baked into the firmware/ESPHome config. (three physical and one "virtual")

The relevant log snips:

While in the dev_too/services page, had web inspector up and looked at the web socket traffic.
When clicking the button, this is sent:

{"type":"execute_script","sequence":[{"service":"button.press","target":{"label_id":"regime_night"},"data":{}}],"id":40}

And reply:

{"id":40,"type":"result","success":true,"result":{"context":{"id":"01HVKZ6ZPH8SGGDDP86MNS28WB","parent_id":null,"user_id":"834c153d1f4640f6a66f8b2e69624190"},"response":null}}

And here's what I see in the logs:

INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Running websocket_api script                                                                                 │
INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Executing step call service                                                                                  │
DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event call_service[L]: domain=button, service=press, service_data=label_id=['regime_night']>      

There are no other log lines that relate to any entity that has the regime_night label applied to it.

But when I explicitly include the button.kitchen_switch_nighttime_mode entity, the logs look different:

{"type":"execute_script","sequence":[{"service":"button.press","target":{"label_id":"regime_night","entity_id":"button.kitchen_switch_nighttime_mode"},"data":{}}],"id":40}

Reply:

{"type":"event","event":{"c":{"button.kitchen_switch_nighttime_mode":{"+":{"s":"2024-04-16T17:34:33.087565+00:00","lc":1713288873.087601,"c":"01HVKZK13YPGA4V1XM8XP0ECWC"}}}},"id":3}

{"id":40,"type":"result","success":true,"result":{"context":{"id":"01HVKZK13YPGA4V1XM8XP0ECWC","parent_id":null,"user_id":"834c153d1f4640f6a66f8b2e69624190"},"response":null}}


{"type":"event","event":{"c":{"light.kitchen_switch_indicator_1":{"+":{"lu":1713288873.156718,"c":"01HVKZK164V7R0QJCGJZSPBSRG","a":{"brightness":28,"hs_color":[9.123,67.059],"rgb_color":[255,110,84],"xy_color":[0.589,0.329]}}}}},"id":3}

(and two more messages for `light.kitchen_switch_indicator_{2,3}` omitted)

And logs:

2024-04-16 17:36:39.081 INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Running websocket_api script                  
                                                              
2024-04-16 17:36:39.081 INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Executing step call service  

2024-04-16 17:36:39.081 DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event call_service[L]: domain=button, service=press, service_data=label_id=['regime_night'], entity_id=['button.kitchen_switch_nighttime_mode']>   

2024-04-16 17:36:39.083 DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event state_changed[L]: entity_id=button.kitchen_switch_nighttime_mode, old_state=<state button.kitchen_switch_nighttime_mode=2024-04-16T17:36:03.632106+00:00; icon=mdi:lightbulb-night, friendly_name=Kitchen Switch Nighttime Mode @ 2024-04-16T10:36:03.632180-07:00>, new_state=<state button.kitchen_switch_nighttime_mode=2024-04-16T17:36:39.083216+00:00; icon=mdi:lightbulb-night, friendly_name=Kitchen Switch Nighttime Mode @2024-04-16T10:36:39.083298-07:00>>

2024-04-16 17:36:39.226 DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event state_changed[L]: entity_id=light.kitchen_switch_indicator_1, old_state=<state light.kitchen_switch_indicator_1=on; supported_color_modes=['rgb'], color_mode=rgb, brightness=100, hs_color=(218.906, 50.196), rgb_color=(127, 172, 255), xy_color=(0.208, 0.217), friendly_name=Kitchen Switch Indicator 1, supported_features=40 @ 2024-04-16T10:15:49.055257-07:00>, new_state=<state light.kitchen_switch_indicator_1=on; supported_color_modes=['rgb'], color_mode=rgb, brightness=28, hs_color=(9.123, 67.059), rgb_color=(255, 110, 84), xy_color=(0.589, 0.329), friendly_name=Kitchen Switch Indicator 1, supported_features=40 @ 2024-04-16T10:15:49.055257-07:00>>              

2024-04-16 17:36:39.232 DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event state_changed[L]: entity_id=light.kitchen_switch_indicator_2, old_state=<state light.kitchen_switch_indicator_2=on; supported_color_modes=['rgb'], color_mode=rgb, brightness=100, hs_color=(218.906, 50.196), rgb_color=(127, 172, 255), xy_color=(0.208, 0.217), friendly_name=Kitchen Switch Indicator 2, supported_features=40 @ 2024-04-16T10:15:49.055928-07:00>, new_state=<state light.kitchen_switch_indicator_2=on; supported_color_modes=['rgb'], color_mode=rgb, brightness=28, hs_color=(9.123, 67.059), rgb_color=(255, 110, 84), xy_color=(0.589, 0.329), friendly_name=Kitchen Switch Indicator 2, supported_features=40 @ 2024-04-16T10:15:49.055928-07:00>> 

2024-04-16 17:36:39.239 DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event state_changed[L]: entity_id=light.kitchen_switch_indicator_3, old_state=<state light.kitchen_switch_indicator_3=on; supported_color_modes=['rgb'], color_mode=rgb, brightness=100, hs_color=(218.906, 50.196), rgb_color=(127, 172, 255), xy_color=(0.208, 0.217), friendly_name=Kitchen Switch Indicator 3, supported_features=40 @2024-04-16T10:15:49.056451-07:00>, new_state=<state light.kitchen_switch_indicator_3=on; supported_color_modes=['rgb'], color_mode=rgb, brightness=28, hs_color=(9.123, 67.059), rgb_color=(255, 110, 84), xy_color=(0.589, 0.329), friendly_name=Kitchen Switch Indicator 3, supported_features=40 @ 2024-04-16T10:15:49.056451-07:00>>        

And just for thoroughness, when I plug this into the template preview tool:

{{ labels() }}

{{ label_entities('regime_night') }}

The output is:

[... 'regime_day', 'regime_night', ...]

[... 'button.kitchen_switch_nighttime_mode']

[kquinsland]

Just after posting, I had an idea for something else to try.

I created a "helper": input_button.testhelperbutton and assigned it the same regime/night label to it.
With this service call:

service: input_button.press
data: {}
target:
  label_id: regime_night

I see the following in my logs:

2024-04-16 17:52:10.717 INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Running websocket_api script 
2024-04-16 17:52:10.717 INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Executing step call service        
2024-04-16 17:52:10.717 DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event call_service[L]: domain=input_button, service=press, service_data=label_id=['regime_night']>        
2024-04-16 17:52:10.718 DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event state_changed[L]: entity_id=input_button.testhelperbutton, old_state=<state input_button.testhelperbutton=unknown; editable=True, icon=mdi:account-question-outline, friendly_name=TestHelperButton @ 2024-04-16T10:47:30.421278-07:00>, new_state=<state input_button.testhelperbutton=2024-04-16T17:52:10.718325+00:00; editable=True, icon=mdi:account-question-outline, friendly_name=TestHelperButton @ 2024-04-16T10:52:10.718357-07:00>>     

So the "label only" strategy of targeting services works for input_button service, but not button domain services !?

[kquinsland]

And just to confirm that I'm not going crazy, I did the following:

1. Visit the device page for the device that owns button.kitchen_switch_nighttime_mode
2. Remove the regime/night label
3. Add a new regime/test label
4. confirm the creation of regime/test label
5. go back to dev tools and kick off another input_button.press call with target.label_id: regime_test

And I observed this:

2024-04-16 17:56:20.738 INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Running websocket_api script      
2024-04-16 17:56:20.738 INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Executing step call service             
2024-04-16 17:56:20.738 DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event call_service[L]: domain=button, service=press, service_data=label_id=['regime_test']>

There is no additional log line for the actual entity state changing :(.

Thinking that it might be related to the / -> _ character sub, I repeated the steps above except this time with a new label testNoPunctuation and got the same log output:

2024-04-16 18:00:41.460 INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Running websocket_api script                                                            
2024-04-16 18:00:41.461 INFO (MainThread) [homeassistant.helpers.script.websocket_api_script] websocket_api script: Executing step call service                                                                   
2024-04-16 18:00:41.461 DEBUG (MainThread) [homeassistant.core] Bus:Handling <Event call_service[L]: domain=button, service=press, service_data=label_id=['testnopunctuation']>   

So there clearly is an event firing off but either the event isn't being received or whatever receives the event isn't doing the label -:> entity lookup?

[kquinsland]

Still present on

Core 2024.5.0
Frontend 20240404.2

[issue-triage-workflows]

There hasn't been any activity on this issue recently. Due to the high number of incoming GitHub notifications, we have to clean some of the old issues, as many of them have already been resolved with the latest updates.
Please make sure to update to the latest Home Assistant version and check if that solves the issue. Let us know if that works for you by adding a comment 👍
This issue has now been marked as stale and will be closed if no further activity occurs. Thank you for your contributions.

[VNRARA]

I'm having similar issues but with the switch domain.

[kquinsland]

I'm having similar issues but with the switch domain.

@VNRARA Do a bit more digging / have some detailed logs / reproduction steps and re-open. This issue has been marked fixed, stale by the bot.