Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

motionEye: update tap action keywords in example #37413

Merged
merged 1 commit into from
Feb 11, 2025
Merged

Conversation

c0ffeeca7
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 commented Feb 11, 2025

Proposed change

motionEye: update tap action keywords in example

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).
  • 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
    • Enhanced the camera control functionality in the Home Assistant motionEye integration, streamlining the commands that manage movements (left, right, up, down) for improved consistency and smoother operation.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Feb 11, 2025
Copy link

netlify bot commented Feb 11, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit ceb1641
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67aafa87ccd1060008dbe285
😎 Deploy Preview https://deploy-preview-37413--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Contributor

coderabbitai bot commented Feb 11, 2025

📝 Walkthrough

Walkthrough

This change revises the YAML configuration for the Home Assistant motionEye integration by updating the action calls used for camera control. The previous structure that used call-service with motioneye.action has been replaced with a new format that utilizes perform-action (and its variant perform_action). The parameters for the actions, such as entity_id, remain unchanged, while the action signature is updated to align with the new handling method.

Changes

File Path Change Summary
…/_integrations/motioneye.markdown Replaced call-service with perform-action for camera move actions. Updated action signature from action: motioneye.action to action: perform-action and to perform_action: motioneye.action in various locations.

Sequence Diagram(s)

sequenceDiagram
    participant HA as Home Assistant
    participant ME as motionEye Integration
    participant Cam as Camera Device

    HA->>ME: Initiate camera action (move left/right/up/down)
    Note over ME: Process using new perform-action structure
    ME->>Cam: Execute action (using perform-action / perform_action)
    Cam-->>ME: Return execution confirmation
    ME-->>HA: Relay action result
Loading

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
🪧 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
source/_integrations/motioneye.markdown (1)

304-306: Consider using a consistent action key format.

The configuration uses both action: perform-action and perform_action: motioneye.action, which seems redundant. Consider using either:

  1. Just action: call-service with service: motioneye.action, or
  2. Just action: motioneye.action

This would make the configuration more concise and easier to understand.

-          action: perform-action
-          perform_action: motioneye.action
+          action: call-service
+          service: motioneye.action
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 73148cb and ceb1641.

📒 Files selected for processing (1)
  • source/_integrations/motioneye.markdown (1 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/motioneye.markdown (1)

312-314: Apply consistent action format across all tap actions.

The same action format inconsistency appears in all tap action configurations. Apply the same solution suggested above to all instances to maintain consistency throughout the example.

Also applies to: 320-322, 328-330

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @c0ffeeca7 👍

../Frenck

@frenck frenck merged commit af75faf into current Feb 11, 2025
9 checks passed
@frenck frenck deleted the motioneye-tap-action branch February 11, 2025 10:41
CrEaK pushed a commit to CrEaK/home-assistant.io that referenced this pull request Feb 11, 2025
CrEaK pushed a commit to CrEaK/home-assistant.io that referenced this pull request Feb 11, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Feb 12, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants