Companion Integration Quick Start
Quick Start
In Tally Equipment settings, enter your Companion address (e.g.,
http://192.168.1.100:8888)Click Save and test the connection
Create a test button in Companion's web interface
Trigger the button from Tally and confirm it works
Who This Is For
Teams already using Bitfocus Companion for device control and button macros.
What You Will Accomplish
Connect Tally to your Companion instance
Trigger buttons by their position on the grid
Trigger buttons by their name
Prerequisites
Step-by-Step Setup
In Tally Equipment settings, enter the Companion address (e.g., http://192.168.1.100:8888).
Save and run the connection test. Companion should show as reachable.
In Companion's web interface, create a test button labeled Test: Ping.
From Tally, trigger the button using its position on the Companion grid — specify the page, row, and column.
Trigger the same button using its label name. The name must match exactly (including uppercase/lowercase letters).
Advanced Details Show / Hide
When sending commands programmatically, Tally uses this format:
{
"command": "companion.press",
"params": { "page": 1, "row": 0, "col": 0 }
}Or by name:
{
"command": "companion.pressNamed",
"params": { "name": "Test: Ping" }
}The companion.connections command returns a list of all connected modules. Button names are case-sensitive — "Test: Ping" is not the same as "test: ping".
API compatibility depends on your Companion version. Check Companion's documentation if commands aren't working.
Validation Checklist
Common Issues and Fixes
| Symptom | Cause | Fix |
|---|---|---|
| Companion shows 0 connections | Modules not loaded or misconfigured | Open Companion and check that your modules are connected |
| Commands not working | Companion version doesn't support this feature | Update Companion and check its API documentation |
| Button name not found | Name doesn't match exactly | Copy the exact name from Companion's button settings |
| Connection drops | Network or Companion host instability | Check your network cable and make sure the Companion computer is stable |
Rollback / Fallback
Use Companion manually from its own web interface.
Turn off Tally's Companion triggers until the connection is stable.