LumiNode/LumiCore Bitfocus Companion Streamdeck module

LumiNode/LumiCore Bitfocus Companion Streamdeck module

Introduction

Luminex products have an open HTTP API. This API can be used to integrate with other software applications. The LumiNode/LumiCore API is documented here.
One such application is Bitfocus Companion, a software which enables the Elgato Streamdeck to be used to control a huge range of applications and devices, especially useful for broadcast and live-stream applications. Companion is an open-source software. Starting from version v3.2.0, it has a Luminex LumiNode module. This article will explain how to get started with this module. The Companion documentation explains how to install the application and how to connect your Streamdeck.

If you have any issues with the module or if you would like to request additional functionality, please use the Github 'issues' functionality. Since the module is open-source, we also encourage you to contribute to the code.

The GigaCore module is documented here.

LumiNode module

Configuration

Once you have Companion installed, you should see a launcher similar to the screenshot below. Use the 'Launch GUI' button to open the configuration interface.

This will open a web page where you can add 'connections'. You will need 1 connection for each LumiNode or LumiCore you would like to connect to.
  1. Use the search functionality to find the LumiNode module
  2. Use the 'Add' button to add the connection


Once the connection is added, it has to be configured so the software can reach the LumiNode. For this, it is important that the PC on which Bitfocus Companion is installed, is connected to the same network as the LumiNode and has an IP address in the same IP range. You can verify this connectivity by accessing the LumiNode web-interface. Alternatively, the LumiNode can be accessed using IPv6 on {serial_number}.local.

To add a LumiNode:
  1. Give it a label. Especially if you would like to connect to multiple LumiNode's, it is recommended to give the connection a meaningful name so you can differentiate between the different devices. Spaces are not allowed in the label.
  2. IP address: Sometimes, Bitfocus can detect Luminex devices in the network using mDNS. However, this does not always work at this moment. Therefore, there is still the option to manually configure the IP address. This can also be the mDNS domain name `{serial_number}.local`.
  3. Password: Only provide a password if password authentication is enabled on the device, otherwise leave this field blank.
  4. Save

Once the software has successfully connected to the device, the 'Status' column should show a green check mark, indicating that the connection has been successfully established. In case of an issue, the logs can be viewed using the '>_' button.

It is now possible to add another connection to a LumiNode or any other device supported by Companion. Once this is done, go to 'Settings' and make sure the Grid size matches the grid size of your Streamdeck. Note that Companion can also be used with other input devices or with the Web emulator. A web emulator can be added in the 'Surfaces' tab.

If everything is configured correctly, the 'Buttons' page should reflect the configured grid layout and you can start configuring your buttons.

Presets

The easiest way to add LumiNode/LumiCore actions is using the 'Presets'. The presets are organized in different categories. Once you go into a category, you can hover over the preset to get a short description of the preset.



At this moment, the following presets are available:

  1. Profiles:
    1. Show the active profile name
    2. Recall a specific profile
    3. Save the current settings in a specific profile
  2. Device:
    1. Button to reboot the device.
    2. Button to reset the device.
  3. Play:
    1. A button for each of the different play actions: play, next, reset and back
    2. A button to recall a specific snapshot.
To use a preset, select it and drag it to the grid.


The button will now appear in the emulator and on the Streamdeck. Clicking on the button will reveal the configuration you just applied.

Edit button configuration

Presets can be a good starting point, but Companion becomes very powerful if you edit the button configuration yourself. To do this, click on the button you would like to modify.
This will reveal the configuration on the right side of the screen. On the top of this section, you can define the layout and design of the button, including importing a PNG image.

Actions

On the bottom half, actions can be associated to the button. Multiple actions can be assigned to the same button, these actions can trigger the same or different devices. This can for example be used to recall profiles on multiple devices.

Feedbacks

When selecting the 'feedbacks' tab, you can customize the design of the button based on values from the device. For example let the background change depending on the color of a specific group.

Variables

Under variables, you can monitor the values from every connection. Variables can be used in the button design, for example as a label.




    • Related Articles

    • GigaCore Bitfocus Companion Streamdeck module

      Introduction Luminex products have an open HTTP API. This API can be used to integrate with other software applications. The GigaCore API is documented here (generation 2) and here (generation 1). One such application is Bitfocus Companion, a ...
    • LumiNode API documentation

      In the attached document you can find all the web API commands available for the LumiNode and LumiCore. The API is also available on the device itself by browsing to http://{YOUR_DEVICE_IP}/api/doc
    • GigaCore API documentation

      In the attached document you can find all the web API commands available for the second generation GigaCore. The API is also available on the device itself by browsing to http://{YOUR_DEVICE_IP}/api/doc This API works for the following devices: ...
    • LumiNode / LumiCore patch generator

      LumiNode / LumiCore Patch Generator The LumiNode range offers the option to import csv files to fill the patch in a process engine. Attached to this article you will find an example excel spreadsheet with some handy macros to quickly make patches ...
    • LumiNode/LumiCore control channel values

      In the LumiNode/LumiCore there are different functions where a control channel can be assigned. All values are in the range 0 - 255. These are the control channel values for each of the available options: General: 0 - 7: Do Nothing Switch: 8 - 15: ...