Show admin? Log in to your account here

OctoCue Receiver: Advanced Config

Configuration folder & log files

On first run, OctoCue Receiver (v1.1.0 onwards) creates some configuration files on your system. These are populated with default details, but can be edited to tweak the receiver's behaviour as required.

The location of these files depends on your operating system.

On Windows, these files are stored in %APPDATA%\OctoCue receiver\storage

To open this folder:

  • Open file explorer
  • Select the address bar
  • Paste in %APPDATA%\OctoCue receiver\storage
  • Hit Enter

On Windows, the log file is at %APPDATA%\OctoCue receiver\logs\main.log (for OctoCue Receiver v1.1.1 onwards)

On macOs, configuration files are stored in /Users/<username>/Library/Application Support/OctoCue receiver/storage

The Library folder is not always displayed by default. To show it:

  • Open finder and navigate to /Users/<username>
  • Option-click and select Show View Options
  • Select Show Library folder

Each file in this folder is a JSON object that contains configuration information for a particular function. If you edit these files, you'll need to close and re-open OctoCue Receiver as configuration details are loaded on app start.

If you make edits and things stop working, delete the contents of this folder entirely - new files with system defaults will be created on startup.

Configuration file edits will persist through upgrades and uninstall/reinstall cycles.

Re-mapping keys

OctoCue controls PowerPoint by emulating keypresses on your host machine. By default it uses Page Down (for next) and Page Up (for back).

If you'd like to change the keys used, edit keypress.json in the configuration folder.

The default setting for this is:

{
    "useKeyPress": true,
    "next": "PageDown",
    "back": "PageUp"
}

Setting useKeyPress to false will disable keypresses completely.

Individual keys can be set using a set of standard codes that a common across macOS and Windows. Key codes are not case sensitive.

Here's an example using the a and b keys:

{
    "useKeyPress": true,
    "next": "KeyA",
    "back": "KeyB"
}

There's no support for multiple keypresses or key combinations (e.g. ctrl-v).

Debugging keypresses

Check and debug your keypresses using our key press logger utility.

Network control protocols

In addition to emulating keypresses, OctoCue Receiver v1.1.1 and greater can control third party applications (such as Companion and vMix) using OSC, UDP and TCP commands.

Sample applications

OSC control

OctoCue receiver can output OSC commands via UDP when it receives 'next' and 'back' clicks from the OctoCue servers. By default this function is disabled, but you can enable it by editing osc.json in the configuration folder.

The default setting for this is pre-configured to work with Bitfocus Companion, but can be re-configured to suit your system requirements.

{
    "useOsc": false,
    "localPort": 57121,
    "localAddress": "0.0.0.0",
    "remotePort": 12321,
    "remoteAddress": "192.168.0.255",
    "next": {
        "address": "/press/bank/1/3",
        "args": []
        },
    "back": {
        "address": "/press/bank/1/2",
        "args": []
        }
}

Here's a more complete example with arguments - which must be of type f (float), s (string), i (integer) or b (blob) - see the OSC specification document for full details:

{
    "useOsc": true,
    "localPort": 57121,
    "localAddress": "0.0.0.0",
    "remotePort": 12321,
    "remoteAddress": "192.168.0.255",
    "next": {
        "address": "/press/bank/1/3",
        "args": [
            {"type": "f","value": 34.5},
            {"type": "s","value": "OctoCue is great!"}
        ]
    },
    "back": {
        "address": "/press/bank/1/2",
        "args": [
            {"type": "i","value": 34},
            {"type": "s","value": "Heading back..."}
        ]
    }
}

UDP control

OctoCue receiver can output generic UDP packets when it receives 'next' and 'back' clicks from the OctoCue servers. By default this function is disabled, but you can enable it by editing udp.json in the configuration folder.

The default UDP configuation is shown below. This will broadcast to every device on the network using address 255.255.255.255:8100.

{
    "useUdp": false,
    "localAddress": "0.0.0.0",
    "remotePort": 8100,
    "remoteAddress": "255.255.255.255",
    "next": "OctoCue says NEXT",
    "back": "OctoCue says BACK"
}

Note that the local port is fixed at 57121, and a local address of 0.0.0.0 should work for all applications.

TCP control

OctoCue receiver can connect to TCP servers and send TCP data when it receives 'next' and 'back' clicks from the OctoCue servers. By default this function is disabled, but you can enable it by editing tcp.json in the configuration folder.

The default TCP configuation is shown below - this is setup to control vMix inputs on the local machine (at 127.0.0.1:8099), but can be changed to control anything with a TCP API.

{
    "useTcp": false,
    "localPort": 57123,
    "localAddress": "0.0.0.0",
    "remotePort": 8099,
    "remoteAddress": "127.0.0.1",
    "next": "FUNCTION PreviewInput Input=1\r\n",
    "back": "FUNCTION PreviewInput Input=2\r\n"
}

In most situations the local port should not matter - you should only change this if you get port conflict problems. A local address of 0.0.0.0 should work for all applications.

Debugging network control protocols

When setting up you system, it's often helpful to see error messages and TCP replies from your remote applications. To do this, check the log file - see above for details of how to find this.

For fine-grain monitoring of OSC, TCP and UDP, we recommend Wireshark. For testing out control packets before editing the OctoCue config files, try Packet Sender.

 

Start a free trial now