Skip to content

docs: Update alarm and office READMEs with design decisions - #247

Merged
dannytsang merged 3 commits into
dannytsang:mainfrom
jarvis-tsang:docs/update-20260407-230305
Apr 8, 2026
Merged

docs: Update alarm and office READMEs with design decisions#247
dannytsang merged 3 commits into
dannytsang:mainfrom
jarvis-tsang:docs/update-20260407-230305

Conversation

@jarvis-tsang

Copy link
Copy Markdown
Collaborator

This PR updates documentation for:

  • Alarm package — Auto-generated README with human-friendly automation descriptions
  • Office package — Added Design Decisions and Dependencies sections to existing rich README

Changes

  • Design Decisions section capturing architectural rationale (temperature thresholds, time delays, etc.)
  • Dependencies section linking related packages (Front Garden, Living Room, Porch)
  • Enhanced mermaid diagrams showing data flow
  • Updated 'Last updated' dates

Design Decisions Captured

  • Temperature thresholds based on summer room temperatures
  • Time delays account for temporary disconnections
  • Sun position tracking for daylight-aware behavior
  • Enable switches for easy automation disabling
  • Edge detection vs continuous state triggers

Dependencies Documented

  • EcoFlow integration for energy optimization
  • Cross-package dependencies (Front Garden brightness sensor, Living Room presence groups, Porch notifications)

@jarvis-tsang
jarvis-tsang requested a review from dannytsang as a code owner April 8, 2026 09:07
@github-actions github-actions Bot added the docs label Apr 8, 2026
@dannytsang
dannytsang enabled auto-merge (squash) April 8, 2026 12:16
@dannytsang
dannytsang disabled auto-merge April 8, 2026 18:58
@dannytsang
dannytsang enabled auto-merge (squash) April 8, 2026 18:58
@dannytsang
dannytsang merged commit eb22faa into dannytsang:main Apr 8, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants