Skip to content

Installing Software

Product Installers

The Broox Platform consists of several applications:

  • Broox Controller
  • Broox Media Player
  • Broox Sensor Node
  • Broox Vision Node

Depending on the purpose of the set-up, one or more of these applications will be installed.

On Windows the applications are offered as common .exe installers or an all-in-one BrooxPlatform-x.x.exe.

On Ubuntu the applications are offered as .deb (debian) packages.

Broox Plaform Windows Installer

  1. Download BrooxPlatform-X.Y.exe (X.Y is the version number).

  2. Double-click on the installer.

  3. If prompted by Windows to allow changes, click on Yes.

  4. Select every component from the list.

  5. Once selected, press Next.

  6. If this is correct press Install.

  1. The selected packages will be installed one by one.

Broox Controller

  1. Select the Create a Desktop shortcup checkbox to create a... Desktop shortcut?

  2. Press Next

  3. Press Install to install Broox Controller or Back to change settings.

  4. Once installed press Finish.

Broox Sensor Node

  1. Select the Create a Desktop shortcup checkbox to create a... Desktop shortcut?

  2. Press Next

  3. Press Install to install Broox Sensor Node or Back to change settings.

  4. Once installed press Finish.

Broox Vision Node

  1. Select the Create a Desktop shortcup checkbox to create a... Desktop shortcut?

  2. Press Next

  3. Press Install to install Broox Sensor Node or Back to change settings.

  4. Once installed press Finish.

Broox Media Player

  1. Broox Media Player installs straight away with no interaction.

  2. It always creates a desktop icon.

Finishing

  1. The last screen allows you to execute additional helpful tasks:

    1. The first checkbox disables system sleep, monitor sleep and screen saver.
    2. The second checkbox disables system notification pop-ups.

  2. Press Finish to apply those changes.

  3. Your system is ready for configuration. The selected icons are on the Desktop.

  4. You can also start from the Start Menu:

Ubuntu Install

On Ubuntu Linux, the Broox Platform can be installed using the package manager or the terminal.

Desktop GUI install

  1. Download the separate packages (X.X.X is the latest version number available, for example 1.2.3 or 0.8.1):

    • broox-controller_X.X.X_amd64.deb
    • broox-sensor-node_X.X.X_amd64.deb
    • broox-vision-node_X.X.X_amd64.deb
    • broox-mediaplayer_X.X.X_amd64.deb

  2. Open the file manager:

  3. Double-click on the package:

  4. In the Sofware Manager press Install

  5. Enter your administrator password (user has to have root permission in sudo):

  6. The package is installed, and the Installation button will convert to an uninstallation button.

  7. Repeat for all the packages you want to install.

Command Line install

  1. Download the separate packages (X.X.X is the latest version number available, for example 1.2.3 or 0.8.1):

    • broox-controller_X.X.X_amd64.deb
    • broox-sensor-node_X.X.X_amd64.deb
    • broox-vision-node_X.X.X_amd64.deb
    • broox-mediaplayer_X.X.X_amd64.deb

  2. Open the Terminal (Ctrl+Alt+T):

  3. cd to the folder where you downloaded the .deb packages.

  4. Type sudo apt install ./<name-of-package.deb>

  5. Enter your password for sudo.

  6. The package will install.

  7. Repeat for every needed package.

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.

Broox Mediaplayer Installation

Windows 10/11

  1. Download Mediaplayer Setup X.X.X.exe or the BrooxPlatform-X.X.exe combo installer.

  2. Double-click on the downloaded file to install.

  3. You can find the Media Player on the Start Menu.

Quitting the Mediaplayer

  1. Click on the media player window and press Ctrl-Q.

Kiosk mode Startup

The included mediaplayer.cmd script can be used to start the mediaplayer after user auto-login.

  1. Left-click on the taskbar and open Task Manager.
  2. Click on the bottom button to set it to Advanced mode if needed.
  3. In the "Startup" tab, add mediaplayer.cmd to the list of startup apps.

Note: **The script will kill explorer.exe. **

To get it back, press/send Ctrl+Alt+Del, start the task manager and select File→Run…: explorer.exe.

Linux (Ubuntu 20.04)

  1. Copy the mediaplayer_X.X.X_amd64.deb file to your user directory.
  2. Install with apt as root:
sudo apt install ./mediaplayer_X.X.X_amd64.deb
  • The executable will be located at /usr/bin/mediaplayer.
  • The package installs at /opt/MediaPlayer

You can start from the Ubuntu Applications Menu.

To start from the terminal just use:

mediaplayer

Automatic Startup

On Ubuntu desktop, open the application "Startup Applications" and add a startup item for /usr/bin/mediaplayer

Important Checks

Before deploying any interactive installation, wether ephemeral or longterm, it is important to check the location for access to basic resources:

  • Electrical point(s) with 24x7 operativity

    • IMPORTANT: Check that the PC is not connected to the Lights rail, as it will probably be cut off during the night.

  • Internet connection to reach Broox Studio API

    • Prefer wired internet access (Ethernet) for reliability.
    • If wireless is the only option, try to use a reliable access point, with direct antenna visibility to the PC.

  • Even if power is 24x7:

    • Check the opening and closing times of the store.
    • Ensure that the PC starts up after a power cycle (BIOS "Start up on power on").
    • If needed, set up a shutdown script at night/closing time to ensure clean power off.