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

Use presence detection in automations #34168

Draft
wants to merge 2 commits into
base: current
Choose a base branch
from

Conversation

c0ffeeca7
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 commented Aug 7, 2024

Proposed change

Add tutorial page to getting started

  • using presence detection in automations
  • add tutorial on presence detection as condition
  • presence detection as trigger is topic of separate PR

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

  • New Features

    • Added a new navigation link for "Presence detection in automations" under the "Getting started" section for easier access.
    • Introduced a comprehensive guide on implementing presence detection as a condition in automation setups, enhancing practical application.
  • Content Updates

    • Updated an existing markdown link to direct users to relevant content about integrating presence detection into automations.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Aug 7, 2024
Copy link
Contributor

coderabbitai bot commented Aug 7, 2024

Walkthrough

Walkthrough

The recent updates enhance user navigation and documentation regarding presence detection in automation. A new navigation link has been added for direct access to "Presence detection in automations." Additionally, a new markdown file provides detailed guidance on implementing presence detection conditions in automations, improving the relevance and functionality for users looking to optimize their automation setups.

Changes

File Path Change Summary
source/_includes/asides/getting_started_navigation.html, source/getting-started/presence-detection.markdown Added a new navigation link for "Presence detection in automations" and updated content to focus on practical applications of presence detection within automation.
source/getting-started/presence-detection_in_automation.markdown Introduced a comprehensive guide for implementing presence detection in automation, including setup instructions and visual aids.

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

Copy link

netlify bot commented Aug 7, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 4a85c80
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66b32b5caff39000087773d9
😎 Deploy Preview https://deploy-preview-34168--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 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

Outside diff range, codebase verification and nitpick comments (7)
source/getting-started/presence-detection_in_automation.markdown (5)

6-6: Clarify the introductory sentence.

The introductory sentence can be made clearer by specifying the context.

- Now that you have [set up a device for presence detection](/getting-started/presence-detection/), you can use it in automations.
+ Now that you have [set up a device for presence detection](/getting-started/presence-detection/), you can use this device in your automations.

10-10: Clarify the goal of the tutorial.

The sentence can be rephrased for better clarity.

- In this tutorial, our goal is to run the [turning on the lights before sunset](/getting-started/automation/#turning-on-the-lights-before-sunset) automation only if we are home.
+ In this tutorial, our goal is to run the [turning on the lights before sunset](/getting-started/automation/#turning-on-the-lights-before-sunset) automation only when we are home.

19-19: Clarify the navigation path.

The navigation path can be made clearer by specifying the exact steps.

- Go to {% my automations title="**Settings** > **Automations & scenes**" %} and open the automation we created before, on [turning on the lights before sunset](/getting-started/automation/#turning-on-the-lights-before-sunset).
+ Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and open the automation we created earlier on [turning on the lights before sunset](/getting-started/automation/#turning-on-the-lights-before-sunset).

31-31: Correct the determiner.

The determiner "these" is more appropriate in this context.

- If you want to run this automation only if a specific device is home, follow this steps:
+ If you want to run this automation only if a specific device is home, follow these steps:
Tools
LanguageTool

[uncategorized] ~31-~31: The determiner “these” seems more likely in this context.
Context: ...ly if a specific device is home, follow this steps: - Select Entity, then *...

(AI_EN_LECTOR_REPLACEMENT_DETERMINER)


35-35: Remove unnecessary comma.

The comma before "when" is unnecessary.

- Now, the light will only turn on, when this specific device is home.
+ Now, the light will only turn on when this specific device is home.
Tools
LanguageTool

[typographical] ~35-~35: Usually, there’s no comma before “when”.
Context: ... - Now, the light will only turn on, when this specific device is home. ![...

(IF_NO_COMMA)

source/getting-started/presence-detection.markdown (2)

Line range hint 6-6:
Clarify the introductory sentence.

The introductory sentence can be made clearer by specifying the context.

- Zone presence detection detects if people are within a certain zone, which can be valuable input for automation.
+ Zone presence detection determines if people are within a certain zone, which can be valuable input for automation.
Tools
Markdownlint

76-76: Unused link or image reference definition: "condition"
Link and image reference definitions should be needed

(MD053, link-image-reference-definitions)


77-77: Unused link or image reference definition: "companion"
Link and image reference definitions should be needed

(MD053, link-image-reference-definitions)


Line range hint 12-12:
Clarify the sentence.

The sentence can be made clearer by specifying the context.

- You can do that if you have one of our [supported routers][routers].
+ You can do this if you have one of our [supported routers][routers].
Tools
Markdownlint

76-76: Unused link or image reference definition: "condition"
Link and image reference definitions should be needed

(MD053, link-image-reference-definitions)


77-77: Unused link or image reference definition: "companion"
Link and image reference definitions should be needed

(MD053, link-image-reference-definitions)

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.

Isn't the more interesting use case here to also trigger when you get home and the lights turn on?

@c0ffeeca7
Copy link
Contributor Author

c0ffeeca7 commented Aug 7, 2024

Isn't the more interesting use case here to also trigger when you get home and the lights turn on?

  • yes, topic for another PR
  • point here is to work with the sunset automation, which we already created. and where it would make sense to run it only when someone is home.

@c0ffeeca7 c0ffeeca7 marked this pull request as draft August 7, 2024 08:43
@frenck
Copy link
Member

frenck commented Aug 7, 2024

yes, topic for another PR

👍

point here is to work with the sunset automation, which we already created. and where it would make sense to run it only when someone is home.

Don't agree with that statement. The automation is set up in an incorrect/inflexible way, making it hard to do now.

From an automation perspective, this automation is a wrong practice from the get-go (which happens a lot in our community, I don't blame them, as our triggers contain to much "hidden condition logic" in them).

In general, automation should trigger things, check conditions, and do actions.

Right now, the automation has a mix-up of the sunset trigger that is "conditionally", making it hard to add more triggers as it will mess up stuff.

A better approach, in general, is to trigger "sun" changes and have sunset as an actual condition already. Adding a presence condition and trigger at that point, will make the automation work in the case set here, but also when arriving home (as it will trigger an check the conditions).

@c0ffeeca7
Copy link
Contributor Author

yes, topic for another PR

👍

point here is to work with the sunset automation, which we already created. and where it would make sense to run it only when someone is home.

Don't agree with that statement. The automation is set up in an incorrect/inflexible way, making it hard to do now.

From an automation perspective, this automation is a wrong practice from the get-go (which happens a lot in our community, I don't blame them, as our triggers contain to much "hidden condition logic" in them).

In general, automation should trigger things, check conditions, and do actions.

Right now, the automation has a mix-up of the sunset trigger that is "conditionally", making it hard to add more triggers as it will mess up stuff.

A better approach, in general, is to trigger "sun" changes and have sunset as an actual condition already. Adding a presence condition and trigger at that point, will make the automation work in the case set here, but also when arriving home (as it will trigger an check the conditions).

Thank you for the detailed explanation. Let me rework it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants