Twinkly
Drive Twinkly light effects from stream events.
Overview
The Twinkly integration adds dedicated triggers and actions so you can build workflows around events, device state, or external updates.
Event Triggers
React to inbound events and status updates.
Action Effects
Send commands and automate responses.
Automation Hooks
Combine triggers with other plugins and scripts.
Setup
1
Enable the Plugin
Open FaustBot settings and enable the Twinkly integration.
2
Connect Your Account or Device
Provide any required credentials or connection details.
3
Verify the Connection
Trigger a test action to confirm the integration is responding.
Connection Tips
Keep the service running and verify network permissions if the connection fails.
Triggers
- Connection status changes (connected, disconnected, error).
- Incoming events or webhook notifications.
- State changes reported by the service or device.
Effects
- Send commands or updates to Twinkly.
- Change device settings or activate presets.
- Sync data into variables for other actions.
Scripting API
Use the CPH API to control Twinkly directly from scripts:
Device Control
Device control
# Turn on Twinkly device
CPH.TwinklySetPower("Living Room Lights", True)
# Turn off device
CPH.TwinklySetPower("Living Room Lights", False)
# Get device status
status = CPH.TwinklyGetStatus("Living Room Lights")Color Control
Color control
# Set color (RGB values 0-255)
CPH.TwinklySetColor("Living Room Lights", 255, 0, 128)
# Set brightness (0-100)
CPH.TwinklySetBrightness("Living Room Lights", 75)Effects
Effects and modes
# Set effect/mode
CPH.TwinklySetEffect("Living Room Lights", "Rainbow")
# Get available effects
effects = CPH.TwinklyGetEffects("Living Room Lights")
# Set movie/playlist
CPH.TwinklySetMovie("Living Room Lights", "Holiday Scene")See the full API reference for all available Twinkly methods.