Add weekdays to time trigger #39707
Add weekdays to time trigger #39707
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This pull request documents the new weekday filtering option for time triggers in Home Assistant automations. It adds a new section with examples demonstrating the use of a single weekday, multiple weekdays, a weekend example, and integration with an input datetime entity.
📝 WalkthroughWalkthroughThe documentation for automation time triggers has been updated to include a new "Weekday filtering" section. This section explains the use of a new Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant AutomationEngine
User->>AutomationEngine: Define time trigger with weekday option in YAML
AutomationEngine->>AutomationEngine: Evaluate current day and time
AutomationEngine-->>User: Trigger automation only if current weekday matches configuration
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_docs/automation/trigger.markdown (4)
828-835: Add trailing blank line & clarify “expanded format” list
- Markdown-lint MD032 is triggered because the bullet list isn’t followed by a blank line.
- “Expanded format” is mentioned but not exemplified (e.g.
"monday","tuesday"). Adding one short sentence or an example avoids confusion.-The `weekday` option accepts: -- A single weekday as a string: `"mon"`, `"tue"`, `"wed"`, `"thu"`, `"fri"`, `"sat"`, `"sun"` -- A list of weekdays using the expanded format +The `weekday` option accepts: +- A single weekday as a string: `"mon"`, `"tue"`, `"wed"`, `"thu"`, `"fri"`, `"sat"`, `"sun"` +- A list of weekdays using the expanded format, e.g. `"monday"`, `"tuesday"`, … +
841-850: Indentation inconsistent with earlier Time-trigger snippetsPrevious examples use four-space indent for the inner trigger list. Keeping that style improves readability & copy-paste reliability.
- - triggers: - - trigger: time + - triggers: + - trigger: timeRepeat the same 2-space reduction for the subsequent lines in this block.
857-867: Same indentation issue propagates to “Multiple weekdays” sampleAlign this block with the “Time string” sample shown earlier for visual consistency:
- - triggers: - - trigger: time + - triggers: + - trigger: time
905-921: Optional: call out thatweekdayworks with sensor/offset form tooSince the preceding section demonstrated offsets (
entity_id + offset), consider adding a one-liner that offsets remain supported whenweekdayis present, e.g. weekday-filtered “5 min before alarm”.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_docs/automation/trigger.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_docs/automation/trigger.markdown
833-833: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
⏰ 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/_docs/automation/trigger.markdown (1)
876-899: Minor YAML style polish in dual-automation exampleThe two automation items are fine, but you can drop the blank line before the second
- alias:to keep the list compact, or alternatively add# ---to visually separate them. Not critical, purely cosmetic.
Proposed change
Documents the new week day option on the time trigger
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
weekdayoption to restrict automations to specific days. Includes examples for single and multiple weekdays, weekends, and combining with input datetime entities.