Custom buttons: Receiver setup

info

You'll need OctoCue Receiver v1.4.4 or later to get custom button support.

Custom buttons can trigger keypresses, TCP, UDP or OSC network commands on your show machines. To specify what each button does, you'll need to modify the config files of the Receiver application.

In the example below, we've modified the osc.json file so the receiver will press BitFocus Companion buttons 10-13 on the local machine when commands custom-1 to custom-4 are received.

{
    "useOsc": true,
    "localPort": 57121,
    "localAddress": "0.0.0.0",
    "remotePort": 12321,
    "remoteAddress": "127.0.0.1",
    "next": {
        "address": "/press/bank/1/3",
        "args": []
    },
    "back": {
        "address": "/press/bank/1/2",
        "args": []
    },
    "custom-1": {
        "address": "/press/bank/1/10",
        "args": []
    },
    "custom-2": {
        "address": "/press/bank/1/11",
        "args": []
    },
    "custom-3": {
        "address": "/press/bank/1/12",
        "args": []
    },
    "custom-4": {
        "address": "/press/bank/1/13",
        "args": []
    }
}

Valid actions are next, back and custom-x when x = 1 to 8 and relates to the id the button.

Not all actions need to be included in the config file - for example, this Receiver will not output any OSC if it receives a custom-5 button press.

tcp.json, udp.json and keypress.json can all be modified in similar ways.

If an action appears in more than one file, you'll get multiple actions occurring on a single button press.