Skip to main content

TCP / UDP Control

Remote triggering can be done by sending TCP (port 51234) or UDP (port 51235) commands.

Commands​

  • SURFACE <surface id> PAGE-SET <page number>
    Set a surface to a specific page

  • SURFACE <surface id> PAGE-UP
    Page up on a specific surface

  • SURFACE <surface id> PAGE-DOWN
    Page down on a specific surface

  • LOCATION <page>/<row>/<column> PRESS
    Press and release a button (run both down and up actions)

  • LOCATION <page>/<row>/<column> DOWN
    Press the button (run down actions)

  • LOCATION <page>/<row>/<column> UP
    Release the button (run up actions)

  • LOCATION <page>/<row>/<column> ROTATE-LEFT
    Trigger a left rotation of the button/encoder

  • LOCATION <page>/<row>/<column> ROTATE-RIGHT
    Trigger a right rotation of the button/encoder

  • LOCATION <page>/<row>/<column> SET-STEP <step>
    Set the current step of a button/encoder

  • LOCATION <page>/<row>/<column> STYLE TEXT <text>
    Change text on a button

  • LOCATION <page>/<row>/<column> STYLE COLOR <color HEX>
    Change text color on a button (#000000)

  • LOCATION <page>/<row>/<column> STYLE BGCOLOR <color HEX>
    Change background color on a button (#000000)

  • CUSTOM-VARIABLE <name> SET-VALUE <value>
    Change custom variable value

  • SURFACES RESCAN Make Companion rescan for USB surfaces

Examples​

Set the emulator surface to page 23:
SURFACE emulator PAGE-SET 23

Press page 1 row 2 column 3:
LOCATION 1/2/3 PRESS

Change custom variable "cue" to value "intro":
CUSTOM-VARIABLE cue SET-VALUE intro

Deprecated Commands​

The following commands are deprecated and have replacements listed above. They will be removed in a future version of Companion.

  • PAGE-SET <page number> <surface id>
    Make device go to a specific page
  • PAGE-UP <surface id>
    Page up on a specific device
  • PAGE-DOWN <surface id>
    Page down on a specific surface
  • BANK-PRESS <page> <bank>
    Press and release a button (run both down and up actions)
  • BANK-DOWN <page> <bank>
    Press the button (run down actions)
  • BANK-UP <page> <bank>
    Release the button (run up actions)
  • STYLE BANK <page> <bank> TEXT <text>
    Change text on a button
  • STYLE BANK <page> <bank> COLOR <color HEX>
    Change text color on a button (#000000)
  • STYLE BANK <page> <bank> BGCOLOR <color HEX>
    Change background color on a button (#000000)
  • RESCAN Make Companion rescan for newly attached USB surfaces