houseplan-card/docs/ROADMAP.md at 7642c484d21ef48635df2833c5dc4a779b805c19

mirror of https://github.com/Matysh/houseplan-card synced 2026-09-29 03:09:36 +00:00

Files

T

Matysh 8eb4bab7c6 docs: file reviews where reviews live, retire the #89 draft, honest markers

Three review documents sat in the repository root, committed before the pipeline
existed and before docs/reviews/ did. The directory exists now and the pipeline
writes into it, so they move there and the root stops being a second place to
look.

The #89 spec had a twin: the research draft next to the normative stage1
document, two files for one issue. The draft goes to legacy — it fed the
decisions and is worth keeping, but nothing should read it as current.

ROADMAP.md carried a live link to the Project v2 board that was dropped
yesterday; missed then because the sweep grepped for status-canon wording, not
for every link. And docs/README.ru.md said "verified against v1.60.0" as if
that were fresh — the line is now an explicit warning naming what to trust
instead: USER-GUIDE.ru.md and the changelogs.

Issue: #142
User-Visible: no

2026-08-14 11:40:26 +03:00

101 lines

6.1 KiB

Markdown

Raw Blame History

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

 # Roadmap: a universal, flexible floor-plan component
 Goal: a **proper Home Assistant component** built to HA developer-docs patterns —
 not a hardcoded feature. Universal (any house, any language, any plan format),
 flexible (options instead of assumptions), and measured against the official
 **Integration Quality Scale** even though custom integrations are not formally graded.
 Current tasks and priorities live only in
 [GitHub Issues](https://github.com/Matysh/houseplan-card/issues) and their labels
 (`PROCESS.md` §9); this file keeps historical engineering direction. The original market rationale is archived at
 `legacy/docs/PRODUCT-2026-07-05.md`.
 Phases 0–6 of the original plan (server-side config, room markup editor, device
 management, virtual devices, publication) are **done** — see CHANGELOG v1.3.0–v1.11.2.
 This roadmap replaces them.
 ## Phase 7 — Quality Scale: Bronze-complete (structural correctness)
 Track progress in `custom_components/houseplan/quality_scale.yaml` (done/exempt + comment).
 - [x] `runtime-data`: move `hass.data[DOMAIN]` (stores, entry, write lock) to typed
   `entry.runtime_data` (`type HouseplanConfigEntry = ConfigEntry[HouseplanData]`).
   Keep WS command registration in `async_setup` (commands must survive entry reloads).
 - [x] `config-entry-unloading` (Silver, do it now): real `async_unload_entry` — unregister
   update listeners via `entry.async_on_unload`; document what stays (static paths cannot
   be unregistered — exempt comment).
 - [x] `test-before-setup`: verify storage is loadable/writable in `async_setup_entry`,
   raise `ConfigEntryNotReady` on failure.
 - [x] `unique-config-entry`: replace the manual `_async_current_entries()` check with
   `single_config_entry: true` in manifest.
 - [x] `config-flow-test-coverage` + backend tests for websocket_api (pytest-homeassistant-custom-component:
   conflict/rev, admin_only enforcement, layout point ops, upload limits).
 - [x] Storage versioning: `Store(minor_version=...)` + `_async_migrate_func` skeleton **now**,
   before the config schema evolves further (Bronze-adjacent, cheap while schema is stable).
 - [x] `quality_scale.yaml` with honest exempt list (no entities ⇒ entity rules N/A, no polling, no deps).
 ## Phase 8 — Quality Scale: Silver + selected Gold
 - [ ] `test-coverage` ≥95% backend; frontend: extract remaining pure logic (view math,
   marker resolution) into `logic.ts`/`devices.ts` and cover with node:test.
 - [x] `diagnostics.py`: config + layout dump with `async_redact_data` (redact names/links/PDF paths).
 - [ ] `reconfiguration-flow` + richer **options flow**: admin_only, filtering defaults
   (exclude domains — UI editable, replacing the hardcoded EXCLUDED_DOMAINS fallback),
   LQI thresholds, group_lights default.
 - [x] `repair-issues`: broken plan references in Repairs (repairs.py, re-checked on
   every config save); geometry/repair WS command for stranded migrations (v1.50.1).
 - [x] `system_health.py` (v1.12.0).
 - [ ] `exception-translations` + `icon-translations` where applicable.
 - [ ] Frontend resource registration: adopt the community-consensus embedded-card pattern
   end-to-end (we already do StaticPathConfig + storage-mode resource + `?v=` busting;
   add resource cleanup on removal and document YAML-mode fallback).
 ## Phase 9 — Universality & flexibility (product depth)
 - [x] **Areas/floors registry integration**: floors-import wizard (v1.13.0); further: suggest area
   bindings from the registry, sync names (HA is moving this way — native Areas/Home
   dashboard; riding the registry is our moat).
 - [x] **Filtering without hardcode**: icon rules became data (v1.13.0); the runtime
   filter itself became explicit per-device hide flags in v1.51.0 (docs/FILTERING.md);
   icon rules are user-editable
   mapping (regex/domain/device_class → mdi icon) stored in config, shipping EN+RU
   defaults; drop dacha-specific patterns from code.
 - [x] **Click actions** per device (v1.13.0, simplified v1.38.1): card / more-info /
   toggle, with the lock/alarm safety model; running an automation/script/scene
   with an optional confirmation landed in v1.53.0.
 - [x] **Live robot vacuums** (docs/VACUUM.md): a puck driving the plan over a
   solved affine transform, one-click calibration by room names or a
   drag-and-stretch fit panel, server-recorded trails (current + previous run)
   with never/cleaning/always display modes. Adapters: Xiaomi Cloud Map
   Extractor, Tasshack dreame-vacuum, Valetudo. Display only — no commands.
 - [x] **Theming**: light-theme pass done in v1.13.0; HA theme variables
   everywhere, optional per-space background color.
 - [ ] Multi-instance question: keep single-instance (one house) but support **multiple
   cards** with different default spaces (already works) — document as a decision.
 - [ ] Plan formats: keep SVG/PNG/JPG/WebP; add max dimensions guidance; optional
   auto-downscale on upload.
 - [x] More locales: i18n dictionaries are JSON since v1.13.0 (src/i18n/*.json).
 ## Phase 10 — Community & distribution
 - [ ] hacs/default PR **#9004** through moderation (#8995 was bot-closed for a
   non-template body; #9004 is queued with the label since 2026-07-22).
 - [ ] Demo GIF/video for README (the single biggest driver of adoption for dashboard cards).
 - [ ] Forum post in the Floorplan category + Reddit r/homeassistant showcase once
   the demo assets exist.
 - [ ] GitHub: issue templates, discussions on, CONTRIBUTING.md (build/test in 5 minutes).
 - [ ] Semantic versioning discipline; keep release notes user-facing (they show in HACS).
 ## Phase 11 — UX modes redesign ✅ DONE (v1.25.0–v1.28.0, see docs/UX-MODES.md)
 Shipped: the three-tab interaction model (View / Plan / Devices, v1.25.0),
 state-reflecting icons + value display (v1.26.0), RGB light colors + alarm pulse
 (v1.27.0), sub-area rooms (v1.28.0). Remaining backlog from issue #3: music
 notes for players, directional TV ripples (not planned).
 ## Explicit non-goals (for now)
 - 3D plans (.glb) — separate market (3Dash), heavy dependencies.
 - Editing the plan image itself (walls/furniture drawing à la easy-floorplan) — we
   consume existing plan images; the markup editor stays about *rooms/zones*, not drawing.
 - Cloud anything. Config stays in `.storage`, local-first.

101 lines 6.1 KiB Markdown Raw Blame History Unescape Escape

101 lines

6.1 KiB

Markdown

Raw Blame History