Skip to content

Broox Controller

Broox Controller is a rule-based system that dispatches events from and to all subsystems in a Broox interactive installation.

It uses MQTT for event dispatching.

It can run standalone or as a system service (in select platforms).

Broox Controller Installation

Windows

  1. Download BrooxController-win32-X.X.X.exe (X.X.X is the version number). NB: You can also download the BrooxPlatform-x.x.x.exe installer and select Broox Controller.

  2. Double click and follow the installer instructions. You can check Create a desktop shortcut if you want.

  3. Press Next and then Install.

  4. Once finished, you can close the installer.

  5. Find the Broox Controller on the Desktop or via the Start Button and start it.

  6. The Broox Controller UI will show. As it isn't configured yet, we expand the configuration (little triangle).

  7. On the Configuration section, we click "Read .license file". See Getting a License on how to obtain it.

  8. We browse for the downloaded CONTROLLER-NAME.license file from the Broox Studio location creation and we load it.

  9. Now we can Start Broox Controller using the Start Button.
    The green line shows the process identifier of the     Broox Controller daemon process    .

  10. If we check Start Automatically and minimize the Broox Controller daemon process is started right away and the UI is minimised to the System Tray.

Ubuntu Linux

  1. On Ubuntu 20.04, download the Broox Controller .deb package.

  2. Open a terminal and type:

    cd Downloads
sudo apt install ./broox-controller_2.7.0_amd64.deb
sudo systemctl restart mosquitto
    - Note that some new versions might need to adjust /etc/mosquitto/mosquitto.conf to listen to the local network.

  3. Start Broox Controller from the Applications screen:

    or from command line:

    /opt/broox/BrooxController/BrooxController

  4. Expand the configuration menu and click Read .license file. See Getting a License on how to obtain it.

  5. Select the .license file you downloaded from Broox Studio and load it.

  6. Once loaded, you can start the Broox Controller by pressing Start.

Configuration and logs

Broox Controller will create the controller.ini file in the %LOCALAPPDATA%\Broox Controller folder (e.g. C:\Users\username\AppData\Local\Broox Controller. Note that AppData is a hidden folder).

License File

Getting a Licence

  1. Log in to Broox Studio with your provided credentials.

  2. On the "Accounts" screen, select your target account:

  3. You will be directed to the main screen, showing analytics (if present, if not a placeholder) and a left-side menu.

  4. Move to the Locations section of the menu.

  5. Press Add Location button.

  6. This will pop up a form with the location information (name, location, country…) and very importantly timezone if we are to use scheduled campaigns. Those will start and stop in the selected hours in the location timezone.

  7. In the location settings, we found a newly created controller in the Nodes page.

  8. Download your .license file clicking the Download License button.

  9. This will create a NAME-OF-CONTROLLER.license file that you will need to activate Broox Controller.

Troubleshooting Broox Controller

Is the Broox Controller running?

Router visibility problems

If your deployment has some nodes wired and some wireless, some routers might not allow them to detect each other. This is caused by routers that do not forward multicast packets between the wired and wireless legs of a network. That might need to enable IGMP Snooping or Multicast forwarding options in the router. You can also check connecting all the nodes to either wired or wireless, without a mix.