Integration

Home Assistant

Control your smart home from stream with Home Assistant integration for lights, scenes, sensors, and automations.

Overview

FaustBot integrates with Home Assistant to bring smart home control to your stream:

Entity Control

Control any Home Assistant entity.

Scene Activation

Activate pre-configured scenes.

Automations

Trigger automations remotely.

Sensor Monitoring

React to sensor state changes.

Light Control

Color, brightness, and effects.

Climate Control

Temperature and HVAC control.

Setup

Connect Home Assistant

Link FaustBot to your Home Assistant instance using a Long-Lived Access Token.

Create Access Token

In Home Assistant, go to Profile → Long-Lived Access Tokens. Click Create Token and give it a name like "FaustBot". Copy the token immediately - it won't be shown again.

Configure FaustBot

In FaustBot, go to Integrations → Home Assistant. Enter your Home Assistant URL (e.g., http://homeassistant.local:8123) and paste your access token.

Screenshot: Home Assistant settings

Connect and Sync

Click Connect. FaustBot will connect and fetch your entities, scenes, and automations. This may take a moment for large installations.

Test the Connection

Try toggling a light or activating a scene to verify the connection works. You should see the change reflected in Home Assistant.

Remote Access

For remote access, use Home Assistant Cloud (Nabu Casa) or set up a secure reverse proxy with HTTPS. Never expose your Home Assistant to the internet without proper security.

Triggers

Respond to Home Assistant events:

Entity State Changed Any entity changed state

Sensor Updated Sensor value changed

Motion Detected Motion sensor triggered

Door Opened Door/window sensor triggered

Button Pressed Smart button was pressed

Automation Triggered An automation ran

Trigger Variables

These variables are available in your actions:

%haEntityId% Entity ID (e.g., light.living_room)

%haEntityName% Friendly name of the entity

%haState% New state value

%haOldState% Previous state value

%haAttributes% Entity attributes as JSON

%haDomain% Entity domain (light, switch, etc.)

Effects

Entity Control

Turn On

Turn on any entity.

Turn Off

Turn off any entity.

Toggle

Toggle entity state.

Set State

Set entity to specific state.

Light Control

Set Brightness

Adjust light brightness.

Set Color

Change light color.

Set Temperature

Adjust color temperature.

Flash

Flash the light.

Scenes & Automations

Activate Scene

Turn on a scene.

Run Automation

Trigger an automation.

Run Script

Execute a HA script.

Media & Climate

Media Control

Play, pause, volume.

Set Temperature

Adjust thermostat.

Set HVAC Mode

Heat, cool, auto, off.

Scripting API

Control Home Assistant from your scripts:

Entity Control

Control Home Assistant entities

# Turn on a light
CPH.HomeAssistantTurnOn("light.living_room")

# Turn off with entity
CPH.HomeAssistantTurnOff("switch.fan")

# Toggle a device
CPH.HomeAssistantToggle("light.desk_lamp")

# Get entity state
state = CPH.HomeAssistantGetState("sensor.temperature")
CPH.LogInfo(f"Temperature: &#123;state['state']&#125;°F")

Light Control

Control light brightness, color, and effects

# Set brightness (0-255)
CPH.HomeAssistantTurnOn("light.studio", brightness=200)

# Set color by RGB
CPH.HomeAssistantTurnOn("light.led_strip", rgb_color=[255, 0, 128])

# Set color by name
CPH.HomeAssistantTurnOn("light.hue_bulb", color_name="purple")

# Set color temperature (mireds)
CPH.HomeAssistantTurnOn("light.desk", color_temp=350)

# Flash the light
CPH.HomeAssistantTurnOn("light.alert", flash="short")

# Transition over time (seconds)
CPH.HomeAssistantTurnOn("light.ambient", brightness=100, transition=5)

Scenes & Automations

Activate scenes and trigger automations

# Activate a scene
CPH.HomeAssistantActivateScene("scene.stream_mode")

# Turn on scene
CPH.HomeAssistantTurnOn("scene.movie_night")

# Trigger an automation
CPH.HomeAssistantTriggerAutomation("automation.welcome_lights")

# Run a script
CPH.HomeAssistantRunScript("script.party_mode")

Service Calls

Call any Home Assistant service

# Call any Home Assistant service
CPH.HomeAssistantCallService(
    domain="notify",
    service="mobile_app_phone",
    data=&#123;
        "message": "Stream is live!",
        "title": "FaustBot Notification"
    &#125;
)

# Climate control
CPH.HomeAssistantCallService(
    domain="climate",
    service="set_temperature",
    entity_id="climate.thermostat",
    data=&#123;"temperature": 72&#125;
)

# Media player control
CPH.HomeAssistantCallService(
    domain="media_player",
    service="play_media",
    entity_id="media_player.speaker",
    data=&#123;
        "media_content_type": "music",
        "media_content_id": "spotify:playlist:xyz"
    &#125;
)

Chat-Triggered Scenes

Let viewers control stream lighting

# Let viewers control stream lighting
message = CPH.GetArg("message").lower()

scenes = &#123;
    "!chill": "scene.chill_mode",
    "!hype": "scene.hype_mode",
    "!spooky": "scene.spooky_mode",
    "!rainbow": "scene.rainbow_party"
&#125;

for command, scene in scenes.items():
    if message.startswith(command):
        CPH.HomeAssistantTurnOn(scene)
        CPH.SendMessage(f"Activated &#123;scene.split('.')[-1].replace('_', ' ')&#125; mode!")
        break

Sensor Monitoring

React to sensor data

# Check room temperature
temp = CPH.HomeAssistantGetState("sensor.room_temperature")
temp_value = float(temp['state'])

if temp_value > 80:
    CPH.SendMessage(f"It's getting hot in here! (&#123;temp_value&#125;°F)")
    CPH.HomeAssistantTurnOn("switch.fan")

# Check if door is open
door = CPH.HomeAssistantGetState("binary_sensor.front_door")
if door['state'] == "on":
    CPH.SendMessage("Warning: Front door is open!")

See the full API reference for all available Home Assistant methods.