Integration

Philips Hue

Control your Philips Hue smart lighting system directly from FaustBot. Create immersive stream experiences with dynamic lighting effects triggered by chat, events, or scripts.

Overview

FaustBot connects to your Philips Hue Bridge using the official Hue API v2, providing comprehensive control over your entire lighting setup:

Light Control

Turn lights on/off, set brightness, colors, and color temperature.

Room & Zone Control

Control entire rooms or zones with a single command.

Scene Activation

Activate pre-configured Hue scenes for instant ambiance.

Gradient Lights

Set gradient colors on compatible light strips.

Entertainment Mode

Start/stop entertainment streaming for sync apps.

Sensor Events

React to motion sensors, buttons, and light levels.

Setup

Connect to Hue Bridge

1

Discover Bridge

In FaustBot, go to Hue in the sidebar. Click Discover to automatically find your Hue Bridge on the network.

2

Press Bridge Button

When prompted, press the physical button on your Hue Bridge within 30 seconds to authorize the connection.

Screenshot: Hue Bridge pairing
3

Verify Connection

Once paired, FaustBot will display your lights, rooms, and scenes. The connection is saved and will automatically reconnect.

Manual IP Entry

If discovery fails, you can manually enter your Bridge IP address. Find it in the Hue app under Settings → Hue Bridges → (i) icon.

Triggers

Respond to events from your Hue devices:

Motion Detected Motion sensor triggered
Motion Cleared No motion detected for timeout period
Button Pressed Hue switch button pressed
Light Level Changed Ambient light level changed significantly
Temperature Changed Temperature sensor reading changed

Effects

Light Control

Set Light State

Turn a light on or off.

Set Brightness

Set light brightness (0-100%).

Set Color

Set light color by hex, RGB, or HSV.

Set Color Temperature

Set warm/cool white (Kelvin).

Set Light Effect

Apply candle, fire, or other effects.

Alert Light

Blink a light to draw attention.

Room & Zone Control

Set Room State

Turn entire room on/off.

Set Room Brightness

Dim all lights in a room.

Activate Room Scene

Apply a scene to a room.

Set Zone State

Control a lighting zone.

Activate Zone Scene

Apply a scene to a zone.

Activate Scene

Activate any scene by ID.

Advanced

Set Gradient

Set gradient colors on light strips.

Start Streaming

Enable entertainment mode.

Stop Streaming

Disable entertainment mode.

Set Motion Sensor

Enable/disable motion detection.

Set All Lights

Control all lights at once.

Alert All Lights

Blink all lights.

Scripting API

Control Hue lights programmatically from your scripts:

Connection

# Check if connected to Hue Bridge
if CPH.HueIsConnected():
    info = CPH.HueGetConnectionInfo()
    CPH.Log(f"Connected to bridge: {info['bridgeId']}")

Light Control

# Turn on a light
CPH.HueTurnOnLight("abc123")

# Set brightness (0-100)
CPH.HueSetLightBrightness("abc123", 75)

# Set color by hex
CPH.HueSetLightColor("abc123", "#FF5500")

# Set color by RGB
CPH.HueSetLightColorRgb("abc123", 255, 85, 0)

# Set color temperature (Kelvin)
CPH.HueSetLightColorTempKelvin("abc123", 4000)

# Toggle light
CPH.HueToggleLight("abc123")

# Blink light
CPH.HueBlinkLight("abc123")

Room & Scene Control

# Get all rooms
rooms = CPH.HueGetRooms()
for room in rooms:
    CPH.Log(f"Room: {room['name']}")

# Turn on a room
CPH.HueTurnOnRoom("room-id")

# Set room brightness
CPH.HueSetRoomBrightness("room-id", 50.0)

# Activate a scene by name
CPH.HueActivateSceneByName("Movie Night")

# Get scenes for a room
scenes = CPH.HueGetScenesForGroup("room-id")

Gradient Lights

# Set gradient colors on a light strip
colors = ["#FF0000", "#00FF00", "#0000FF"]
CPH.HueSetGradientColors("lightstrip-id", colors)

# Set gradient mode
CPH.HueSetGradientMode("lightstrip-id", "interpolated_palette")

See the full API reference for all available Hue methods.