Tater Assistant logo Tater Assistant Source-backed docs
Portal profile

Home Assistant

Voice and text assistant endpoint for Home Assistant Assist, paired with the Tater Conversation Agent integration plus direct smart-home control and a built-in notifications API that can queue alerts and light configured Voice PE indicators.

Voice and smart-home endpoint v1.0.1 12 settings 52 Verbas
Runtime role

What this surface is for

Voice and smart-home endpoint

Highlights

Behavior in the current codebase

  • Designed for Assist pipeline conversations and direct smart-home control.
  • Includes session history, follow-up mic behavior, satellite lookup caching, and notification bridging.
  • Pairs with the Tater Conversation Agent HACS integration, which points Home Assistant Assist at /tater-ha/v1/message and forwards device and area context.
  • Ships with a built-in notifications API that queues notification payloads in Redis and can light configured Voice PE indicators when new notifications arrive.
  • Awareness automations now live in Awareness Core instead of a separate automation bridge surface.
  • Supports optional API key protection for HTTP endpoints using X-Tater-Token.
Settings

Configuration schema

  • Require API Key select

    Require X-Tater-Token on all Home Assistant portal API endpoints.

    Key: API_AUTH_ENABLED Default: false Options: true, false
  • API Key password

    Shared API key expected in the X-Tater-Token header when auth is enabled.

    Key: API_AUTH_KEY
  • Continued chat (auto re-open mic) select

    If enabled, Tater automatically re-opens the Assist satellite mic when it ends with a question.

    Key: CONTINUED_CHAT_ENABLED Default: false Options: true, false
  • Follow-up idle wait (seconds) number

    How long to wait for the satellite to return to idle before re-opening the mic.

    Key: FOLLOWUP_IDLE_TIMEOUT_S Default: 12
  • Assist satellite map cache TTL (seconds) number

    How long to cache the area→assist_satellite mapping (registry lookups).

    Key: SATELLITE_MAP_CACHE_TTL_S Default: 3600
  • Session TTL select

    How long to keep a voice session’s history alive (5m–24h).

    Key: SESSION_TTL_SECONDS Default: 2h Options: 5m, 30m, 1h, 2h, 6h, 24h
  • Voice PE entity #1 string

    Entity ID of a Voice PE light/LED (e.g., light.voice_pe_office)

    Key: VOICE_PE_ENTITY_1
  • Voice PE entity #2 string

    Entity ID of a Voice PE light/LED (e.g., light.voice_pe_office)

    Key: VOICE_PE_ENTITY_2
  • Voice PE entity #3 string

    Entity ID of a Voice PE light/LED (e.g., light.voice_pe_office)

    Key: VOICE_PE_ENTITY_3
  • Voice PE entity #4 string

    Entity ID of a Voice PE light/LED (e.g., light.voice_pe_office)

    Key: VOICE_PE_ENTITY_4
  • Voice PE entity #5 string

    Entity ID of a Voice PE light/LED (e.g., light.voice_pe_office)

    Key: VOICE_PE_ENTITY_5
  • Bind Port number

    TCP port for the Tater ↔ HA bridge

    Key: bind_port Default: 8787
Companion setup

Home Assistant integrations that connect to this portal.

This component lives inside Home Assistant and points Assist conversations back at Tater's runtime bridge.

HACS integrationAssist pipelinePort 8787

Tater Conversation Agent

HACS conversation integration that makes Tater selectable as a Home Assistant Assist conversation agent.

  • Install the Tater-HomeAssistant repository through HACS as an Integration, then add Tater Conversation in Devices & Services.
  • The config flow asks for host/IP, port, and an optional API key (when the Home Assistant portal has API auth enabled).
  • After setup, choose Tater Conversation as the conversation agent in Settings -> Voice Assistants.
  • The component forwards text plus user, device, area, session, and language context so Tater can keep room-aware and device-aware sessions.
Tater-HomeAssistant Repo
Built-in APIs

HTTP endpoints exposed by this portal.

API auth

When API auth is enabled, requests must include X-Tater-Token with the configured portal API key.

GET /tater-ha/v1/health

Basic health endpoint for the Home Assistant bridge.

Returns bridge status and version 2.0 so Home Assistant or external checks can confirm the service is up.

POST /tater-ha/v1/notifications/add

Queue a Home Assistant-facing notification item.

Accepts source, title, type, message, entity_id, ha_time, level, and data, stores the item in Redis, attempts to turn on configured Voice PE light entities, and enforces X-Tater-Token when API auth is enabled.

GET /tater-ha/v1/notifications

Pull and clear queued notifications.

Reads queued notifications from Redis, clears the list after delivery, turns Voice PE indicators off once notifications are consumed (or immediately if none are present), and enforces X-Tater-Token when API auth is enabled.

POST /tater-ha/v1/message

Main Assist/chat message endpoint.

Receives Home Assistant conversation requests, preserves stable session context, and runs Hydra turns with Home Assistant-scoped system prompting and plugin gating.

Back to portals Verbas Portals Cores Home