mirror of
https://github.com/Matysh/houseplan-card
synced 2026-07-31 16:38:31 +00:00
Matysh
4083e14247
A sweep of every document against the shipped behaviour: - README en+ru: the space dialog no longer claims a background is mandatory (draw-by-hand and the saved-plans picker exist; the canvas is square); 'Show all devices' sections rewritten for the hide-flag world — the checkbox, 'Show hidden' ghosts, LQI-yes/light-no; troubleshooting updated. - ARCHITECTURE: the config schema block still described v1.3 — aspect/device_overrides/virtual_devices/1000x1000-per-aspect/legacy-bundle fallback, all long gone. Rewritten to the current shape (square canvas, markers with hidden, filter_seeded, quotas, signed urls). The WS table dropped houseplan/file/set (removed in v1.10.0) and gained geometry/repair, layout/delete, files/migrate, files/cleanup, content/sign, the plans/list cap. - UX-MODES: the Devices-tab tool list names the checkbox and the local 'Show hidden' instead of the retired shared show-all. - ROADMAP: repair-issues, system_health, floors import, data icon rules, click actions, theming and JSON i18n were done releases ago — checked off with their versions; the HACS pointer is #9004 (bot closed #8995). - STATUS: SSH port is 22222 and the HA config root is /mnt/data/supervisor/homeassistant (/config does not exist there); the key lives in houseplan/.secrets; the PAT note reflects the fine-grained token; the feature surface gained the v1.42-v1.51 era. - DEVELOPMENT: deploy instructions with the real port, path and cache busting. - The owner's product description (user folder) refreshed the same way: square canvas, hide flags, the yellow principle.
5.5 KiB
5.5 KiB
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
(see docs/PRODUCT.md for the market rationale).
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).
runtime-data: movehass.data[DOMAIN](stores, entry, write lock) to typedentry.runtime_data(type HouseplanConfigEntry = ConfigEntry[HouseplanData]). Keep WS command registration inasync_setup(commands must survive entry reloads).config-entry-unloading(Silver, do it now): realasync_unload_entry— unregister update listeners viaentry.async_on_unload; document what stays (static paths cannot be unregistered — exempt comment).test-before-setup: verify storage is loadable/writable inasync_setup_entry, raiseConfigEntryNotReadyon failure.unique-config-entry: replace the manual_async_current_entries()check withsingle_config_entry: truein manifest.config-flow-test-coverage+ backend tests for websocket_api (pytest-homeassistant-custom-component: conflict/rev, admin_only enforcement, layout point ops, upload limits).- Storage versioning:
Store(minor_version=...)+_async_migrate_funcskeleton now, before the config schema evolves further (Bronze-adjacent, cheap while schema is stable). quality_scale.yamlwith 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) intologic.ts/devices.tsand cover with node:test.diagnostics.py: config + layout dump withasync_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.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).system_health.py(v1.12.0).exception-translations+icon-translationswhere 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)
- 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).
- 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.
- Click actions per device (v1.13.0, simplified v1.38.1): card / more-info / toggle, with the lock/alarm safety model.
- 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.
- 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.