Clarify the time unit that a template should return

[SodaWithoutSparkles]

Description:

In deep_sleep.enter, sleep_durartion is templatable but the unit is never provided. This commit clarifies that it should be in ms.

Reference: esphome/esphome@da82562

Related issue (if applicable): N/A

Pull request in esphome with YAML changes (if applicable): N/A

Checklist:

• I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
  or

• I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

• Link added in /components/index.rst when creating new documents for new components or cookbook.

[coderabbitai]

Walkthrough

The changes update the deep_sleep documentation and usage by introducing a templatable option for the sleep_duration parameter. The documentation now clarifies that, when using a template, the value must be returned in milliseconds. Additionally, an example using a lambda function to set sleep_duration in the deep_sleep.enter action has been added. These modifications maintain the existing functionality while expanding configuration options.

Changes

File	Change Summary
components/deep_sleep.rst	Updated the sleep_duration documentation to specify that templates must return milliseconds. Added an example demonstrating the use of a lambda function for dynamic sleep duration configuration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DeepSleepAction
    participant LambdaEvaluator
    participant SleepService

    User->>DeepSleepAction: Call deep_sleep.enter with templated sleep_duration
    DeepSleepAction->>LambdaEvaluator: Evaluate lambda for sleep_duration
    LambdaEvaluator-->>DeepSleepAction: Return sleep duration in milliseconds
    DeepSleepAction->>SleepService: Enter sleep mode for computed duration
    SleepService-->>DeepSleepAction: Confirm sleep mode initiated
    DeepSleepAction-->>User: Operation complete

Loading

Suggested reviewers

• jesserockz
• frenck

---

📜 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 da90429 and a625ac4.

📒 Files selected for processing (1)

• components/deep_sleep.rst (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**`: - Do not generate or add any sequence diagrams

**: - Do not generate or add any sequence diagrams

• components/deep_sleep.rst

🔇 Additional comments (2)

components/deep_sleep.rst (2)

134-140: Clarify Template Usage with Lambda Example
The new example clearly demonstrates how to use a lambda function to set the sleep_duration in milliseconds. This directly supports the PR objective by illustrating that templates must return a value in milliseconds.

---

151-151: Update Documentation for sleep_duration
The updated documentation now specifies that if a template is used, the returned value must be in milliseconds. This clarification is concise and improves the guidance provided to the user.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @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.

[netlify]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	a625ac4
🔍 Latest deploy log	https://app.netlify.com/sites/esphome/deploys/67c896d351a25b0008ca9f28
😎 Deploy Preview	https://deploy-preview-4732--esphome.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.