Skip to main content
Version: Beta

OSC Control

Remote triggering can be done by sending OSC commands to port 12321 (the port number is configurable).

Commands​

  • /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 and hold)

  • /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>/step
    Set the current step of a button/encoder

  • /location/<page>/<row>/<column>/style/bgcolor <red 0-255> <green 0-255> <blue 0-255>
    Change background color of button

  • /location/<page>/<row>/<column>/style/bgcolor <css color>
    Change background color of button

  • /location/<page>/<row>/<column>/style/color <red 0-255> <green 0-255> <blue 0-255>
    Change color of text on button

  • /location/<page>/<row>/<column>/style/color <css color>
    Change color of text on button

  • /location/<page>/<row>/<column>/style/text <text>
    Change text on a button

  • /custom-variable/<name>/value <value>
    Change custom variable value

  • /surfaces/rescan Rescan for USB surfaces

Examples​

Press row 0, column 5 on page 1 down and hold
/location/1/0/5/press

Change button background color of row 0, column 5 on page 1 to red
/location/1/0/5/style/bgcolor 255 0 0
/location/1/0/5/style/bgcolor rgb(255,0,0)
/location/1/0/5/style/bgcolor #ff0000

Change the text of row 0, column 5 on page 1 to ONLINE
/location/1/0/5/style/text ONLINE

Change custom variable "cue" to value "intro":
/custom-variable/cue/value intro

Deprecated Commands​

warning

These commands will be removed in a future release of Companion. There is equivalent functionality in the list above.

The following commands are deprecated and have replacements listed above. Support for this must be enabled in the settings for it to work

  • /press/bank/ <page> <bank>
    Press and release a button (run both down and up actions)
  • /press/bank/ <page> <bank> <1>
    Press the button (run down actions and hold)
  • /press/bank/ <page> <bank> <0>
    Release the button (run up actions)
  • /style/bgcolor/ <page> <bank> <red 0-255> <green 0-255> <blue 0-255>
    Change background color of button
  • /style/color/ <page> <bank> <red 0-255> <green 0-255> <blue 0-255>
    Change color of text on button
  • /style/text/ <page> <bank> <text>
    Change text on a button
  • /rescan 1 Make Companion rescan for newly attached USB surfaces