Fix device_tracker_timeout example config

[scaccoman]

Fix indentation of device_tracker_timeout property in example config in README.

As you can see from the relevant code below, device_tracker_timeout is not nested inside the events property:

module.exports.frigate = ({ id, camera, topic }) => {
  const { topicURL } = require('../util/frigate.util');
  const {
    url,
    events,
    attempts,
    image,
    stop_on_match: stopOnMatch,
    min_area: minArea,
    device_tracker_timeout: deviceTrackerTimeout,
  } = JSON.parse(JSON.stringify(CONFIG.frigate));
  const { masks } = module.exports;

  _.mergeWith(image, events?.[camera]?.image || {}, customizer);
  _.mergeWith(attempts, events?.[camera]?.attempts || {}, customizer);

  const useCrop = masks(camera) || crop_snapshot(camera) ? '' : '&crop=1';
  const snapshot = `${topicURL(topic)}/api/events/${id}/snapshot.jpg?h=${image.height}${useCrop}`;

  const latest = image.latest || `${topicURL(topic)}/api/${camera}/latest.jpg?h=${image.height}`;

  return objectKeysToUpperCase({
    url: { frigate: url, snapshot, latest },
    attempts,
    stop_on_match: stopOnMatch,
    min_area: minArea,
    device_tracker_timeout: deviceTrackerTimeout,
  });
};

Summary by CodeRabbit

• New Features

  • Introduced a new configuration option, device_tracker_timeout, allowing users to customize the delay for the MQTT home assistant device tracker.

• Documentation

  • Updated the README.md to include the new configuration option and improved clarity of comments related to its purpose and default value.

[coderabbitai]

Walkthrough

The README.md file has been updated to introduce a new configuration option, device_tracker_timeout, under the frigate section. This option allows users to specify a custom delay for the MQTT home assistant device tracker before a 'not_home' message is sent. The default value is set to 30 minutes. The previous comment block has been removed and replaced with a clearer description of the new setting.

Changes

File	Change Summary
README.md	Added device_tracker_timeout configuration option with default value of 30 minutes; updated comments for clarity.

Poem

In the land of code where rabbits play,
A new timeout option brightens the day.
With device_tracker_timeout, we now can see,
How long to wait 'fore we say "not home," whee!
Clarity shines in the README's embrace,
Hopping along in this coding space! 🐇✨

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

README.md (1)

439-442: Consider adjusting comment formatting for consistency.

The comment formatting could be improved to match the style of other configuration options in the file:

-  # By adjusting  device_tracker_timeout , users can determine how long they    
-  # want to wait before receiving a 'not_home' message when no person is        
-  # recognized. The time delay is implemented in minutes and the default value  
-  # is set to 30 minutes
+  # By adjusting device_tracker_timeout, users can determine how long they
+  # want to wait before receiving a 'not_home' message when no person is
+  # recognized. The time delay is implemented in minutes and the default value
+  # is set to 30 minutes

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0227b0c and d5d70a3.

📒 Files selected for processing (1)

• README.md (1 hunks)

🔇 Additional comments (1)

README.md (1)

436-444: LGTM! Configuration option correctly placed under frigate section.

The device_tracker_timeout option is now properly documented and correctly placed at the root level of the frigate configuration section, which matches how it's used in the codebase.

[github-actions]

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

[scaccoman]

Hey @skrashevich, this should be a dead simple PR to merge, there's a mistake in the docs which may cost users a ton of time and frustration in the future (like to me). I had to dig into the codebase to figure out why device_tracker_timeout wasn't working, no errors are thrown so it's particularly hard to notice.

[stevusprimus]

Hi @scaccoman @skrashevich (@jakowenko), is there a other know maintainer for this in the meantime? I would really love to contribute to this :) But it seems the double-take is a little stale. Let me know.

[github-actions]

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

[scaccoman]

Commenting to keep PR open

[github-actions]

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.