Call a service: Split remaining service_data's into data and target

[silamon]

Proposed change

It's been a while you can use data and target to call a service as a replacelement for service_data. This migrates the remaining parts to use data and target. Take a good look if you can, since I'm still unsure if this doesn't introduce breaking changes.

It also introduces changes in the picture elements card so the service call button supports that as well. That will need a documentation change to be done.

type: picture-elements
elements:
  - type: service-button
    title: 81% (old)
    style:
      top: 55%
      left: 30%
    service: light.turn_on
    service_data:
      entity_id: light.bed_light
      brightness_pct: 81
  - type: service-button
    title: 81% (new)
    style:
      top: 65%
      left: 30%
    service: light.turn_on
    data:
      brightness_pct: 81
    target:
      entity_id: light.bed_light
  - type: service-button
    title: off (old)
    style:
      top: 55%
      left: 60%
    service: light.turn_off
    service_data:
      entity_id: light.bed_light
  - type: service-button
    title: off (new)
    style:
      top: 65%
      left: 60%
    service: light.turn_off
    target:
      entity_id: light.bed_light
image: https://demo.home-assistant.io/stub_config/floorplan.png

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 "tap_action" needs differently defined "entity_id" #13827
• This PR is related to issue or discussion:
• 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

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced a new target property for specifying service call targets, enhancing service invocation precision.
  • Added a data property for improved service data handling, replacing the previous serviceData.

• Bug Fixes

  • Improved fallback mechanisms for target and data configurations in the service button, enhancing usability in various scenarios.

• Documentation

  • Updated interface ServiceButtonElementConfig to include new optional properties, promoting clearer service handling in configurations.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance the HaCallServiceButton component and related files by refining how service calls are structured. A new target property replaces the previous serviceData, improving clarity and consistency in data handling. These modifications streamline service invocation while maintaining backward compatibility and align with updated configurations for better usability across the Home Assistant UI, particularly in handling service call parameters.

Changes

Files	Change Summary
src/components/buttons/ha-call-service-button.ts	Updated HaCallServiceButton to use new target property and replace serviceData with data.
src/panels/config/integrations/integration-panels/zha/zha-cluster-attributes.ts	Changed property binding from .serviceData to .data.
src/panels/config/integrations/integration-panels/zha/zha-cluster-commands.ts	Modified property binding from .serviceData to .data.
src/panels/config/integrations/integration-panels/zha/zha-device-card.ts	Removed import statement for ha-call-service-button.
src/panels/lovelace/elements/hui-service-button-element.ts	Enhanced handling of service data by introducing fallback logic for target and data.
src/panels/lovelace/elements/types.ts	Added optional target and data properties to ServiceButtonElementConfig.

Assessment against linked issues

Objective	Addressed	Explanation
Use a single method for specifying service call parameters (e.g., data, target) (#13827)	✅
Clarify configuration documentation for service calls (#13827)	❓	Documentation updates are not included in the PR.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[silamon]

Documentation has been added through home-assistant/home-assistant.io#34047. Thanks!