Skip to content

Generic Template

A flexible progress-based template suitable for builds, downloads, deployments, and any long-running task.

Fields

FieldTypeDescription
templatestringRequired. Must be "generic"
progressfloatRequired. Value between 0.0 and 1.0
statestringShort status text (e.g. "Building...", "Complete")
iconstringSF Symbol name (e.g. "arrow.triangle.branch", "washer") or MDI icon with mdi: prefix (e.g. "mdi:washing-machine", "mdi:thermometer")
remaining_timeintegerRemaining time in seconds
subtitlestringSecondary text below the progress bar
accent_colorstringNamed color or hex (e.g. "cyan", "#00BCD4")
background_colorstringBackground color override
text_colorstringText color override

Example Payload

Start a generic activity
{
  "state": "ongoing",
  "content": {
    "template": "generic",
    "progress": 0.65,
    "state": "Washing",
    "icon": "washer",
    "remaining_time": 1800,
    "subtitle": "Cycle 2 of 3",
    "accent_color": "blue"
  }
}

Typical Flow

  1. Start (ended -> ongoing): Set progress: 0.0 with an initial status
  2. Update (ongoing -> ongoing): Increment progress, change status text
  3. End (ongoing -> ended): Set progress: 1.0 with a completion status

Buttons & tap targets

Renders url_action and secondary_url_action as buttons beneath the progress bar, and treats taps on the rest of the widget as tap_action. Buttons appear only when their action is present. See Tap actions for the action object shape.

💡 Tip

The progress percentage is displayed in the top-right corner of the Live Activity. Use remaining_time to show a countdown alongside the progress bar.

Integrations Using This Template

  • SABnzbd — tracks download progress with speed and ETA
  • Bambu Lab — tracks 3D print progress with layer counts and temperature
  • Home Assistant — default template for entity state tracking