Triggers¶

Battery Low¶

battery_notes.battery_became_low

The Battery became low trigger is available under Battery Notes in the automation editor. It listens to the Battery Threshold event and fires when battery_low is true, according to the selected event types below.

The trigger uses the battery note's existing low-state detection, including its device-specific or global threshold, battery low template, or binary battery source.

Event Types¶

Use the Event types option in the automation editor, or options.event_types in YAML, to choose which low battery events trigger the automation:

This field is required and defaults to All if not specified.

The Check Battery Low action raises a reminder for each low battery note when raise_events is true (default). To send regular reminders, schedule that action in a separate automation.

Trigger Variables¶

Battery Low Automation Example¶

alias: Battery Low
mode: queued
triggers:
  - trigger: battery_notes.battery_became_low
    options:
      event_types: all
actions:
  - action: persistent_notification.create
    data:
      title: "{{ trigger.device_name }} Battery Low"
      message: "You need {{ trigger.battery_type_and_quantity }} batteries"
      notification_id: "{{ trigger.device_id }}-{{ trigger.source_entity_id }}"

Battery No Longer Low¶

battery_notes.battery_no_longer_low

The Battery no longer low trigger listens to the Battery Threshold event and fires when battery_low is false. For percentage sources, this happens when the battery returns to or above its effective low threshold. Binary and low-template sources trigger when their low state becomes false.

Trigger Variables¶

Recovery Automation Example¶

This dismisses a notification identified by the source device and entity IDs:

alias: Battery No Longer Low
mode: queued
triggers:
  - trigger: battery_notes.battery_no_longer_low
actions:
  - action: persistent_notification.dismiss
    data:
      notification_id: "{{ trigger.device_id }}-{{ trigger.source_entity_id }}"

Battery Was Not Reported¶

battery_notes.battery_was_not_reported

The Battery was not reported trigger listens to the Battery Not Reported event raised by the Check Battery Last Reported action. The action raises an event for each eligible battery note whose last report is older than days_last_reported, or which has never reported.

Call or schedule battery_notes.check_battery_last_reported with raise_events enabled (default) to fire this trigger.

mode: queued
triggers:
  - trigger: battery_notes.battery_was_not_reported

Trigger Variables¶

Battery Was Not Replaced¶

battery_notes.battery_was_not_replaced

The Battery was not replaced trigger listens to the Battery Not Replaced event raised by the Check Battery Last Replaced action. The action raises an event for each eligible battery note whose replacement date is older than days_last_replaced.

Call or schedule battery_notes.check_battery_last_replaced with raise_events enabled (default) to fire this trigger.

mode: queued
triggers:
  - trigger: battery_notes.battery_was_not_replaced

Trigger Variables¶

Scheduling the Check Actions¶

This example runs both checks each morning. Their events fire matching automations listening for overdue reports or replacements. The checks can raise an event for each qualifying battery note on every run.

alias: Check Battery Reports and Replacements
triggers:
  - trigger: time
    at: "09:00:00"
actions:
  - action: battery_notes.check_battery_last_reported
    data:
      days_last_reported: 7
      raise_events: true
  - action: battery_notes.check_battery_last_replaced
    data:
      days_last_replaced: 365
      raise_events: true

Battery Has Increased¶

battery_notes.battery_has_increased

The Battery has increased trigger listens to the Battery Increased event. For percentage sources, it fires when the new level is at least the previous level plus the battery note's effective increase threshold. The global default is 25 percentage points; a per-note threshold of 0 uses the global setting. The trigger does not set a separate threshold.

Binary battery sources and low battery templates also raise an increased event when their low state becomes healthy, with nominal levels of 100 and 0 for the current and previous levels.

Trigger Variables¶

The trigger does not automatically update the replacement date. To record an increase as a battery replacement, connect it to Set Battery Replaced:

alias: Record Battery Replacement After Increase
mode: queued
triggers:
  - trigger: battery_notes.battery_has_increased
actions:
  - action: battery_notes.set_battery_replaced
    data:
      device_id: "{{ trigger.device_id }}"
      source_entity_id: "{{ trigger.source_entity_id }}"

Battery Was Replaced¶

battery_notes.battery_was_replaced

The Battery was replaced trigger is available under Battery Notes in the automation editor. It fires when a battery is marked as replaced by the replacement button or the Set Battery Replaced action, at the same time as the Battery Replaced event.

Trigger Variables¶

Automation Example¶

alias: Battery Replaced
mode: queued
triggers:
  - trigger: battery_notes.battery_was_replaced
actions:
  - action: persistent_notification.create
    data:
      title: "{{ trigger.device_name }} Battery Replaced"
      message: "You just used {{ trigger.battery_type_and_quantity }} batteries"