Example correction

[G1z]

Proposed change

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

• Refactor
  • Updated the Foscam camera controls for pan, tilt, and zoom. These changes streamline the operation of directional controls, ensuring a smoother and more consistent experience when managing camera adjustments.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	ef34740
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/67aa741625fee4000979e6b8
😎 Deploy Preview	https://deploy-preview-37406--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 pull request updates the configuration for Foscam camera PTZ controls. The previous implementation used a direct call-service action, whereas the new setup adopts a perform-action structure. This new format explicitly specifies the target entity via a target field and nests the relevant data under perform_action. The modifications have been applied consistently across various directional actions (e.g., up, down, left, right, and diagonals), with no changes to exported or public entities.

Changes

File(s)	Change Summary
source/_integrations/foscam.markdown	Updated PTZ control actions from using call-service to perform-action; added explicit target field and nested data under perform_action.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant UI as UI Component
    participant HA as Home Automation System
    participant FC as Foscam Camera

    U->>UI: Tap directional icon (e.g., 'up')
    UI->>HA: Send tap_action event with new structure
    HA->>HA: Parse event (perform-action, target, data)
    HA->>FC: Invoke foscam.ptz service with direction data
    FC-->>HA: Acknowledge action execution
    HA-->>UI: Return command status

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 9c54d5a and ef34740.

📒 Files selected for processing (1)

• source/_integrations/foscam.markdown (8 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 (8)

source/_integrations/foscam.markdown (8)

75-81: Updated PTZ Action Structure for the "Up" Icon.
The revised configuration now uses the perform-action approach with a clearly nested perform_action key and an explicit target specification. This improves clarity and consistency compared to the old call-service method.

---

88-94: Consistent Update for the "Down" Icon.
The changes correctly apply the new structure by replacing the previous direct service call with perform-action and a dedicated target field. This promotes better readability and unifies the configuration across the different directional controls.

---

101-107: Refined PTZ Control for the "Left" Icon.
The new configuration cleanly separates the action from the target and associated data. This update aligns with the overall transition to the perform-action methodology, ensuring a uniform approach throughout the documentation.

---

114-120: Streamlined Configuration for the "Right" Icon.
The updated YAML snippet now uses the perform-action key with an explicit target and nested parameters, making the intended action clearer and more consistent with the newer documentation standards.

---

127-133: Enhanced PTZ Setup for the "Top Left" Icon.
This update adopts the new structure—using perform-action alongside a clearly defined target—which improves the readability of the card configuration and aligns it with similar adjustments in other control actions.

---

141-147: Improved PTZ Action for the "Top Right" Icon.
The modifications ensure that the control now explicitly outlines the action type, target entity, and movement data. This not only enhances clarity but also promotes consistency across the integration documentation.

---

153-159: Strengthened Configuration for the "Bottom Left" Icon.
The refactored structure here mirrors the improvements seen in other directional actions. By using perform-action with a nested configuration for target and data, the documentation now more clearly communicates how camera controls are executed.

---

167-173: Unified PTZ Control for the "Bottom Right" Icon.
This final update in the set aligns with the new standard, ensuring that all directional controls are configured using a well-organized and explicit structure. The separation of the action, target, and data parameters enhances overall documentation clarity and consistency.

---

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.

[c0ffeeca7]

Thank you for the catch, @G1z 👍