Skip to content

README.md

Latest commit

 

History

History
40 lines (32 loc) · 3.64 KB

README.md

File metadata and controls

40 lines (32 loc) · 3.64 KB
Raw

Documentation

Velair documentation is grouped by audience and topic.

User Documentation

  • Installation: install Velair through HACS or manually.
  • Usage: configure climates, schedules, templates, profiles, boosts, pauses, import/export, and services.
  • External changes and Manual adjustment: choose whether Velair keeps automatic authority or yields to HA-card, remote, device, and automation changes.
  • External schedule execution: publish compatible effective weekly schedules, including Profile and Mode selection, to supported controllers without mixing provider logic into Velair's scheduler.
  • Climate Profiles: coordinate alternate schedules and expose configurable Modes to Home Assistant automations.
  • Automation Events: use complete runtime event payloads in Home Assistant automations.
  • Automation Blueprints: import optional occupancy and open-window helpers without polling.
  • Adaptive Preconditioning: start scheduled comfort targets early with local learning.
  • Room Assist: use a separate room temperature sensor for TRVs, thermostats, and AC units.
  • Resilient climate delivery: understand deferred retries and reconnection behavior when a climate is temporarily unavailable.
  • Environmental Comfort: understand temperature, humidity, CO2 air quality, and reading freshness through local room assessments.
  • Temperature Units and Migration: understand Celsius/Fahrenheit defaults, upgrades, migration, import/export, and recovery.
  • Troubleshooting: common setup, frontend resource, and runtime issues.
  • Diagnostics: local runtime health, bounded history, and redacted issue reports.

Developer Documentation

  • Architecture: backend and frontend module boundaries, persistence model and scheduler flow.
  • Blueprint maintenance: add blueprint YAML, catalog entries, consistent detail pages, translations, and tests.
  • WebSocket API: frontend/backend API contract.
  • Adaptive preconditioning internals: local learning states, similarity weighting, storage, and API output.
  • Room Assist internals: room sensor source selection, assisted target calculation, runtime status, restoration, and events.
  • Climate delivery internals: event-driven retry, availability recovery, serialization, generations, and success boundaries.
  • Environmental Comfort internals: source selection, condition assessment, data quality, listeners, API output, and events.
  • Temperature unit internals: storage metadata, migration boundaries, portable conversion, validation, and runtime safety.
  • Frontend: frontend runtime elements, build commands, Lovelace resource, translations, UI principles, and frontend workflow.
  • Development: local checks, generated files, coding guidelines, and contribution workflow.
  • Manual testing: release and behavior verification checklist.

Project Documentation

Future ideas and feature requests should be tracked through GitHub issues or discussions so they can evolve with community feedback without creating roadmap promises.