Status Card for Home Assistant

repository·main·Indexed 43 days ago

https://github.com/xbourner/status-card

A custom Home Assistant dashboard card (v3.3.2) that provides a high-level overview of home entities. It automatically aggregates data based on area assignments, allowing users to monitor domains, device classes, and smart groups created via rulesets without manual reconfiguration.

Tokens
19.1K
Snippets
61
Records
98
Agent score
55%

What's inside Status Card

  1. Overview of Status Card features

    main

    Status Card is a custom card designed for Home Assistant Dashboards that provides an intelligent, responsive overview of your home status. Key features include:

    • Zero-Configuration Magic: Automatically builds your dashboard by reading entities and devices assigned to your Home Assistant Areas.
    • Smart State Filtering: Displays only active or "on" entities. It supports optional inverted logic for custom use cases.
    • Dynamic Grouping: Automatically organizes active entities by their domain or device_class.
    • Powerful Smart Groups: Allows building intelligent groups using multi-layered filters (state, domain, etc.), manual entity additions, and the ability to hide specific entities.
    • Interactive Detail Popups: Tapping a group opens a native popup containing all contained entities rendered as interactive Tile Cards.
  2. Overview of Status Card

    main
    Status Card is a custom card designed for Home Assistant Dashboards. It provides a comprehensive overview of your entities by automatically aggregating data based on your Home Assistant configuration. Instead of manually updating the card every time an entity changes, you simply assign your entities or devices to specific areas in Home Assistant, and the card dynamically displays the relevant data for a quick glance at your home's status.
  3. Overview of Status Card customization features

    main

    Status Card offers extensive customization through optional settings grouped by feature. These settings are managed within the editor.

    Note: Some customization combinations may break due to Home Assistant (HA) updates. It is recommended to test one customization option at a time to ensure stability.

  4. Explore other Home Assistant custom cards by xBourner

    main

    xBourner maintains several other custom cards for Home Assistant dashboards. If you need enhanced area management, advanced calendar features, or flexible header positioning, you can explore these related projects:

    • Area Card Plus: An enhanced area card for Home Assistant dashboards.
    • Calendar Card Plus: A feature-rich calendar card for Home Assistant.
    • Header Position Card: Allows you to position your header card anywhere on the dashboard.
  5. Why binary_sensor, cover, or switch domains might not appear as tabs

    main
    The domains binary_sensor, cover, and switch are treated as special domains. Instead of appearing as individual domain tabs, they are automatically grouped by their device classes. This allows the card to provide a higher-level summary (e.g., showing that '4 windows are open' rather than listing 17 individual binary_sensor entities).
  6. Configure Person entities in Status Card

    main

    The Status Card automatically detects all person.* entities from the Home Assistant entity registry. By default, all person entities are displayed in the order they were created. The card displays the entity's photo or a fallback icon, and uses the person's state (Home/Away) to determine the icon, color, and grayscale filter. Clicking a person opens the default Home Assistant 'more info' dialog.

    type: custom:status-card
    hide_person: false
    person_home_color: green
    person_away_color: red
    person_home_icon: mdi:home
    person_away_icon: mdi:home-export-outline
    customization:
      - type: person.max
        show_entity_picture: true
        name: "Max"
        state_content: "Home"
  7. How Domain Items work in Status Card

    main

    Status Card supports automatic entity grouping by domain (e.g., light, switch, fan, climate). When a domain is listed in the content section of the configuration, the card automatically groups entities belonging to that domain, applies domain-specific icons for different states (on/off), and uses predefined toggle actions.

    Important: You must explicitly list every domain you want to display in the content section. If a domain is not listed there, it will not be shown in the card, even if entities exist.

  8. Group entities by Device-Class

    main

    For the binary_sensor, cover, and switch domains, you can automatically group entities by their device class. This is achieved by using a specific string format in the content configuration: "domain - device_class".

    Supported Domains and Formats:

    • Binary Sensor: binary_sensor - <device_class> (e.g., binary_sensor - motion)
    • Cover: cover - <device_class> (e.g., cover - window)
    • Switch: switch - <device_class> (e.g., switch - outlet)

    When using this format, the card will automatically split entities within that domain into their respective device class groups.

    content:
      - binary_sensor - motion
      - cover - window
      - switch - outlet
  9. Understand how Status Card filters entities

    main

    The Status Card works by scanning all devices and entities in Home Assistant. It specifically targets entities assigned to an Area.

    To reduce noise, the card applies a filter that hides entities in the following states:

    ["closed", "locked", "off", "docked", "idle", "standby", "paused", "auto", "not_home", "disarmed", "0"]

    Only entities in states not included in this list will be processed for status calculation and display.

  10. Configure filters for Status Card

    main

    Status Card allows you to filter displayed information based on Area, Floor, and Label. Filters are additive; if you set both an area and a label, the card will only show items that match both criteria. By default, no filters are applied.

    Available filter types:

    • Area: Filters by specific areas.
    • Floor: Filters by specific floors.
    • Label: Filters by specific labels.
  11. Customize specific domains or entities with customization

    main

    The customization list allows you to override settings for specific domains, device classes, or extra entities. You can change their name, icon, color, or how they respond to user interaction.

    Example Customization: This example inverts a light domain so that only 'off' entities are shown, and changes its display name and icon.

    customization:
      - type: light
        invert: true
        name: test_name
        icon: mdi:account
        icon_color: red
        tap_action:
          action: more-info