Battery State Card

Battery state card for Home Assistant. It shows battery levels from connected devices (entities).

Overview

This card was inspired by another great card showing the battery states. I have decided to implement my own as there was no response for pull requests from author and I wanted to fix few things and also add couple new features.

Breaking changes

Config

Default card config

The card comes with built-in defaults shown below. These defaults are shallow-merged with your custom config — any property you don't explicitly set will use its default value. To disable a default, override it explicitly (e.g. filter: {} to remove the default filter).

type: "custom:battery-state-card"
secondary_info: "{last_changed}"
filter:
  include:
    - name: "attributes.device_class"
      value: "battery"
  exclude:
    - name: "entity_id"
      value: "binary_sensor.*"
sort:
  by: "state"
collapse: 8
bulk_rename:
  - from: " Battery"
  - from: " level"
colors:
  steps:
    - '#ff0000'
    - '#ffff00'
    - '#00ff00'
  gradient: true

The following config resets all the above defaults, you can use it as a base config if you want to fully configure the card on your own

type: "custom:battery-state-card"
secondary_info: null
filter: {}
sort: {}
collapse: 0
bulk_rename: []
colors: {}

Card config

+common options (if specified they will be applied to all entities)

Entity object

+common options (if specified they will override the card-level ones)

Common options

These options can be specified both per-entity and at the top level (affecting all entities).

Keyword string (KString)

This is a string value containing dynamic values. Data for dynamic values can be taken from entity properties, its attributes, other entity state/attributes, etc.

Keywords support simple functions to convert the values

You can execute functions one after another. For example if you have the value "Battery level: 26.543234%" and you want to extract and round the number then you can do the following: "{attribute.battery_level|replace(Battery level:,)|replace(%,)|round()} %" and the end result will be "27"

Sort object

Note: you can simplify this setting and use just use strings if you want to keep ascending order e.g.:

sort:
  - "name"
  - "state"

Note: the state and name values used for sorting are the ones you see rendered on the card (e.g. after state_map transformations). You can use raw entity values to sort by prefixing their names with entity.. E.g. entity.last_changed or entity.attributes.battery_level or entity.state

Color settings

Note: enabling gradient requires at least two colors/steps and all provided colors need to be in hex HTML format e.g. #ff00bb.

Color step

Default colors

Note: the exact color is taken from CSS variable and it depends on your current template.

Filters

Note: The action (include/exclude) is performed when at least one of the filters is matching (OR). Since v3.3.0 you can use composite filters (and, or, not) to combine multiple conditions.

Note: Include filters should rely on static entity properties. E.g. you should not add include filter which checks the state property. Include filters are processed only once - when page is loaded (to minimize perf impact).

Filter object

Note: In v4.1.0 the state value is the original entity state (something what you may find in the HA developer tools). If you use state_map, any other state transformation or if you want to filter based on the final state shown in the card please use computed.state instead.

Template values in filters: You can use {entity_id} syntax in the filter value to reference another entity's state. This lets you create dynamic filters based on values from other entities (e.g. input numbers, sensors). For example, {input_number.low_battery_threshold} will be resolved to the current state of that entity before comparison. You can also reference attributes: {sensor.my_sensor.attributes.some_attr}.

filter:
  exclude:
    - name: computed.state
      operator: '>'
      value: '{input_number.low_battery_threshold}'

Composite filters

Since v3.3.0, you can create complex filter conditions using logical operators:

Composite filters can be nested to create complex conditions.

Example: Using AND to match entities with both conditions

filter:
  include:
    - and:
        - name: entity_id
          value: "*_battery*"
        - name: computed.state
          operator: "<"
          value: 50

Example: Using OR for multiple patterns

filter:
  include:
    - or:
        - name: entity_id
          value: "*_battery"
        - name: entity_id
          value: "*_power"

Example: Using NOT to exclude specific entities

filter:
  include:
    - name: "attributes.device_class"
      value: battery
  exclude:
    - not:
        name: computed.state
        operator: "<"
        value: 20

Example: Complex nested conditions

filter:
  include:
    - and:
        - or:
            - name: entity_id
              value: "sensor.*_battery"
            - name: "attributes.device_class"
              value: battery
        - not:
            name: entity_id
            value: "*_exclude_*"

Filter operators

Operator is an optional property. If operator is not specified it depends on value config property:

• if value is not specified the default operator is exists
• if value starts and ends with slash "/" or if it contains wildcard "*" the operator is matches
• if value property is set but above conditions are not met the operator is "="

Example: Include entities with specific device label

filter:
  include:
    - name: "device.labels"
      operator: contains
      value: "office_stuff"

Example: Include only entities WITHOUT a specific label

filter:
  include:
    - not:
        name: "device.labels"
        operator: contains
        value: "ignore_battery"

Example: Exclude entities not updated within the last 24 hours (show only stale devices)

filter:
  include:
    - name: attributes.device_class
      value: battery
  exclude:
    - name: last_updated
      operator: ">"
      value: "24h"

Tap-Action

The definition is similar to the default tap-action in HomeAssistant.

Note: From version 3.3.0 card supports all native Home Assistant actions and related functionalities: Actions - Home Assistant

KString support in actions: Since v3.3.0, tap actions support KString for dynamic values. This allows you to use entity data (state, attributes, etc.) in action parameters. KString processing happens just before the action is executed, ensuring up-to-date values.

Examples:

# Navigate to device page using device_id from entity attributes
tap_action:
  action: navigate
  navigation_path: "/config/devices/device/{attributes.device_id}"

# Open URL with dynamic content
tap_action:
  action: url
  url_path: "https://example.com/battery-report?level={state}&device={attributes.device_name}"

# Call service with dynamic data
tap_action:
  action: call-service
  service: "notify.mobile_app"
  service_data:
    message: "Low battery alert: {state}%"
    title: "Warning for {attributes.friendly_name}"
    data:
      entity_id: "{entity_id}"
      battery_level: "{state}"

# Use KString functions in actions
tap_action:
  action: call-service
  service: "script.battery_notification"
  data:
    rounded_level: "{state|round(0)}"
    doubled_value: "{state|multiply(2)|round(1)}"

Convert

Bulk rename

Charging-state object

Note: All of these values are optional but at least entity_id or state or attribute is required.

Attribute object

Group object

Group keywords

Group name and secondary_info fields support special keywords that are replaced with aggregated values from the group's entities.

Simple keywords (operate on battery state):

Aggregation functions with custom data path:

You can apply aggregation functions to any entity attribute or data path using the syntax {function(path)}:

The path can be any resolvable data path (e.g. attributes.battery_count). Entities where the path resolves to a missing or non-numeric value are excluded from the aggregation.

Combining with KString processors:

Aggregation results can be piped through KString processors for formatting:

{avg(computed.state)|round(2)}     → "65.55"
{sum(attributes.battery_count)|multiply(2)} → "12"

Example:

type: "custom:battery-state-card"
filter:
  include:
    - name: "attributes.device_class"
      value: battery
group:
  - by: "attributes.battery_type"
    name: "{count} batteries"
    secondary_info: "Need {sum(attributes.battery_count)} replacements, avg level: {avg|round(0)}%"

Examples

You can use this component as a card or as an entity (e.g. in entities card);

Card view

Card view is useful when you want to have cleaner config (you don't need to duplicate settings in every entity entry) and when you want to apply same settings (e.g. colors) for all the battery entities.

type: "custom:battery-state-card"
title: "Battery levels"
entities:
  - sensor.bathroom_motion_battery_level
  - sensor.bedroom_balcony_battery_level
  - entity: "sensor.bedroom_motion_battery_level"
    name: "Bedroom motion sensor"

Entity view

Entity view is useful when you want to add battery status next to other sensors (in the same card).

Note: there is a different type used.

type: entities
title: Other
show_header_toggle: false
entities:
  - sensor.energy_rpi_monthly
  - sensor.home_assistant_v2_db
  - sensor.hassio_online
  - sensor.last_boot
  - type: "custom:battery-state-entity"
    entity: "sensor.temp_outside_battery_numeric"

Custom colors

Custom threshold colors

type: "custom:battery-state-card"
title: "Custom color thresholds"
colors:
  steps:
    - value: 35 # applied to all values below/equal
      color: "#8fffe1"
    - value: 45 # applied to all values below/equal
      color: "#8fbbff"
    - value: 60 # applied to all values below/equal
      color: "#978fff"
    - value: 100 # applied to all values below/equal
      color: "#fe8fff"
entities:
  - entity: "sensor.bathroom_motion_battery_level"
    name: "Bathroom motion sensor"
  - entity: "sensor.bedroom_balcony_battery_level"
    name: "Bedroom balcony door sensor"
  - entity: "sensor.bedroom_motion_battery_level"
    name: "Bedroom motion sensor"
  - entity: "sensor.bedroom_switch_battery_level"
    name: "Bedroom Aqara switch"
  - entity: "sensor.bedroomtemp_battery_level"
    name: "Bedroom temp. sensor"

Gradient colors

type: "custom:battery-state-card"
title: "Color gradient"
colors:
  steps:
    - "#ff0000" # red
    - "#ffff00" # yellow
    - "#00ff00" # green
  gradient: true
entities:
  - entity: "sensor.bathroom_motion_battery_level"
    name: "Bathroom motion sensor"
  - entity: "sensor.bedroom_balcony_battery_level"
    name: "Bedroom balcony door sensor"
  - entity: "sensor.bedroom_motion_battery_level"
    name: "Bedroom motion sensor"
  - entity: "sensor.bedroom_switch_battery_level"
    name: "Bedroom Aqara switch"
  - entity: "sensor.bedroomtemp_battery_level"
    name: "Bedroom temp. sensor"

Disabling colors

When you put empty array in steps property you can disable colors.

type: "custom:battery-state-card"
title: "No color"
colors:
  steps: []
entities:
  - sensor.bedroom_motion_battery_level
  - sensor.bathroom_motion_battery_level
  - sensor.bedroomtemp_battery_level
  - sensor.bedroom_balcony_battery_level
  - sensor.bedroom_switch_battery_level

You can setup as well colors only for lower battery levels and leave the default one for the rest.

type: "custom:battery-state-card"
title: "No color - selective"
colors:
  steps:
    - value: 20
      color: "red"
    - value: 60
      color: "yellow"
entities:
  - sensor.bedroom_motion_battery_level
  - sensor.bathroom_motion_battery_level
  - sensor.bedroomtemp_battery_level
  - sensor.bedroom_balcony_battery_level
  - sensor.bedroom_switch_battery_level

Sorted list and collapsed view

type: "custom:battery-state-card"
title: "Sorted list and collapsed view"
sort: "state"
collapse: 4
entities:
  - sensor.bedroom_motion_battery_level
  - sensor.bathroom_motion_battery_level
  - sensor.bedroomtemp_battery_level
  - sensor.bedroom_balcony_battery_level
  - sensor.bedroom_switch_battery_level

Battery groups

Battery groups allow you to group together set of batteries/entities based on couple conditions. You can use HA group entities to tell which entities should go to the group, or you can set min/max battery levels, or specify explicit list of entities which should be assigned to particular group. You can also use advanced filters (same syntax as the card-level filters) for more flexible group assignment.

Note: If you have battery groups defined in Home Assistant you can use their IDs instead of single entity ID (in entities collection).

type: 'custom:battery-state-card'
title: Battery state card
sort: "state"
collapse:
  - name: 'Door sensors (min: {min}%, count: {count})' # simple keywords in group name
    secondary_info: 'Battery levels {range}%, total: {sum}' # keywords in secondary info
    icon: 'mdi:door'
    entities: # explicit list of entities
      - sensor.bedroom_balcony_battery_level
      - sensor.main_door_battery_level
      - sensor.living_room_balcony_battery_level
  - group_id: "group.motion_sensors_batteries" # using HA group
    secondary_info: No icon # Secondary info text
    icon: null # removing default icon for this group (from HA group definition)
  - group_id: "group.temp_sensors_batteries"
    min: 99 # all entities below that level should show up as ungrouped
    icon: 'mdi:thermometer' # override for HA group icon
entities:
  # if you need to specify some properties for any entity in the group
  - entity: "sensor.bedroom_balcony_battery_level"
    name: "Bedroom balcony door"
    multiplier: 10
  # entities from below HA group won't be grouped as there is no corresponding collapsed group
  - group.switches_batteries

Using filters in groups

You can use advanced filters instead of min/max for more flexible group assignment. The filters use the same syntax as the card-level filters, including support for composite filters (and, or, not). All filters must match for a battery to be assigned to the group.

Note: The order of groups matters. Each battery is assigned to the first group whose filters match. If a battery meets the conditions of multiple groups it will only appear in the earliest matching one.

type: 'custom:battery-state-card'
title: Battery groups with filters
sort: "state"
filter:
  include:
    - name: "attributes.device_class"
      value: battery
collapse:
  - name: "Office critical ({count})"
    icon: 'mdi:battery-alert'
    filter:
      - name: state
        operator: "<"
        value: 20
      - name: "area.name"
        value: Office
  - name: "Low ({count})"
    icon: 'mdi:battery-low'
    filter:
      - name: state
        operator: "<"
        value: 20
  - name: "OK ({count})"
    icon: 'mdi:battery'
    filter:
      - not:
          name: state
          operator: "<"
          value: 20

Dynamic grouping with by

Instead of defining groups manually, you can use the by property to automatically create groups based on an entity data property. Each unique value of the property becomes a separate group. Entities where the value is missing, null, or empty stay ungrouped.

Note: When using dot-notation paths (e.g. attributes.battery_type or area.name), always wrap the value in quotes in YAML to prevent it from being interpreted as a nested key.

Group by area:

type: "custom:battery-state-card"
filter:
  include:
    - name: "attributes.device_class"
      value: battery
group:
  - by: "area.name"
    icon: "{area.icon}"

Group by battery type (Battery Notes):

type: "custom:battery-state-card"
secondary_info: "{attributes.battery_type}"
filter:
  include:
    - name: "attributes.device_class"
      value: battery
collapse:
  - by: "attributes.battery_type"
    icon: "mdi:battery-alert"
    icon_color: red
    filter:
      - name: state
        operator: "<"
        value: 50
  - by: "area.name"

Group by area, excluding charging batteries:

type: "custom:battery-state-card"
filter:
  include:
    - name: "attributes.device_class"
      value: battery
group:
  - by: "area.name"
    secondary_info: "Devices: {count}, {min}-{max}%"
    filter:
      - name: "charging.is_active"
        value: false

Non-numeric state values

If your sensor doesn't produce numeric values you can use state_map property and provide mappings from one value to the other.

type: "custom:battery-state-card"
title: "String values - state map"
entities:
  - entity: "binary_sensor.battery_state"
    name: "Binary sensor state"
    state_map:
      - from: "on"
        to: 100
      - from: "off"
        to: 25
  - entity: "sensor.bedroom_motion"
    name: "Sensor string attribute"
    attribute: "replace_battery"
    state_map:
      - from: false
        to: 100
      - from: true
        to: 25

Charging state indicators

If your device provides charging state you can configure it in the following way:

type: "custom:battery-state-card"
title: "Charging indicators"
entities:
  - entity: "sensor.device_battery_numeric"
    charging_state: # uses other entity state value
      entity_id: "binary_sensor.device_charging"
      state: "on"
  - entity: "sensor.mi_roborock"
    charging_state: # uses sensor.mi_roborock state value
      state: "charging"
      icon: "mdi:flash"
      color: "yellow"
  - entity: "sensor.samsung"
    charging_state: # uses is_charging attribute on sensor.samsung entity
      attribute:
        name: "is_charging"
        value: "yes"

Card-level charging state configuration

type: "custom:battery-state-card"
title: "Charging indicators"
charging_state:
  attribute: # whenever one of below attributes is matching
    - name: "Battery State"
      value: "Charging"
    - name: "is_charging"
      value: true
  state: # or if entity state matches one of the following
    - "charging"
    - "Charging"
entities:
  - sensor.device_battery_numeric
  - sensor.mi_roborock
  - sensor.samsung

Entity filtering and bulk renaming

If you want to add battery entities automatically or if you want to see them only in specific conditions you can use filters.

If you add entities automatically you cannot specify properties for individual entities. It is possible though to specify card-level properties which will be applied to all entities (see common options). For example if you wanted to set custom names (e.g. if your sensors are suffixed with some common string) you can use bulk_rename property to define renaming rules.

type: 'custom:battery-state-card'
title: Filters
sort: "state"
bulk_rename:
  - from: "Battery Level" # simple string replace (note: "to" is not required if you want to remove string)
    to: "sensor"
  - from: "/\\s(temperature|temp)\\s/" # regular expression
    to: " temp. "
entities:
  # entities requiring additional properties can be added explicitly
  - entity: "sensor.temp_outside_battery_numeric"
    multiplier: 10
    name: "Outside temp. sensor"
filter:
  include: # filters for auto-adding
    - name: entity_id # entities which id ends with "_battery_level"
      value: "*_battery_level"
    - name: "attributes.device_class" # and entities which device_class attribute equals "battery"
      value: battery
  exclude: # filters for removing
    - name: state # exclude entities above 99% of battery level
      value: 99
      operator: ">"

Bulk rename using BulkRename object to disable capitalizing the first letter of entity name (enabled by default)

type: 'custom:battery-state-card'
title: Filters
sort: "state"
bulk_rename:
  rules:
    - from: "Battery Level" # simple string replace (note: "to" is not required if you want to remove string)
      to: "sensor"
    - from: "/\\s(temperature|temp)\\s/" # regular expression
      to: " temp. "
  capitalize_first: false
filter:
  include: # filters for auto-adding
    - name: entity_id # entities which id ends with "_battery_level"
      value: "*_battery_level"
    - name: "attributes.device_class" # and entities which device_class attribute equals "battery"
      value: battery

Secondary info

type: "custom:battery-state-card"
name: Secondary info
secondary_info: "{last_updated}" # applied to all entities which don't have the override
entities:
  - entity: "sensor.bedroom_motion_battery_level"
    name: "Bedroom motion sensor"
  - entity: "sensor.mi_roborock"
    secondary_info: "{charging.text}" # only appears when charging is detected
    charging_state:
      attribute:
        name: "is_charging"
        value: true
      secondary_info_text: "Charging at {state}%" # supports KString - shows current battery level
  - entity: "sensor.jacks_motorola"
    name: "Jack's phone"
    secondary_info: "Motorola" # Static text

Tap actions

type: 'custom:battery-state-card'name: Click
colors:
  steps:
    - '#ff0000'
    - '#0000ff'
    - '#00ff00'
  gradient: true
entities:
  - entity: "sensor.bedroom_motion_battery_level"
    name: More info
    tap_action: more-info
    value_override: 100
  - entity: "sensor.bathroom_motion_battery_level"
    name: Navigation path
    tap_action:
      action: navigate
      navigation_path: /lovelace/1
    value_override: 0
  - entity: "sensor.bedroomtemp_battery_level"
    name: Call service - Pushover
    tap_action:
      action: call-service
      service: "notify.pushover"
      service_data:
        message: Call service works
        title: Some title
    value_override: 60
  - entity: "sensor.bedroom_balcony_battery_level"
    name: Url
    tap_action:
      action: url
      url_path: 'http://reddit.com'
    value_override: 20
  - entity: "sensor.bedroom_switch_battery_level"
    name: No action
    value_override: 80

Using Themes

You can apply any Home Assistant theme to the card using the theme property. The card will apply the theme's CSS variables to match your Home Assistant theme.

type: "custom:battery-state-card"
theme: slate  # Apply the "slate" theme
entities:
  - sensor.bedroom_motion_battery_level
  - sensor.bathroom_motion_battery_level

Light/Dark Mode Support: The card automatically detects if your theme has separate light and dark modes and applies the appropriate mode based on Home Assistant's dark mode setting.

Custom styles

You can use the style property to inject custom CSS rules into the component's shadow DOM. This allows you to target inner HTML elements like .name, .state, .icon, ha-card, etc.

Card-level custom styles

type: "custom:battery-state-card"
style: |
  ha-card {
    background: #1E1E1E;
  }
  .name {
    font-weight: bold;
  }
entities:
  - sensor.bedroom_motion_battery_level
  - sensor.bathroom_motion_battery_level

You can also use CSS variables to customize the look:

type: "custom:battery-state-card"
style: ":host { --ha-card-background: #1E1E1E; --primary-text-color: #E0E0E0; }"
entities:
  - sensor.bedroom_motion_battery_level

Per-entity custom styles

Since style is a common option, it can be set per-entity to style individual battery elements:

type: "custom:battery-state-card"
title: "Custom styled entities"
entities:
  - entity: "sensor.bedroom_battery"
    style: ".name { color: red; }"
  - sensor.bathroom_battery  # no custom style

Combining with themes

You can combine style with theme. Theme CSS variables are applied as inline styles on the host element, while custom style rules are injected into the shadow DOM — so both work independently:

type: "custom:battery-state-card"
theme: slate
style: |
  :host { --primary-color: #ff5722; }
  .name { font-style: italic; }
entities:
  - sensor.bedroom_motion_battery_level

Unpacking grouped entities

Some entities (e.g. sensor groups or template sensors) contain an entity_id attribute with a list of other entity IDs. You can unpack these into separate battery entries.

Entities in the group domain are always unpacked automatically. For entities in other domains (e.g. sensor) you can enable unpacking either per-entity or at the card level.

Per-entity unpack

Use unpack: true on a specific entity to unpack only that one:

type: "custom:battery-state-card"
title: "Sensor group batteries"
entities:
  - entity: "sensor.battery_group"
    unpack: true
  - sensor.some_other_battery # this one is shown as-is

Card-level unpack

Use unpack: true at the card level to automatically unpack all entities that have an entity_id array attribute:

type: "custom:battery-state-card"
title: "Auto-unpack all groups"
unpack: true
filter:
  include:
    - name: "attributes.device_class"
      value: battery

Note: When card-level unpack is enabled, any entity (regardless of domain) whose entity_id attribute is an array will be replaced by its child entities. Entities without an entity_id array attribute are unaffected.

Other use cases

Signal strength

type: "custom:battery-state-card"
secondary_info: "{last_changed}"
icon: >-
  mdi:signal-cellular-{state|abs()|greaterthan(80,outline)|greaterthan(75,1)|greaterthan(60,2)|greaterthan(2,3)}
filter:
  include:
    - name: "attributes.device_class"
      value: signal_strength
collapse: 7
sort: state
bulk_rename:
  - from: " Signal"
  - from: " signal"
  - from: " Strength"
  - from: " strength"
  - from: " RSSI"
  - from: " numeric"
colors:
  steps:
    - color: "#ff0000"
      value: -90
    - color: "#ffff00"
      value: -80
    - color: "#00ff00"
      value: -50
  gradient: true

HDD temperatures

type: "custom:battery-state-card"
title: HDD temperatures
icon: "mdi:harddisk"
colors:
  steps:
    - value: 26
      color: blue
    - value: 36
      color: green
    - value: 45
      color: yellow
    - value: 60
      color: red
tap_action:
  action: more-info
collapse: 3
sort:
  by: state
  desc: true
unit: °C
round: 0
filter:
  include:
    - name: entity_id
      value: "sensor.nasos_sd*"
    - name: entity_id
      value: "sensor.omv2_sd*"
    - name: entity_id
      value: "sensor.exnas_st12*temper*"
    - name: entity_id
      value: "sensor.*_disk_*_temperature"
entities:
  - entity: "sensor.vidik_temperature"
  - entity: "sensor.exnas_d1_temperatures_temperature"

Motion sensors (sorted by state and last changed property)

type: "custom:battery-state-card"
secondary_info: '{last_changed}'
icon: '{state|equals(off,mdi:motion-sensor-off)|equals(on,mdi:motion-sensor)}'
filter:
  include:
    - name: "attributes.device_class"
      value: motion
sort:
  - by: state
    desc: true
  - by: "entity.last_changed"
    desc: true
colors:
  steps:
    - value: 0
      color: inherit
    - value: 1
      color: var(--state-active-color)
unit: null
state_map:
  - from: 'off'
    to: 0
    display: Clear
  - from: 'on'
    to: 1
    display: Detected
collapse: 8

Using default entity icons

If your entities already have appropriate icons defined and you want to keep them instead of using battery icons, set icon to null:

type: "custom:battery-state-card"
title: "Devices with original icons"
entities:
  - entity: "sensor.phone_battery"
    icon: null
  - entity: "sensor.tablet_battery"
    icon: null
  - entity: "sensor.watch_battery"
    icon: null

You can also apply it to all entities using common options:

type: "custom:battery-state-card"
title: "Devices with original icons"
icon: null  # Apply to all entities
filter:
  include:
    - name: entity_id
      value: "*_battery"

Default configuration to work with the "Battery Notes" integration

The "HA-Battery_Notes HACS integration automatically adds additional information about all battery devices within your HA implementation, such as battery types, etc. The Configuration below automatically creates a table for all Battery Plus devices and shows the required type and number of devices.

type: "custom:battery-state-card"
secondary_info: "{attributes.battery_type_and_quantity}"
filter:
  include:
    - name: entity_id
      value: "*battery_plus"
  exclude:
    - name: entity_id
      value: "binary_sensor.*"
sort:
  by: state
  desc: true
bulk_rename:
  - from: " Battery"
  - from: " level"
colors:
  steps:
    - "#ff0000"
    - "#ffff00"
    - "#00ff00"
  gradient: true

Battery Notes

This card has built-in support for the Battery Notes integration. Battery Notes is a popular HACS integration that adds additional information about battery devices, such as battery type and quantity.

When Battery Notes is installed it creates additional entities for each device (on the battery_notes platform). The card automatically deduplicates these entities: when both the original battery entity and the Battery Notes "battery plus" entity (with state_class: measurement) are present, the card keeps only the battery plus entity, which has the most up-to-date state and extra attributes like battery_type.

This deduplication is enabled by default. If you want to keep all entities (including duplicates), disable it:

type: "custom:battery-state-card"
battery_notes_dedup: false

With deduplication active, Battery Notes attributes are available directly on the entity. You can reference them in secondary_info:

type: "custom:battery-state-card"
secondary_info: "{attributes.battery_type}"
filter:
  include:
    - name: "attributes.device_class"
      value: battery

You can also group batteries by battery type using the by property in group config:

type: "custom:battery-state-card"
secondary_info: "{attributes.battery_type}"
filter:
  include:
    - name: "attributes.device_class"
      value: battery
sort:
  by: state
collapse:
  - by: "attributes.battery_type"

Installation

Once added to HACS add the following resource to your lovelace configuration (if you have yaml mode active)

lovelace:
  mode: yaml
  resources:
    - url: "/hacsfiles/battery-state-card/battery-state-card.js"
      type: module

If you don't have HACS you can download js file from latest release. Drop it then in www folder in your config directory. Next add the following entry in lovelace configuration

resources:
  - url: "/local/battery-state-card.js"
    type: module

Troubleshooting

You can turn on the debug output via debug setting. It can be turned on for all of the entities:

debug: true

Or single entity by specifying entity_id:

debug: "sensor.owl_energy_signal_strength"

Note: "Copy to clipboard" is available only if you access your HA via https.

After clicking on show/hide you will see the entity data which is available for the card to process.

{
  "entity_id": "sensor.owl_energy_signal_strength",
  "state": "-72",
  "attributes": {
    "state_class": "measurement",
    "event": "115a011a32e20100000172000031bbc85d69",
    "unit_of_measurement": "dBm",
    "assumed_state": true,
    "device_class": "signal_strength",
    "friendly_name": "Owl energy Signal strength"
  },
  "context": {
    "id": "01HPC8X76DDZ4D3XK5BMH8KKFW",
    "parent_id": null,
    "user_id": null
  },
  "last_changed": "2024-02-11T14:24:59.597Z",
  "last_updated": "2024-02-11T14:24:59.597Z",
  "entity": {
    "entity_id": "sensor.owl_energy_signal_strength",
    "device_id": "91b4ffe9a73db4d1ee9482d0e7d94a84",
    "platform": "rfxtrx",
    "entity_category": "diagnostic",
    "name": "Signal strength"
  },
  "device": {
    "area_id": "outside",
    "configuration_url": null,
    "config_entries": [
      "2c67d4fe27613df1b3de59a1f042dc5c"
    ],
    "connections": [],
    "disabled_by": null,
    "entry_type": null,
    "hw_version": null,
    "id": "91b4ffe9a73db4d1ee9482d0e7d94a84",
    "identifiers": [
      [
        "rfxtrx",
        "5a",
        "1",
        "32:e2"
      ]
    ],
    "manufacturer": null,
    "model": "ELEC2, CM119/160",
    "name_by_user": "Owl energy",
    "name": "ELEC2, CM119/160 32:e2",
    "serial_number": null,
    "sw_version": null,
    "via_device_id": null
  },
  "area": {
    "aliases": [],
    "area_id": "outside",
    "name": "Outside",
    "picture": null
  }
}

When you look at the entity data you can for example figure out what you can display using KString e.g. Area: {area.name}, Device: {device.name_by_user}

Development

npm install
npm run build

npm run watch

lovelace:
  resources:
    - url: "http://127.0.0.1:5501/dist/battery-state-card.js"
      type: module

npm run test

npm run test+coverage

Do you like the card?

If you do like the card please star it on GitHub!

If you want to show your support please

Thanks!

If you think that I deserve

License

This project is under the MIT license.

Automatic notifications about low battery levels

It is not possible to do such a thing from the card level. If you want to get automatic notifications/alerts you can use the blueprint shared by sbyx:

https://my.home-assistant.io/create-link/?redirect=blueprint_import&blueprint_url=https%3A%2F%2Fgist.github.com%2Fsbyx%2F1f6f434f0903b872b84c4302637d0890

Click on "copy url" button and paste it in your browser. If you have configured my.home-assistant.io already you should be redirected to the page in your HA where you can review the blueprint code and add it. Once you add it you can create automation based on it.

My other HA related repos

github-flexi-card | homeassistant-config | lovelace-card-boilerplate