COMPANION DASHBOARD

A way to display variables from Bitfocus Companion

DOWNLOAD


LINKS


STEP 1

CONNECT devices in bitfocus companion

The first step is to connect all of the devices that have info you want to display in Dashboard to a single Companion instance.

Dashboard connects to Companion over your local network, so any device you want to display Dashboard on must be on the same network as your Companion instance.

STEP 2

add box options in the editor

Use the Editor to fill out the box options you want to appear in Dashboard. These will be the options for everyone who is connecting to your instance of Companion.

STEP 3

set up companion

  • Copy the code at the top of the Editor

  • Create a new custom variable in Companion. Call it “dashboard”

  • Create a new trigger in Companion

    • Add a “time interval” event, set the interval to 1 second

    • Add a “internal: Custom Variable: Set with expression” action

      • The custom variable is the “dashboard” variable we created earlier

      • Paste the code from the top of the Editor into the “Expression”

STEP 4: link dashboard to companion

Open Dashboard, click the menu button in the top right corner, and type in the address and port of your Companion instance. It would be something like “127.0.0.1:8888"

Hit “Connect” and the page should refresh. That menu will now show a dropdown with options to add boxes to your dashboard!

TIPS AND TRICKS

  • Boxes can be moved around by clicking and dragging

  • Boxes can be resized with the handle in the bottom right hand corner

  • Double-clicking a box deletes that box

  • The mobile version doesn’t support clicking and dragging boxes. Tapping a box cycles between 25%, 50%, 75%, and 100% width and it automatically stacks boxes next to each other.

  • Layouts cache in browser. You can also download a layout file from the menu and load a layout from a file.