ALIF: AIM Bitfocus StreamDeck Support

Overview

We have released a Bitfocus Companion module the 2nd and 3rd Generation AIM Managers.

What is Bitfocus Companion

Companion by Bitfocus is an open-source tool that provides a library of free modules to control and automate a number of devices with devices such as the Elgato StreamDeck. With this tool we have been able to provide a module to help control Infinity products through the ALIF AIM API.

How do I install Companion?

Companion works as a local server on the device it is installed. It can be installed on Linux, Windows, or Mac. To download, you must create a Bitfocus account, where you can then download and install the software. Bitfocus Companion
Further installation guidance can be found on the Companion Github Wiki

Windows:

1. Download the MSI file from Bitfocus.
2. Run the installation.
3. Run Companion.

Linux (Desktop):

1. Download the tar file from Bitfocus.
2. Extract the tar file, ensuring to place the extracted folder in a location you have rights to.
3. To run the server, run the companion-launcher file
4. If you want to run Companion on startup and for other settings, refer to the README file in the extracted folder.

Linux (Headless):

1. Download the tar file from Bitfocus.
2. Extract the tar file, ensuring to place the extracted folder in a location you have rights to.
3. Refer to the README file located within the folder for instructions on configuring for a Headless Server.

Adding Adder modules to Companion

Companion allows you to add custom modules via a development folder. Some Adder Modules are already included, however, a few are still waiting for the next Companion release. In order to use these now, you can add them via the development settings.

1. Download the Module
2. Extract the module to the folder you want to point to.
   • Best practice, the top folder should be "companion-module-dev" with your custom modules located within:
     companion-module-dev/
     ├── companion-module-adder-avm/
     ├── companion-module-adder-infinity-aim/
     └── companio-module-adder-infinity-alif/
3. When starting companion, select the settings cog on the top right. This will allow for selecting a development folder for custom modules.
   
   
    
4. Select your folder, companion will restart and have access to the module.
5. Connect to the GUI and explore the connections to see the current modules.
   
   

Using the AIM Module

Adding and Configuring an AIM Connection

1. On the Connections Tab, select "Adder: AIM"
   
    
   
   
2. The configuration page will pop up:
   • Add the IP Address of the AIM manager
   • Enter the Username and Password you want to use the API with
     ×

      Note

     Currently, if another user is logged in or has established the connection of a receiver, the connection through the API will fail as the API cannot force the channel to be disconnected.
   • Enabling the Poll option allows the module to poll the AIM server regularly to fetch the current status of connections.
   • Setting the Poll interval sets how frequently the module polls the AIM server, this should be set in Milliseconds (ie 5000 would be 5 seconds).
   • Press Save to apply the configuration.

Connecting a Receiver to a Channel

1. Under the Buttons Tab, select the button to be configured and press "Create Button".
    
   
   
   
2. Select the Folder Icon next to Add Press Action.
   
   
   
   
3. A Pop up box will open, select AIM and select the action you want to use.
4. Press the "Learn" button to get a current list of Receivers and Channels the configured user has access to.
   
   
   
   
5. Select the Receiver, Channel, and connection mode (View only, Shared, Exclusive, Private) you want to connect.
   
   
   
   
6. The button is saved automatically when options are selected.

Connecting Presets

1. Like Channels, an existing preset on the AIM can be used to connect on a button press.
2. Select the folder near Add Press Action
3. Select Connect Preset as the action.
   
    
   
   
4. Press the Learn Button to get a list of current AIM presets.
    
   
   
    
5. Select the Preset you want to connect.
6. The Button is saved automatically when an option is selected.

Combining Multiple Actions

• You can add multiple actions to one button by selecting Add Press Action
• This allows for combining multiple actions in a single press. Below are some examples:
  
  
  
  
  
  

Disconnecting Receivers and Presets

1. Both Connecting Channels and Presets come with a corresponding action to disconnect.
2. Disconnecting a Receiver disconnects the current channel.
3. Disconnecting a Preset disconnects all receivers in that preset.

Adding Feedback to Buttons

1. Under the Feedback tab of the button, select the folder icon next to Add Feedback.
2. In the popup menu, select AIM then Channel Connection Status.
   
   
   
   
3. Configure the Background and Text colours if you do not want to use the defaults.
   
   
    
   
4. The Feedback is automatically applied.