Status Card

https://github.com/xbourner/status-card
Admin
Status Card is a custom Home Assistant card that provides a comprehensive overview of your entities...
Tokens:7,551
Snippets:70
Trust Score:8.1
Update:7 months ago
Show doc for...
Tokens:
Raw
### Complete Configuration Example

Source: https://context7.com/xbourner/status-card/llms.txt

A comprehensive example showcasing a full Status Card configuration. It includes filtering by area and label, display options, global styling, actions, Smart Group definitions, content ordering, hidden entities/areas, and detailed entity customizations.

```yaml
type: custom:status-card
# Filtering
area:
  - living_room
  - kitchen
  - bedroom
label_filter: true
label:
  - important
  - monitored

# Display
hide_person: false
hide_content_name: false
show_total_number: true
square: false
no_scroll: true
content_layout: horizontal
columns: 4
badge_mode: false
theme: default

# Global styling
color: primary
styles:
  card:
    border-radius: 16px

# Actions
tap_action:
  action: more-info
hold_action:
  action: toggle

# Smart Groups
rulesets:
  - group_id: Low Batteries
    group_icon: mdi:battery-alert
    group_status: low
    attributes:
      device_class: battery
    state: "<20"

  - group_id: Open Windows
    group_icon: mdi:window-open
    domain: binary_sensor
    attributes:
      device_class: window
    state: "on"

# Content order
content:
  - sun.sun
  - Low Batteries
  - Open Windows
  - light
  - switch - outlet
  - climate
  - media_player
  - binary_sensor - motion

# Hidden entities
hidden_entities:
  - update.hacs
  - sensor.internal_temp
hidden_areas:
  - utility

# Customization
customization:
  - type: light
    name: Lights
    icon_color: amber
    show_total_number: true

  - type: climate
    name: HVAC
    popup_card:
      type: thermostat

  - type: Low Batteries
    badge_mode: true
    badge_color: red

  - type: sun.sun
    name: Sun
    icon: mdi:weather-sunny
    state: above_horizon
```

--------------------------------

### Dynamic Filtering Examples

Source: https://context7.com/xbourner/status-card/llms.txt

Demonstrates various methods for filtering entities based on their state, name, attributes, and timestamps. Supports exact matches, numeric comparisons, negation, multiple OR conditions, wildcards, regex, attribute matching, and time-based conditions.

```yaml
state: "on"                          # Exact state match
state: "<50"                         # Numeric comparison (<, <=, >, >=)
state: "!off"                        # Negation (NOT off)
state:                               # Multiple values (OR)
  - "on"
  - "playing"
name: "*kitchen*"                    # Wildcard name match
name: "/^sensor_.*/"                 # Regex name match (enclosed in /)
attributes:
  device_class: battery              # Attribute match
  brightness: ">100"                 # Numeric attribute comparison
last_changed: ">30"                  # Changed more than 30 minutes ago
last_updated: "<5"                   # Updated within 5 minutes
last_triggered: ">60"                # Automation triggered >60 min ago
group: group.all_lights              # Member of HA group
```

--------------------------------

### Supported Domains and Device Classes for Status Card

Source: https://context7.com/xbourner/status-card/llms.txt

Lists the Home Assistant domains supported by the Status Card, indicating which domains are toggleable and providing examples of device classes for binary_sensor, cover, and switch entities. This helps users understand which entities can be controlled and how they are categorized.

```yaml
# Toggleable Domains (support toggle action)
- light                              # Lights
- switch                             # Switches (with outlet device_class)
- fan                                # Fans
- cover                              # Covers (garage, blind, curtain, etc.)
- siren                              # Sirens
- climate                            # Climate/HVAC
- humidifier                         # Humidifiers
- valve                              # Valves
- remote                             # Remotes

# Non-Toggleable Domains
- binary_sensor                      # Binary sensors (motion, window, door)
- alarm_control_panel                # Alarm panels
- lock                               # Locks (lock/unlock actions)
- media_player                       # Media players (play/pause)
- vacuum                             # Vacuums (start/stop)
- lawn_mower                         # Lawn mowers
- water_heater                       # Water heaters
- update                             # Update entities
- device_tracker                     # Device trackers
- input_boolean                      # Input booleans
- timer                              # Timers
- counter                            # Counters
- calendar                           # Calendars

# Device Classes for binary_sensor
- door, window, lock, motion, presence
- occupancy, moisture, vibration, opening
- garage_door, smoke, problem, battery
- plug, power, gas, cold, heat
- connectivity, safety, sound, tamper, light

# Device Classes for cover
- garage, door, gate, blind, curtain
- damper, awning, shutter, shade, window

# Device Classes for switch
- switch, outlet
```

--------------------------------

### Configure Status Card via YAML

Source: https://context7.com/xbourner/status-card/llms.txt

This YAML configuration demonstrates the various options available for the Status Card, including filtering by area or floor, display layout settings, and custom action definitions. It allows users to control entity visibility, visual appearance, and interaction behavior without requiring custom code.

```yaml
type: custom:status-card
# Filter Options
area: living_room
floor: first_floor
label_filter: true
label: motion
multiple_areas: true
multiple_floors: true

# Display Options
hide_person: false
hide_content_name: false
show_total_number: false
show_total_entities: false
square: false
no_scroll: false
content_layout: vertical
columns: 4
badge_mode: false
no_background: false
theme: synthwave

# Color Options
color: red
background_color:
  - 154
  - 25
  - 25
  - 0.3

# Actions
tap_action:
  action: more-info
double_tap_action:
  action: toggle
hold_action:
  action: navigate
  navigation_path: /lovelace/rooms

# Entity Management
extra_entities:
  - sun.sun
  - sensor.temperature
hidden_entities:
  - update.hacs
hidden_labels:
  - Excluded
hidden_areas:
  - dev
  - testing

# Content Order
content:
  - light
  - switch
  - binary_sensor - window
  - binary_sensor - motion
  - climate
```

--------------------------------

### Badge Mode Configuration

Source: https://context7.com/xbourner/status-card/llms.txt

Enables and customizes badge mode for a compact display. Badge mode shows icons with count badges instead of full entity information. This section details global settings and per-type customizations for badge appearance.

```yaml
type: custom:status-card
badge_mode: true                     # Enable badge mode globally
badge_color: primary                 # Badge background color
badge_text_color: white              # Badge text color
no_background: true                  # Remove card background

# Per-type badge customization
customization:
  - type: light
    badge_mode: true
    badge_color: amber
    badge_text_color: black

  - type: binary_sensor - window
    badge_mode: true
    badge_color: cyan

  - type: lock
    badge_mode: false                # Disable badge mode for locks
```

--------------------------------

### Apply Custom CSS Styling

Source: https://context7.com/xbourner/status-card/llms.txt

Allows overriding default styles for card elements, including buttons, icons, names, and state text. Supports both global card styling and per-customization specific overrides.

```yaml
type: custom:status-card
styles:
  card:
    background-color: "rgba(255, 0, 0, 0.1)"
    border: none
    border-radius: 16px
  button:
    background: "rgba(0, 0, 0, 0.05)"
    border-radius: 12px
    padding: 8px
  icon:
    animation: spin 2s linear infinite
    --mdc-icon-size: 40px
    color: var(--primary-color)
  name:
    font-size: 15px
    font-weight: bold
    color: var(--primary-text-color)
  state:
    font-size: 12px
    color: var(--secondary-text-color)
    opacity: 0.8
customization:
  - type: light
    styles:
      button:
        background: "rgba(255, 200, 0, 0.15)"
      icon:
        animation: pulse 1s infinite
        color: orange
      name:
        text-transform: uppercase
      state:
        font-style: italic
```

--------------------------------

### Customize Domain and Entity Appearance

Source: https://context7.com/xbourner/status-card/llms.txt

Provides fine-grained control over the visual representation of specific domains, device classes, and individual entities. Includes options for custom icons, colors, badges, and popup card behavior.

```yaml
type: custom:status-card
customization:
  - type: light
    name: Lights
    icon: mdi:lamp
    icon_color: amber
    background_color:
      - 255
      - 193
      - 7
      - 0.2
    show_total_entities: true
    show_total_number: true
    tap_action:
      action: navigate
      navigation_path: /lovelace/lights
    hold_action:
      action: toggle
    double_tap_action:
      action: more-info
  - type: binary_sensor - window
    name: Windows
    icon: mdi:window-open
    icon_color: cyan
    invert: true
  - type: sun.sun
    name: Sun
    icon: mdi:weather-sunny
    state: above_horizon
    invert_state: false
  - type: switch - outlet
    name: Outlets
    icon: mdi:power-plug
    badge_mode: true
    badge_color: green
    badge_text_color: white
  - type: climate
    name: Thermostats
    popup_card:
      type: thermostat
    popup_sort: state
    ungroup_areas: true
    columns: 2
  - type: Low Batteries
    icon: mdi:battery-alert
    icon_color: red
    badge_mode: true
```

--------------------------------

### YAML Configuration for Status Card

Source: https://github.com/xbourner/status-card/wiki/Settings

This YAML configuration demonstrates the various optional settings available for the custom:dev-status-card. It covers display options like hiding content names, showing total entity counts, layout choices, and theming. It also includes filtering by area, floor, labels, and defining custom rulesets for smart groups. Finally, it shows how to specify content domains and customize individual entities.

```yaml
type: custom:dev-status-card
hide_person: false
list_mode: false
hide_content_name: false
show_total_number: false
square: false
show_total_entities: false
theme: optional
columns: 4
no_scroll: false
content_layout: vertical/horizonzal
color: red
background_color:
  - 154
  - 25
  - 25
  - 0.3
tap_action:
  action: more-info
double_tap_action:
  action: more-info
hold_action:
  action: more-info
filter:
area: living_room
floor: first_floor
label_filter: fase
label: motion
extra_entities:
  - sun.sun
hidden_entities:
  - update.0x5c0272fffeae0368
hidden_labels:
  - Window
hidden_areas:
  - dev
rulesets:
  - group_id: Low Batteries
    group_icon: mdi:battery-10
    group_status: low
    attributes:
      device_class: battery
    state: "<10"
content:
  - light
  - switch
  - "Binary Sensor - window"
customization:
  - type: light
    invert: true
    show_total_number: false
    show_total_entities: false
    invert_state: false
    state: "on" | "off"
    name: test_name
    icon: mdi:account
    icon_color: red
    tap_action:
      action: more-info
    double_tap_action:
      action: more-info
    hold_action:
      action: more-info

```

--------------------------------

### Configure Smart Groups for Entity Filtering

Source: https://context7.com/xbourner/status-card/llms.txt

Defines custom entity collections based on criteria such as battery levels, device states, integration types, and name patterns. These groups allow for dynamic filtering and categorization of entities within the status card.

```yaml
type: custom:status-card
rulesets:
  - group_id: Low Batteries
    group_icon: mdi:battery-10
    group_status: low
    attributes:
      device_class: battery
    state: "<10"
  - group_id: Stale Devices
    group_icon: mdi:clock-alert
    group_status: stale
    last_changed: ">60"
    domain: sensor
  - group_id: Active Motion
    group_icon: mdi:motion-sensor
    group_status: detected
    domain: binary_sensor
    attributes:
      device_class: motion
    state: "on"
    area:
      - living_room
      - kitchen
      - bedroom
  - group_id: Zigbee Devices
    group_icon: mdi:zigbee
    integration: zha
    state: "unavailable"
  - group_id: Temperature Sensors
    group_icon: mdi:thermometer
    name: "*temperature*"
    domain: sensor
  - group_id: Philips Hue
    group_icon: mdi:lightbulb
    device_manufacturer: Signify Netherlands B.V.
  - group_id: Diagnostic Entities
    group_icon: mdi:bug
    entity_category: diagnostic
  - group_id: Critical Sensors
    group_icon: mdi:alert
    label: critical
    state: "!on"
```

--------------------------------

### Registering Status Card as a Lovelace Resource

Source: https://github.com/xbourner/status-card/blob/main/README.md

This YAML configuration snippet registers the status-card.js file as a JavaScript module resource within the Home Assistant dashboard, enabling the card for use in the UI.

```yaml
resources:
  - url: /local/status-card.js
    type: module
```

--------------------------------

### Global and Per-Type Actions for Status Card

Source: https://context7.com/xbourner/status-card/llms.txt

Defines global actions (tap, hold, double-tap) that apply to all entities, and allows for type-specific overrides for actions like more-info, toggle, and calling services. This enables granular control over user interactions with different entity types.

```yaml
tap_action:
  action: more-info
hold_action:
  action: toggle
double_tap_action:
  action: call-service
  service: light.turn_off
  data:
    entity_id: all

customization:
  - type: light
    tap_action:
      action: more-info
    hold_action:
      action: toggle
    double_tap_action:
      action: call-service
      service: light.turn_on
      data:
        brightness_pct: 100

  - type: media_player
    tap_action:
      action: more-info
    hold_action:
      action: call-service
      service: media_player.media_play_pause
      target:
        entity_id: media_player.living_room

  - type: lock
    tap_action:
      action: more-info
    hold_action:
      action: call-service
      service: lock.unlock
      confirmation:
        text: "Are you sure you want to unlock?"
    double_tap_action:
      action: none

  - type: scene.evening_lights
    tap_action:
      action: call-service
      service: scene.turn_on
      target:
        entity_id: scene.evening_lights
```

--------------------------------

### Popup View Configuration for Status Card

Source: https://context7.com/xbourner/status-card/llms.txt

Configures the appearance and behavior of the entity detail popup view in the Status Card. Options include the number of columns, list mode, sorting preferences, and area grouping. Per-type customization allows for specific popup card types and features for different domains.

```yaml
type: custom:status-card
columns: 4                           # Number of columns in popup (1-4)
list_mode: false                     # Show entity IDs as text list
popup_sort: name                     # Sort by "name" or "state"
ungroup_areas: false                 # Disable area grouping in popup

# Per-type popup customization
customization:
  - type: light
    columns: 3
    popup_sort: state
    ungroup_areas: true
    list_mode: false
    popup_card:                      # Custom card type in popup
      type: tile
      features:
        - type: light-brightness

  - type: climate
    popup_card:
      type: thermostat

  - type: camera
    popup_card:
      type: picture-entity
      show_state: true
      show_name: true

  - type: media_player
    popup_card:
      type: media-control
```

--------------------------------

### Person Entity Configuration

Source: https://context7.com/xbourner/status-card/llms.txt

Configures the display of person entities within the Status Card, allowing customization of home/away icons and colors. This helps visually distinguish between a person's presence status.

```yaml
type: custom:status-card
hide_person: false                   # Show/hide person entities
person_home_color: green             # Color when home
person_away_color: red               # Color when away
person_home_icon: mdi:home           # Icon when home
person_away_icon: mdi:home-export-outline  # Icon when away
```

--------------------------------

### Smart Group Filter Keys for Status Card

Source: https://context7.com/xbourner/status-card/llms.txt

Details the static filter keys available for creating Smart Groups within the Status Card. These filters allow for matching entities based on various criteria such as area, label, domain, entity ID patterns, device information, and integration.

```yaml
# Static Filters (evaluated once on config)
area: living_room                    # Filter by area ID
floor: first_floor                   # Filter by floor ID
label: important                     # Filter by label
domain: sensor                       # Filter by entity domain
entity_id: "sensor.*temperature*"    # Wildcard entity ID match
device: abc123                       # Filter by device ID
integration: zha                     # Filter by integration/platform
entity_category: diagnostic          # Filter: config, diagnostic
hidden_by: user                      # Filter: user, integration
device_manufacturer: Philips         # Filter by device manufacturer
device_model: Hue Bulb               # Filter by device model
```
Tokens:
Raw