homeassistant

name: homeassistant description: Guide for interacting with Home Assistant via the HA plugin tools

Home Assistant Integration

You have access to Home Assistant tools for querying and controlling smart home devices.

Three-Tier Access Model

• Default: All entities are readable, none are watched, none are writable.
• Entity output always includes entity_id for precise reference.

Available Tools

ha_states

Query entity states. All readable (non-blocked) entities accessible.

• domain: filter by domain (e.g. "sensor", "light")
• entity_id: get a specific entity
• pattern: glob pattern (e.g. "sensor.living_room_*")

ha_call_service

Control a device. Requires domain to be in writableDomains.

• domain: e.g. "light"
• service: e.g. "turn_on", "turn_off", "toggle"
• entity_id: target entity
• data: optional extra data (brightness, temperature, etc.)

ha_logbook

Read historical events.

• start_time: ISO 8601 (required)
• end_time: ISO 8601 (optional)
• entity_id: filter to one entity (recommended)

ha_context_config

Adjust which entities are auto-injected into your context.

• action: "get", "set", "add_watch", "remove_watch"
• watched_entities: glob patterns for entities to watch
• enabled: enable/disable auto-injection
• max_entities: cap for context injection
• group_by_area: group entities by area

ha_listen

Manage event listeners — monitor entity state changes and trigger agent actions automatically.

• action: "add", "list", "remove"
• entity_id: entity to listen to (e.g. "light.bedroom"). Required for "add".
• to_state: only trigger when entity changes TO this state (e.g. "on"). Optional.
• from_state: only trigger when entity changes FROM this state. Optional.
• message: the task to execute when the listener fires. Required for "add".
• one_shot: if true (default), listener is removed after firing once. If false, it fires every time.
  • Decide based on user intent: "when X happens, do Y" → one-shot. "whenever X happens, always do Y" → recurring.
• listener_id: ID of the listener to remove. Required for "remove".

Example usage: User says "当卧室的灯开了的时候，帮我提交 git"

1. Use ha_states to find the entity ID for the bedroom light
2. Call ha_listen with action: "add", entity_id: "light.bedroom", to_state: "on", message: "帮我提交 git", one_shot: true

The listener service connects to HA via WebSocket and monitors state_changed events in real-time. When a match occurs, the message is injected into the agent's next prompt.

Bootstrap Flow

When the user first asks about their smart home and HA is not configured:

1. Ask for URL + Token: "I need your Home Assistant URL (e.g. http://ha.local:8123) and a Long-Lived Access Token. You can create one in HA → Profile → Long-Lived Access Tokens."
2. Guide config: Tell them to run:

   openclaw config set plugins.entries.homeassistant-for-openclaw.config.url "http://..."
   openclaw config set plugins.entries.homeassistant-for-openclaw.config.token "..."
   

3. Discover entities: Use ha_states to survey what's available.
4. Suggest watched entities: "I found sensors in your living room and bedroom. Want me to add these to your watched entities so I always know the status?"
5. Suggest writable domains: "Want me to be able to control lights and switches? You'd need to add them to writableDomains."

Safety Rules

1. Always confirm before calling services that could affect security (locks, alarms, garage doors)
2. Describe what you'll do before calling any service
3. Never guess entity IDs — always query first with ha_states
4. If a service call fails with an ACL error, explain to the user how to grant access