Amcrest integration: update tap action keywords

[c0ffeeca7]

Proposed change

Amcrest: update tap action keywords in example

• to reflect current software keywords
• as described in https://www.home-assistant.io/dashboards/actions/#tap-action

Type of change

• Spelling, grammar or other readability improvements (current branch).
• Adjusted missing or incorrect information in the current documentation (current branch).
• Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • I've opened up a PR to add logos and icons in Brands repository.
• Added documentation for a new feature I'm adding to Home Assistant (next branch).
• Removed stale or deprecated documentation.

Additional information

• Link to parent pull request in the codebase:
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue: fixes #

Checklist

• This PR uses the correct branch, based on one of the following:
  • I made a change to the existing documentation and used the current branch.
  • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
• The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

• Documentation
  • Updated the Amcrest integration instructions to standardize camera control commands.
  • Streamlined the guidance for using directional and zoom functions, ensuring a more consistent and intuitive experience.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	1c90c75
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/67ab1d4545babf0008164d0b
😎 Deploy Preview	https://deploy-preview-37417--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

📝 Walkthrough

Walkthrough

The modifications update the action handling for PTZ controls in the Amcrest integration documentation. The changes convert the previous call-service action syntax to a new perform-action syntax for all PTZ operations, including directional movements and zoom control. This update standardizes the invocation method across the Home Assistant interface, while the underlying service name (amcrest.ptz_control) remains unchanged.

Changes

File	Description
source/_integrations/amcrest.markdown	Updated PTZ control actions by replacing call-service with perform-action for movement and zoom controls.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant UI as Home Assistant UI
    participant PTZ as amcrest.ptz_control Service

    U->>UI: Taps on a PTZ control button
    UI->>UI: Processes tap_action (using perform-action)
    UI->>PTZ: Sends PTZ control command (e.g., up, down, left, right)
    PTZ-->>UI: Returns acknowledgment of action

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3f4e9f4 and 1c90c75.

📒 Files selected for processing (1)

• source/_integrations/amcrest.markdown (9 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Redirect rules - home-assistant-docs
• GitHub Check: Header rules - home-assistant-docs
• GitHub Check: Pages changed - home-assistant-docs

🔇 Additional comments (1)

source/_integrations/amcrest.markdown (1)

294-300: LGTM! The tap action syntax has been updated correctly.

The changes consistently update the PTZ control actions to use the new perform-action syntax, which aligns with the current Home Assistant documentation standards for tap actions.

Let's verify that this is the current recommended syntax:

Also applies to: 306-312, 318-324, 330-336, 342-348, 354-360, 366-372, 378-384, 390-402

✅ Verification successful

🌐 Web query:

What is the current tap action syntax in Home Assistant for performing actions?

💡 Result:

In Home Assistant, tap actions are configured through YAML syntax using either direct service calls or custom scripts for multiple actions. Here's the current implementation:

Standard Single Action Syntax

For basic single-service triggers:

tap_action:
  action: call-service
  service: light.toggle
  target:
    entity_id: light.kitchen

This uses native button-card capabilities[5].

Multiple Actions Using Scripts

To execute multiple actions from one tap, create a script with parallel execution:

Script Configuration ([1][4]):

alias: Multi Tap Action
sequence:
  - repeat:
      for_each: "{{ actions }}"
      sequence:
        - service: "{{ repeat.item.service }}"
          data: "{{ repeat.item.data }}"
          target: "{{ repeat.item.target }}"
mode: parallel

Button Implementation ([1][5]):

type: button
tap_action:
  action: call-service
  service: script.multi_tap_action
  service_data:
    actions:
      - service: light.turn_on
        data:
          brightness_pct: 75
        target:
          entity_id: light.living_room
      - service: notify.mobile_app_phone
        data:
          message: Lights adjusted

Key parameters:

• service: Required service name (e.g., light.turn_on)
• data: Service-specific parameters[3]
• target: Entity/device targeting[5]
• mode: parallel enables simultaneous execution[4]

Advanced Features

1. Conditional Actions ([4]):

- if:
    - condition: template
      value_template: "{{ states('sensor.motion') == 'on' }}"
  then:
    - service: light.turn_on
      target:
        entity_id: light.hallway

2. Action Sequences ([4]):

repeat:
  count: 3
  sequence:
    - service: light.turn_off
      target:
        entity_id: light.bedroom
    - delay: 00:00:05

For navigation combined with actions, Browser Mod integration is required to handle URL routing within scripts[1]. Recent updates require using explicit service_data fields instead of generic data parameters when calling scripts[1].

This implementation allows complex interaction sequences while maintaining Home Assistant's security model through controlled service calls[3][5]. Always test configurations in Development Tools' Services tab before full deployment[3].

Citations:

• 1: https://community.home-assistant.io/t/poc-multiple-actions-on-tap-action/601728
• 2: https://github.com/elchininet/home-assistant-secret-taps
• 3: https://www.home-assistant.io/docs/scripts/perform-actions/
• 4: https://www.home-assistant.io/docs/scripts/
• 5: https://www.home-assistant.io/dashboards/actions/
• 6: https://community.home-assistant.io/t/mobile-app-notifications-open-specific-dashboard-tab-view-as-default-click-action/515188
• 7: https://community.home-assistant.io/t/creating-tap-actions-where-none-exist/735504
• 8: https://community.home-assistant.io/t/lovelace-do-one-regular-action-and-navigate-action-in-same-card/140219
• 9: https://community.home-assistant.io/t/button-card-different-entities-for-tap-and-hold-actions/573257
• 10: https://companion.home-assistant.io/docs/notifications/actionable-notifications/

---

LGTM: Amcrest integration tap action syntax update verified

The updated documentation consistently switches to the new perform-action syntax (with the added perform_action field) as intended. Although standard Home Assistant examples still show tap actions with call-service, this change appears to be an integration-specific update aligning with updated keywords in the software.

• The update is applied consistently across all PTZ control examples.
• The new syntax—action: perform-action with perform_action: amcrest.ptz_control—matches the PR objectives to update this integration.

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

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.