Skip to content

README.md

Latest commit

 

History

History
94 lines (66 loc) · 4.28 KB

README.md

File metadata and controls

94 lines (66 loc) · 4.28 KB
Raw

Humidity Intelligence UI Gallery banner

Humidity Intelligence UI Gallery

Reusable Lovelace examples built on the Humidity Intelligence V2 generated card templates.

These examples are public documentation artifacts. They should demonstrate safe, canonical UI patterns without exposing private Home Assistant entity IDs, addresses, screenshots, or personal data.

The V2 example YAML follows the backend-owned hi.reason.v1 reason contract and the humidifier demand/output truth contract. The reason panel renders the escaped backend headline and ordered line text without card-authored Stage: or Engine: prose. Requested, On, Idle, Isolated, Retrying, Stopping, Unknown, Degraded, and Fault remain separate presentation states. On is concise card wording for backend output_on, and the examples do not infer physical moisture production from a generic output on state. The canonical YAML uses the same plain-language backend reason authority across AQ and Zone examples. The V2 previews were captured from an exact live 2.0.10-beta.7 installation after restart, fresh export, complete Manual-card YAML replacement, and cache refresh. They are package-and-card UI evidence, not soak, Stable, release, or HACS-publication evidence.

The browseable UI Gallery lives in the GitHub Wiki:

This repository directory remains the canonical source for gallery YAML, preview assets, example notes, and contribution review. The Wiki is a visual navigation layer only; it must not define new entity semantics, backend behavior, lane priority, generated-card logic, or install guidance that differs from the repository.

Available Layouts

Default V2 Mobile AQ

  • Style: mobile-first V2 control surface with air-quality lane active state
  • Optimised for: phones and narrow dashboard panels
  • Author: @senyo888
  • Source template: custom_components/humidity_intelligence/ui/cards/v2_mobile.yaml
  • Required custom cards: card-mod, button-card, mod-card, apexcharts-card

Default V2 Mobile AQ preview

Default V2 Tablet Zone 1 Cooking

  • Style: tablet-friendly V2 control surface with the Zone 1 cooking lane selected
  • Optimised for: tablets, wall panels, and wider dashboard views
  • Author: @senyo888
  • Source template: custom_components/humidity_intelligence/ui/cards/v2_tablet.yaml
  • Required custom cards: card-mod, button-card, mod-card, apexcharts-card

Default V2 Tablet Zone 1 Cooking preview

Default V1 Mobile (Deprecated)

  • Status: deprecated in v2.0.9; retained through the v2.0.9 line
  • Replacement: Default V2 Mobile AQ / custom_components/humidity_intelligence/ui/cards/v2_mobile.yaml
  • Style: legacy-compatible mobile layout with comfort band and humidity constellation
  • Optimised for: phones and users keeping a V1-style dashboard presentation
  • Author: @senyo888
  • Source template: custom_components/humidity_intelligence/ui/cards/v1_mobile.yaml
  • Required custom cards: card-mod, button-card, mod-card, apexcharts-card

Default V1 Mobile preview

The V1 example remains available for existing users during v2.0.9, including the dynamic-text HTML-escaping fix. Do not use it for new dashboard installations. Removal is deferred to a separately approved v2.1 migration proposal.

Submitting Gallery Examples

Read CONTRIBUTING.md before opening a UI Gallery pull request.

Every example must use:

ui-gallery/<card-id>/

Required files:

  • README.md
  • card.yaml or dashboard.yaml
  • preview.png

Use reference.txt as the entry template.