Academy → Messaging ChannelsOfficial documentation · Arabic guidance

Home Assistant

الربط مع Home Assistant

Intermediate6 min readLesson 54 questions✓ 2026-08-18
Before you read

What this page is, and what it holds.

This page covers Home Assistant. It carries a source warning and takes about 6 minutes to read. Open the channel to yourself first with an allowlist. An open channel means anyone can message your agent.

6sections
12code examples
2tables
1commands
1,043source words
The official one-line description

Control your smart home with Hermes Agent via Home Assistant integration.

What you will be able to do

Outcomes taken from this page, not a template.

  • Understand what بوابة المراسلة is and when you need it.
  • Run hermes gateway and understand what happens next.
  • Read the table and take only the row that applies to you.
  • Set HASS_TOKEN in the right place.
Identifiers you will meet

Exactly as they appear in Hermes.

Commands
  • hermes gateway
Environment variables
  • HASS_TOKEN
  • HASS_URL
Page map

Jump to the part you need.

  1. 01Setup
  2. 02Available Tools
  3. 03Gateway Platform: Real-Time Events
  4. 04Security
  5. 05Example Automations
  6. 06Troubleshooting
The full official page

Nothing summarised away.

The documentation body below is reproduced from the official source so commands and identifiers stay exact. Each section carries a short note describing what it contains.

Hermes Agent integrates with Home Assistant ↗ in two ways:

  1. Gateway platform — subscribes to real-time state changes via WebSocket and responds to events
  2. Smart home tools — four LLM-callable tools for querying and controlling devices via the REST API

Setup

Ordered, practical steps. Run one and confirm it worked before moving on. Commands here: hermes gateway.

1. Create a Long-Lived Access Token

  1. Open your Home Assistant instance
  2. Go to your Profile (click your name in the sidebar)
  3. Scroll to Long-Lived Access Tokens
  4. Click Create Token, give it a name like "Hermes Agent"
  5. Copy the token

2. Configure Environment Variables

Shell7 lines
# Add to ~/.hermes/.env

# Required: your Long-Lived Access Token
HASS_TOKEN=your-long-lived-access-token

# Optional: HA URL (default: http://homeassistant.local:8123)
HASS_URL=http://192.168.1.100:8123

3. Start the Gateway

Shell1 line
hermes gateway

Home Assistant will appear as a connected platform alongside any other messaging platforms (Telegram, Discord, etc.).

Available Tools

Explains the idea itself. Read it slowly; the later sections build on it.

Hermes Agent registers four tools for smart home control:

halistentities

List Home Assistant entities, optionally filtered by domain or area.

Parameters:

  • domain (optional) — Filter by entity domain: light, switch, climate, sensor, binary_sensor, cover, fan, media_player, etc.
  • area (optional) — Filter by area/room name (matches against friendly names): living room, kitchen, bedroom, etc.

Example:

Text1 line
List all lights in the living room

Returns entity IDs, states, and friendly names.

hagetstate

Get detailed state of a single entity, including all attributes (brightness, color, temperature setpoint, sensor readings, etc.).

Parameters:

  • entity_id (required) — The entity to query, e.g., light.living_room, climate.thermostat, sensor.temperature

Example:

Text1 line
What's the current state of climate.thermostat?

Returns: state, all attributes, last changed/updated timestamps.

halistservices

List available services (actions) for device control. Shows what actions can be performed on each device type and what parameters they accept.

Parameters:

  • domain (optional) — Filter by domain, e.g., light, climate, switch

Example:

Text1 line
What services are available for climate devices?

hacallservice

Call a Home Assistant service to control a device.

Parameters:

  • domain (required) — Service domain: light, switch, climate, cover, media_player, fan, scene, script
  • service (required) — Service name: turn_on, turn_off, toggle, set_temperature, set_hvac_mode, open_cover, close_cover, set_volume_level
  • entity_id (optional) — Target entity, e.g., light.living_room
  • data (optional) — Additional parameters as a JSON object

Examples:

Text2 lines
Turn on the living room lights
→ ha_call_service(domain="light", service="turn_on", entity_id="light.living_room")
Text3 lines
Set the thermostat to 22 degrees in heat mode
→ ha_call_service(domain="climate", service="set_temperature",
    entity_id="climate.thermostat", data={"temperature": 22, "hvac_mode": "heat"})
Text3 lines
Set living room lights to blue at 50% brightness
→ ha_call_service(domain="light", service="turn_on",
    entity_id="light.living_room", data={"brightness": 128, "color_name": "blue"})

Gateway Platform: Real-Time Events

Carries a warning. Read it before running anything here. The upstream warning appears below.

The Home Assistant gateway adapter connects via WebSocket and subscribes to state_changed events. When a device state changes and matches your filters, it's forwarded to the agent as a message.

Event Filtering

Configure which events the agent sees in ~/.hermes/config.yaml under the Home Assistant platform's extra section:

YAML16 lines
platforms:
  homeassistant:
    enabled: true
    extra:
      watch_domains:
        - climate
        - binary_sensor
        - alarm_control_panel
        - light
      watch_entities:
        - sensor.front_door_battery
      ignore_entities:
        - sensor.uptime
        - sensor.cpu_usage
        - sensor.memory_usage
      cooldown_seconds: 30
SettingDefaultDescription
watch_domains(none)Only watch these entity domains (e.g., climate, light, binary_sensor)
watch_entities(none)Only watch these specific entity IDs
watch_allfalseSet to true to receive all state changes (not recommended for most setups)
ignore_entities(none)Always ignore these entities (applied before domain/entity filters)
cooldown_seconds30Minimum seconds between events for the same entity

Event Formatting

State changes are formatted as human-readable messages based on domain:

DomainFormat
climate"HVAC mode changed from 'off' to 'heat' (current: 21, target: 23)"
sensor"changed from 21°C to 22°C"
binary_sensor"triggered" / "cleared"
light, switch, fan"turned on" / "turned off"
alarm_control_panel"alarm state changed from 'armed_away' to 'triggered'"
(other)"changed from 'old' to 'new'"

Agent Responses

Outbound messages from the agent are delivered as Home Assistant persistent notifications (via persistent_notification.create). These appear in the HA notification panel with the title "Hermes Agent".

Connection Management

  • WebSocket with 30-second heartbeat for real-time events
  • Automatic reconnection with backoff: 5s → 10s → 30s → 60s
  • REST API for outbound notifications (separate session to avoid WebSocket conflicts)
  • Authorization — HA events are always authorized (no user allowlist needed, since the HASS_TOKEN authenticates the connection)

Security

Carries a warning. Read it before running anything here. The upstream warning appears below.

The Home Assistant tools enforce security restrictions:

Entity IDs are validated against the pattern ^[a-z_][a-z0-9_]*\.[a-z0-9_]+$ to prevent injection attacks.

Example Automations

Explains the idea itself. Read it slowly; the later sections build on it.

Morning Routine

Text9 lines
User: Start my morning routine

Agent:
1. ha_call_service(domain="light", service="turn_on",
     entity_id="light.bedroom", data={"brightness": 128})
2. ha_call_service(domain="climate", service="set_temperature",
     entity_id="climate.thermostat", data={"temperature": 22})
3. ha_call_service(domain="media_player", service="turn_on",
     entity_id="media_player.kitchen_speaker")

Security Check

Text10 lines
User: Is the house secure?

Agent:
1. ha_list_entities(domain="binary_sensor")
     → checks door/window sensors
2. ha_get_state(entity_id="alarm_control_panel.home")
     → checks alarm status
3. ha_list_entities(domain="lock")
     → checks lock states
4. Reports: "All doors closed, alarm is armed_away, all locks engaged."

Reactive Automation (via Gateway Events)

When connected as a gateway platform, the agent can react to events:

Text7 lines
[Home Assistant] Front Door: triggered (was cleared)

Agent automatically:
1. ha_get_state(entity_id="binary_sensor.front_door")
2. ha_call_service(domain="light", service="turn_on",
     entity_id="light.hallway")
3. Sends notification: "Front door opened. Hallway lights turned on."

Troubleshooting

A troubleshooting section. Find the symptom that matches yours rather than reading it end to end.

Environment variables not picked up. The adapter reads credentials from ~/.hermes/.env (auto-merged at startup) or from config.yaml. Double-check the file lives under the active Hermes profile home and that there's no stray quoting around the URL/token. Restart the gateway after editing — env changes are only applied on process start.

REST auth failing (401 Unauthorized). The token must be a Long-Lived Access Token created from your HA user profile page (Profile → Security → Long-lived access tokens). Short-lived UI session tokens won't work. Also verify the base URL includes the scheme and port (e.g. http://homeassistant.local:8123) and is reachable from the host running Hermes — curl -H "Authorization: Bearer <token>" <url>/api/ should return {"message": "API running."}.

Knowledge check

4 questions answered by this page alone.

Every option is a real identifier from the Hermes documentation. The wrong ones are real too, just from other pages.

1. Which of these environment variables actually appears in this lesson?
2. Which warning does the source state in this lesson?
3. Which of these headings does not appear in this lesson?
4. Which configuration key appears in this lesson's examples?