Skip to content

improve: Explain wake up action is disabled by default and how to enable it - #346

Open
PedroKTFC wants to merge 1 commit into
edwardtfn:mainfrom
PedroKTFC:patch-1
Open

improve: Explain wake up action is disabled by default and how to enable it#346
PedroKTFC wants to merge 1 commit into
edwardtfn:mainfrom
PedroKTFC:patch-1

Conversation

@PedroKTFC

@PedroKTFC PedroKTFC commented Jul 26, 2026

Copy link
Copy Markdown

If you look just at the api documentation you don't realise that the wake up action isn't enabled by default and so won't be available. This pull request provides clarification.

Summary by CodeRabbit

  • Documentation
    • Clarified that the wake_up action is disabled by default.
    • Added instructions for enabling it through the ESPHome YAML configuration.

Added note about enabling the wake-up action in YAML.
@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The API documentation now states that the wake_up action is disabled by default and requires include_action_wake_up: true in ESPHome substitutions.

Changes

Wake Up Action Documentation

Layer / File(s) Summary
Document wake_up enablement
docs/api.md
The wake_up action documentation explains its default-disabled status and YAML configuration required to enable it.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: edwardtfn

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the documentation change about the wake up action being disabled by default and how to enable it.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@PedroKTFC PedroKTFC changed the title Explain wake up action is disabled by default and how to enable it. improve: Explain wake up action is disabled by default and how to enable it. Jul 26, 2026
@PedroKTFC PedroKTFC changed the title improve: Explain wake up action is disabled by default and how to enable it. improve: Explain wake up action is disabled by default and how to enable it Jul 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant