Touch Portal
Trigger FaustBot actions from Touch Portal buttons and pages.
Overview
The Touch Portal 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 Touch Portal 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 Touch Portal.
- Change device settings or activate presets.
- Sync data into variables for other actions.
Scripting API
Use the CPH API to control Touch Portal directly from scripts.
State Updates
State updates
# Update a Touch Portal state
CPH.TouchPortalSetState("my_state_id", "New Value")
# Update multiple states
CPH.TouchPortalSetState("viewer_count", str(viewer_count))
CPH.TouchPortalSetState("stream_title", current_title)Button Control
Button control
# Change button icon
CPH.TouchPortalSetButtonIcon("button_id", "path/to/icon.png")
# Update button text
CPH.TouchPortalSetButtonText("button_id", "New Label")
# Toggle button visual state
CPH.TouchPortalSetButtonState("button_id", True)Connection & Events
Connection and events
# Check connection status
is_connected = CPH.TouchPortalIsConnected()
# Get connection info
info = CPH.TouchPortalGetInfo()
# Send custom event
CPH.TouchPortalSendEvent("my_custom_event", {"key": "value"})See the full API reference for all available Touch Portal methods.