Home Assistant Blueprints

Aivi provides a set of Home Assistant blueprints that help you connect Home Assistant devices and automations to Live Activities. They handle the “plumbing” - watching entities for changes and calling rest_command.update_live_activity with the right payload - so you can get a working Live Activity in a few clicks.

Prerequisites

These blueprints call rest_command.update_live_activity, which you need to add to your Home Assistant configuration.

1. Open your Home Assistant configuration.yaml.

2. Add the rest_command below:

   rest_command:
     update_live_activity:
       url: 'https://api.getaivi.app/activity/{{ slug }}'
       method: PATCH
       headers:
         content-type: application/json
         authorization: Token [token]
       payload: '{{ payload }}'

   Note

   Replace [token] with your Aivi API token.

3. Reload your Home Assistant configuration.

Versioning

Blueprints are versioned using a suffix like -v1 (for example, timer-v1).

• Stability: Updates within the same major version (e.g. v1) are intended to be backwards compatible.
• Breaking changes: If we need to change inputs or behavior in a breaking way, we’ll publish a new major version (e.g. -v2) alongside the old one so existing automations keep working.
• Upgrades: To move to a new major version, import the newer blueprint and reselect your entities/inputs in the automation editor (Home Assistant does not auto-migrate blueprint input mappings across breaking changes).

Available blueprints

Below you will find the documentation for the available blueprints.

Progress — Simple (from sensors)

Version v1

Drives a simple progress bar from sensors. Use this when your device exposes:

• A binary “running” entity (on/off)
• A progress sensor (0–100)
• Optionally, an ETA sensor (timestamp or duration) and/or a human-readable state sensor (“Washing”, “Drying”, …)

Progress — Segmented (from sensors)

Version v1

Drives a segmented progress bar from sensors. Same inputs as the simple blueprint, but lets you define up to 4 labeled segments with individual colors, track patterns, and a display mode (split or layered).

Progress — Timer (from a timer helper)

Version v1

Drives a simple progress bar from a Home Assistant timer. Automatically synchronizes the Live Activity state with the timer’s progress, and supports pausing, resuming, and cancelling.

Monitor

Version v1

Use this when you want to drive the Monitor template from sensors or templates. It supports optional headers/footers, custom value colors, formatters, and per-column visibility conditions, with an optional set of custom triggers for templated fields.

Legacy blueprints

These blueprints drive the legacy Generic template. They continue to work, but we recommend using the Progress blueprints above for new automations.

Generic — Progress + ETA (from sensors)

Version v1

Drives the legacy Generic template from sensors. See Progress — Simple for the recommended replacement.

Generic — Timer (from a timer helper)

Version v1

Drives the legacy Generic template from a timer helper. See Progress — Timer for the recommended replacement.

Source code

The source code for all blueprints is available on GitHub at getaivi/ha-blueprints.