Integration

Govee

Control Govee smart lighting devices to create immersive stream environments with dynamic colors, brightness, and color temperature.

Overview

FaustBot integrates with the Govee API to control your smart lighting devices, allowing you to create reactive lighting effects for your stream. Whether you want to match your brand colors, react to events, or create ambient lighting scenes, the Govee integration provides full control.

Device Control

Power on/off individual lights or all devices at once.

RGB Colors

Set any color using RGB values or hex codes.

Brightness

Adjust brightness from 0-100% on any device.

Color Temperature

Set white temperature from warm (2000K) to cool (9000K).

Group Control

Control multiple devices as groups for synchronized effects.

Bulk Operations

Control all devices simultaneously with single commands.

Setup

Get Your Govee API Key

To use the Govee integration, you need an API key from the Govee Developer platform.

1

Open Govee Home App

Open the Govee Home app on your mobile device and ensure your devices are set up and connected to your account.

2

Request API Key

In the app, go to Profile → Settings → About Us → Apply for API Key. Fill out the form and submit your request. The API key is usually delivered within minutes via email.

3

Configure in FaustBot

In FaustBot, go to Integrations → Govee. Enter your API key and click Connect. Your devices should appear in the device list.

Device Names

Govee devices are identified by the names you set in the Govee Home app. Use descriptive names like "Stream Backlight" or "Desk Lamp" to make your scripts easier to read and maintain.

API Rate Limits

The Govee API has rate limits. FaustBot handles this automatically, but avoid sending rapid-fire commands. For real-time reactive effects, consider using a local Govee LAN integration if available for your devices.

Effects

Power Control

Turn On

Turn on a specific device.

Turn Off

Turn off a specific device.

All On

Turn on all Govee devices.

All Off

Turn off all Govee devices.

Color & Brightness

Set Color

Set RGB color on a device.

Set Brightness

Set brightness (0-100%).

Set Temperature

Set color temp (2000-9000K).

All Color

Set color on all devices.

Group Control

Group Power

Control power for a group.

Group Brightness

Set brightness for a group.

Group Color

Set color for a group.

Scripting API

Control Govee devices from your scripts using the CPH API:

Connection & Device Info

Connection and device information 
# Check if connected to Govee
connected = CPH.GoveeIsConnected()

# Get all available devices
devices = CPH.GoveeGetDevices()
for device in devices:
    CPH.LogInfo(f"Device: {device['name']} ({device['model']})")

# Get a specific device by name
device = CPH.GoveeGetDevice("Living Room Light")

# Refresh the device list from the API
CPH.GoveeRefreshDevices()

Power Control

Power control 
# Turn on a specific device
CPH.GoveeTurnOn("Living Room Light")

# Turn off a specific device
CPH.GoveeTurnOff("Living Room Light")

# Set power state explicitly (True = on, False = off)
CPH.GoveeSetPower("Living Room Light", True)

# Toggle based on a condition
is_streaming = CPH.ObsIsStreaming()
CPH.GoveeSetPower("Stream Backlight", is_streaming)

Color & Brightness

Color and brightness control 
# Set color using RGB values (0-255)
CPH.GoveeSetColor("Stream Backlight", 255, 0, 128)  # Purple

# Set color using hex string
CPH.GoveeSetColorHex("Stream Backlight", "#FF0080")

# Set brightness (0-100)
CPH.GoveeSetBrightness("Stream Backlight", 75)

# Set color temperature in Kelvin (2000-9000K)
CPH.GoveeSetColorTemperature("Desk Lamp", 4500)  # Neutral white

# Warm white for cozy streaming
CPH.GoveeSetColorTemperature("Desk Lamp", 2700)

# Cool white for alertness
CPH.GoveeSetColorTemperature("Desk Lamp", 6500)

Group Control

Group control 
# Get all device groups
groups = CPH.GoveeGetGroups()
for group in groups:
    CPH.LogInfo(f"Group: {group['name']}")

# Control an entire group at once
CPH.GoveeSetGroupPower("Stream Room", True)  # Turn on all lights in group
CPH.GoveeSetGroupBrightness("Stream Room", 80)  # Set group brightness
CPH.GoveeSetGroupColor("Stream Room", 0, 128, 255)  # Set group color

# Create a streaming ambiance
CPH.GoveeSetGroupPower("Stream Room", True)
CPH.GoveeSetGroupColor("Stream Room", 128, 0, 255)
CPH.GoveeSetGroupBrightness("Stream Room", 60)

All Devices Control

Control all devices 
# Turn on all Govee devices
CPH.GoveeAllOn()

# Turn off all Govee devices
CPH.GoveeAllOff()

# Set color on all devices
CPH.GoveeAllColor(255, 100, 0)  # Orange glow

# Set brightness on all devices
CPH.GoveeAllBrightness(50)

# Stream starting routine - all lights on with brand color
CPH.GoveeAllOn()
CPH.GoveeAllColor(148, 0, 211)  # Violet
CPH.GoveeAllBrightness(70)

# Stream ending routine - dim and warm
CPH.GoveeAllBrightness(30)
CPH.GoveeSetColorTemperature("Desk Lamp", 2700)
CPH.Wait(5000)
CPH.GoveeAllOff()

See the full API reference for all available Govee methods.